代码评审常见问题总结【持续更新】

被刻印的时光 ゝ 提交于 2020-03-15 12:54:13

1:如果调用的方法返回值是基本数据类型,接收返回值的变量如果不是必须用包装类,请不要使用包装类进行接收,同理:在一个方法内return基本数据类型,方法返回值不要写包装类。

 

2:方法的参数列表中,如果包含可以为空的入参,请将该参数往后放,把主要的参数放在前面。

 

3:方法入参进行不要用id、code、name等过于简单的描述,应该用patientId,centerUserId,patientCode等,如果用前者必须写注释

 

4:一个方法内get()获取一个属性时,重复2次以上一律提成一个变量  ,不要在多处重复调用get方法

 

5:DTO或者VO只用于数据传输,不要作为入参进入方法内,以这个方法为例, 方法内使用了仅recordDTO的recordId和recordParamList,该方法的参数列表就应该只有这(recordId,recordParamList),这里的思想是:入参是函数体的目录,需要让人一眼就能看到包含什么,除非必要情况,尽量不要传对象,特别的大对象

 

6:进行修改操作的接口一定要先校验合法性,看该记录可不可以被修改,甚至修改人有没有修改记录的资格(token只能保证用户本身是合法的,不能保证他的行为)

 

7:引入第三方类库时不要引入不用版本的相同内容,要在import中修改统一的版本,尽量不要在代码段落中书写完整的路径

 

8:循环超过2层时考虑重构、 分支判断层数过多时请考虑使用卫语句或其他方法重构。

 

9:没有必要的时候,尽量不要写大功能的公用方法。

 

 

标签
易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!