编写接口时的coding思路


前言

相信每位程序员都有自己的编码习惯,我也不例外,今天就是随笔畅谈下我平时写代码的习惯
(不喜勿喷—哈哈)


提示:以下是本篇文章正文内容,下面案例可供参考

自己平时的编写习惯

这里主要按照写一个method的思路进行展开

1.创建一个常量值,接受方法名

例子:String methodName = “getTheOrderDetailByOrderId”;

2.日志打印入参信息

例子:Logger.info(Order.class,methodName,inputParams,“查询订单详情,入参:”)

3.创建接收返回值的参数

例子:Map<String ,String> result = new HashMap();

4.直接写上方法的返回值

例子:return result;

5.进行入参的常规校验

例子:StringUtils的isEmpty,isNotBlank

6.进行入参的业务上的定制化校验

例子:各个网站的密码的设置规则不一致

7.try catch,包裹住业务代码

这种是懒人写法,很影响性能,但是很简单,不过不推荐这样写

8.根据业务需求处理对应的异常

catch住自己处理,还是往上层抛,看业务需求

9.日志打印出参信息

例子:Logger.info(Order.class,methodName,inputParams,“查询订单详情,出参:”)

总结

请记住,读代码的时间比写代码的时间多得多。多花时间理清思路,往往更能节省开发时间,注释、细致的解释以及一些示例往往具有不可估量的价值。

我是杰叔叔,一名沪漂的码农,下期再会!

编写接口时的coding思路