接口开发注意事项-个人总结

一.接口入参校验

对于所提供的服务接口（Dubbo服务、JSF服务、REST服务），接口入参必须要进行校验。

校验服务类建议命名为：InterfaceParametersCheckService

校验方法：ResponseDTO check[+接口名](RequestDTO requestDTO)

1.检查字段是否为空。

2.检查字段是否是数字、小数。

3.检查字段的有效性。

4.检查字段的值域。

二.接口处理逻辑说明

1.对于api接口，开发了那么多接口，不可能记得每一个接口的业务逻辑，所以对于处理逻辑要进行详细的备注。

 

三.接口参数设计

1.对于接口的参数，力求精简，杜绝多余参数。

 

三.接口实现

1.日志中必须打印接口处理耗时，单位毫秒。

四.内部逻辑方法

对于内部重要的逻辑方法，或者大量操作数据库的方法，加上异常抛出，以免某个方法内部错误影响整个系统运行。

 

转载于:https://www.cnblogs.com/baokang/p/6427377.html