02 代码规范干货

1.命名

类名：大驼峰
方法名、参数名、变量：小驼峰
枚举类、常量名：全部大写、单词间用下划线隔开、力求语义表达清楚、不嫌名字长
【强制】各层命名规约：
A) Controller/Service 层方法命名规约

controller方法名与service方法保持一致
获取单个对象的方法用 getOne做前缀。
获取多个对象的方法用 getList做前缀。
获取分页对象的方法用 getPage做前缀。
获取统计值的方法用 getCount 做前缀。
插入的方法用 insert 做前缀。
批量插入的方法用 insertBatch 做前缀
删除的方法用 delete 做前缀。
批量删除的方法用 deleteBatch做前缀。
修改的方法用 edit 做前缀。
批量修改的方法用 editBatch 做前缀。
其他可自定义
————————————————————————————————————

切忌1：布尔类型变量不要加is，否则框架解析可能引起序列化错误
反例：定义为基本数据类型 Boolean isDeleted 的属性，它的方法也是 isDeleted()，框架在反向解析的时候，“误以为”对应的属性名称是 deleted，导致属性获取不到，进而抛出异常。
切忌2：杜绝完全不规范的缩写，避免望文不知义。
为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词组合来表达其意。
分类1：【强制】不要使用一个常量类维护所有常量，要按常量功能进行归类，分开维护。

2. 空指针异常

【强制】不要使用一个常量类维护所有常量，要按常量功能进行归类，分开维护。所有的相同类型的包装类对象之间值的比较，全部使用 equals 方法比较。

3. 小细节

定义 DO/DTO/VO 等 POJO 类时，不要设定任何属性默认值。
循环体内，字符串的连接方式，使用 StringBuilder 的 append 方法进行扩展。
【强制】不要在 foreach 循环里进行元素的 remove/add 操作。remove 元素请使用 Iterator 方式，如果并发操作，需要对 Iterator 对象加锁。

List<String> list = new ArrayList<>(); 
list.add("1"); 
list.add("2"); 
Iterator<String> iterator = list.iterator(); 
while (iterator.hasNext()) { 
String item = iterator.next(); 
    if (删除元素的条件) { 
        iterator.remove(); 
    } 
}

【推荐】高度注意 Map 类集合 K/V 能不能存储 null 值的情况，如下表格：

4.swagger规范

【强制】如果接口有返回值，response 返回时要指定具体返回的实体类，不可用指定为Map或者RestResponseBody

正例：@ApiOperation(notes = "模块", value = "方法名称", httpMethod = "GET", response = MServiceResourcesVo.class)
返例：@ApiOperation(notes = "模块", value = "方法名称", httpMethod = "GET", response = RestResponseBody.class)

5.注释规范

【强制】
类、类的方法、接口、的注释必须使用Javadoc规范, 至少包含 @author,@date,@version

正例：/**
* @author 作者
*/
返例：// 作者

/** 
 * 方法名称说明
 *
 * @author 作者
 * @date 2020年11月23日 上午7:54:47  编码时间
 * @version 当前迭代的版本
 * @param userName-用户名 入参说明
 * @param userAge-用户年龄 入参说明
 * @description 接口描述
 */

xml注释

<!--      
 作者
 时间
 语句的作用
-->