1、基础代码规范：
参考阿里巴巴代码规范与Sonarlint复杂度分析，请自行在IDEA中添加相应插件进行初步代码审核。
若有与公司规范冲突的，以公司规定为准。1.1 注释规范：
注意！任何位置(属性字段周围和方法中)与文件(java\yml\sql\properties)都不可添加行尾注释。
1.1.1 注释头参考模板：（中文替换成相应的文字即可）
一、文件注释模板
修改位置为：File > Settings > Editor > File and Code Templates /** * Description: ${description} * * @author 你的名字 * @since ${YEAR}-${MONTH}-${DAY} * · Email: 你的邮箱@QQ.COM * ·© Copyright 凌动科技 Corporation * · All Rights Reserved. */二、方法注释模板-参考文档
修改位置为：File > Settings > Editor > Live Templates /** * Description: $description$ * * @author 你的名字 * @since $date$ $time$ $param$ $return$ */ 参数获取： groovyScript(" if(\"${_1}\".length() == 2) { return ''; } else { def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) { result+='\\n' + ' * @param ' + params[i] }; return result; } ", methodParameters()); 返回值获取： groovyScript(" def returnType = \"${_1}\"; def result = '\\n * @return ' + returnType; if(returnType == \"void\") { return ''; }; return result; ", methodReturnType());1.1.2 字段注释使用/**注释，例如：
示例 规范 /**
* 用户名
*/✔ // 用户名 ✘
1.2 代码规范：
代码思维尽量向领域驱动模式靠近。多使用设计模式优化代码结构，如:构建者(Builder)模式
基本模块划分： |-enums 枚举属性值，一般为业务控制常量存储。 |-vo (Value Object)值对象。主要体现在视图的对象，对于一个WEB页面将整个页面的属性封装成一个对象。然后用一个VO对象在控制层与视图层进行传输交换。 |-bo (Business Object)业务对象，将业务逻辑封装成一个对象。可以理解为 PO 的组合 |-po (Persistant Object)持久对象。一个POJO持久化以后就是PO。 |-dto (Data Transfer Object)数据传输对象。经过处理后的PO，可能增加或者减少PO的属性。 |-dao 数据层 |-manager 为复杂业务，与Dao，Feign，第三方接口配合 |-service 接口层
命名的基本原则
(1) 标识符的命名要清晰、明了，有明确含义，同时使用完整的单词或大家基本可以理解的缩写， 避免使人产生误解——尽量采用采用英文单词或全部中文全拼表示，若出现英文单词和中文混合定义时，使用连字符“_”将英文与中文割开。 较短的单词可通过去掉“元音”形成缩写；较长的单词可取单词的头几个字母形成缩写；一些单词有大家公认的缩写。 例如：temp->tmp、flag->标志寄存器、statistic->stat、increment->inc、message->msg等缩写能够被大家基本认可。 (2) 命名中若使用特殊约定或缩写，则要有注释说明。应该在源文件的开始之处，对文件中所使用的缩写或约定，特别是特殊的缩写，进行必要的注释说明。 (3) 自己特有的命名风格，要自始至终保持一致，不可来回变化。个人的命名风格，在符合所在项目组或产品组的命名规则的前提下，才可使用。 (即命名规则中没有规定到的地方才可有个人命名风格)。 (4) 对于变量命名，禁止取单个字符(如i 、j 、k… )，建议除了要有具体含义外，还能表明其变量类型、数据类型等，但i 、j 、k 作局部循环变量是允许的。 变量，尤其是局部变量，如果用单个字符表示，很容易敲错(如i写成j)，而编译时又检查不出来，有可能为了这个小小的错误而花费大量的查错时间。 (5) 除非必要，不要用数字或较奇怪的字符来定义标识符。 (6) 命名规范必须与所使用的系统风格保持一致，并在同一项目中统一。 (7) 在同一软件产品内，应规划好接口部分标识符(变量、结构、函数及常量)的命名，防止编译、链接时产生冲突。 对接口部分的标识符应该有更严格限制，防止冲突。如可规定接口部分的变量与常量之前加上“模块”标识等。 (8) 用正确的反义词组命名具有互斥意义的变量或相反作的函数等。 (9) 所有命名必须遵循单词词组规范。例如：username为一个单词，最好不要使用userName这类样式。
下面是一些在软件中常用的反义词组。
add / remove begin / end create / destroy insert / delete first / last get / release increment / decrement put / get up / down add / delete lock / unlock open / close min / max old / new start / stop next / previous source / target show / hide send / receive source / destination cut / paste 示例： intminSum; intmaxSum; intaddUser; intdeleteUser;
规范要求
一、 Java类： 1. 注入方式统一使用构造器注入。 2. 大类尽量按模型以及功能拆分。(类中超过二十个子方法或超过800行以上) 例如：SchoolAddService, SchoolDeleteService \ ClassAddService,ClassDeleteService等。 3. 提交代码时及时去除无用类，以及类中的无用引用，无用方法。 4. 类中格式化代码时，统一使用IDEA默认格式化方法。 5. 实现序列化接口的类统一使用IDEA自动生成序列化字段。设置位置为： File > Settings > Editor > Inspections > (JVM languages/Java) > Serializable class without 'serialVersionUID' 6. ctrl层中类上的Mapping需要确定请求前置连接可出现多次'/'且最后不可为'/'，方法上的Mapping只可出现一次'/'，并且符合驼峰命名。 例如：类上注解为 @RequestMapping(value = "/service/test") 方法上的注解统一使用已区分的 @PostMapping(value = "/list") 或 @GetMapping(value = "/getById") 7. 类名中如有LED，IOS等专有名称，最好使用下划线加大驼峰命名方式。例如：IOS_DeviceReportBo 二、 Java方法： 1. 方法中代码行数不得超过80行，方法名称与注释简洁明了。 2. 方法参数五个及以上使用对应实体类类型接收，方法参数需要在注释中写明作用。 3. 方法中需要添加日志的遵循 log.XXX(类名::方法名::说明 [-> param = {}] ) 格式。 (注：中括号中为可选) 4. 方法中尽可能逻辑简单，如有复杂逻辑，将逻辑拆分为简单逻辑后重新在新方法中组合。 5. Lambde表达式中只应有简单的处理逻辑，不可进行嵌套。 6. 链式编程最好不要超过5次以上，并且所有链式方法遵循最简原则，只调用， 少处理且不显示处理复杂逻辑，如有复杂逻辑则封装方法后再进行调用。 三、 其他： 1. 所有自定义属性必须在YML文件中定义，如无法使用，再在相应的配置文件类型中修改。 2. 自定义变量如跟其他平台无关，则统一放在YML文件中xxxCollection字段下。 YML中的变量名称规范为（驼峰）格式，例如：serialVersionId。 YML中的变量值若有单词则规范为驼峰命名格式，例如：serialVersionId。 YML中的变量值不管事单词还是数字都不需要加引号。 整体参考: xxxCollection: serialVersionId: 1
2、数据库规范：
2.1数据库建表为下划线小写命名方式，遵循单词词组规范。
例如：id, username, sequence_id等。
示例 规范 username ✔ user_name ✘ 2.2除中间表以外的新建数据表必须包含以下五个字段：
created_id varchar(32) default '-1' null comment '创建人 创建人ID', created_time timestamp default CURRENT_TIMESTAMP null comment '创建时间;创建时间', updated_id varchar(32) default '-1' null comment '更新人;最后更新人ID', updated_time timestamp default CURRENT_TIMESTAMP null comment '更新时间 最后更新时间', is_deleted tinyint default 0 not null comment '是否删除 是否删除0否;1是'
