Java 代码开发规范

本文简要说明了 Java 开发代码相关的强制性规范，各研发人员必须遵守以下规范：

1. 【强制】代码中使用 lombok  插件
2. 【强制】所有Controller 和 Service 层的类、函数、接口、参数都要有注释 
3. 【强制】所有 Controller  层的接口只做装箱和拆箱及参数传递，不处理任何业务逻辑
4. 【强制】复杂函数内要做简单的 TODO 说明
5. 【强制】函数和参数的命名要按实际含义的英文定义，并以驼峰法命名
6. 【强制】函数嵌套层次不超过3
7. 【强制】函数参数尽量不超过4个（否则使用VO对象传递）
8. 【强制】函数参数顺序应一致
9. 【强制】禁止使用魔法数
10. 【强制】禁止使用三元表达式
11. 【强制】禁止代码重复超过8行 
12. 【强制】所有 Controller 暴露的API必须有对应的单元测试用例和对应的Swagger注释
13. 【强制】所有查询功能的方法名必须以 query 开头、添加功能的方法名必须以 add 开头、修改功能的方法名必须以 update 开头、删除功能的方法名必须以 delete 开头。
14. 【强制】所有API接口返回值采用 Response<T> 对象，分页数据对象采用 Response<PageResponse<T>> 对象
15. 【强制】分页参数统一采用 page=1&size=10 
16. 【强制】排序规则统一采用 sort=s1_desc;s2_asc 
17. 【强制】超过17位的长整型数据必须转成字符串返回

 

以上开发规范原则上必须遵守，如有特殊情况无法满足规范，需提起申请由研发主要负责人评审通过后或修改规范或特例通过。