1.入参必须使用对象或者List<VO>,非特殊情况下不允许使用jsonobject

2.service与dao层也尽量使用对象封装 减少参数罗列

3.参数传递非必要情况不要使用map传递

4.出参使用封装好的Result对象

5.接口文档书写需要详细 

6.在使用系统统一异常处理时 不需要使用try catch

7.在特别需要时 需要向统一异常处理方法维护异常类别

开发规范实战(一)代码书写规范_代码生成器

8.需要加入类注释与方法注释 详细请参考新人项目搭建文档

9.非特殊情况方式不允许使用@requstmapping

10.实体类需要继承 BaseEntity

开发规范实战(一)代码书写规范_字段_02


11.尽量将同一业务的接口写到一个类中 通用方法抽取出来 并提交给组长 维护到文档中

12.服务间调用请参考​​ribbon与feign​

13.使用格式化文档对代码格式化

14.类上与接口路径都需要书写 且不要省略“/”

开发规范实战(一)代码书写规范_代码生成器_03

15.类命名规范 分别为xxController,xxService,xxServiceImpl,xxDao,xxMapper

16.方法命名规范:

开发规范实战(一)代码书写规范_封装_04

17.事务书写方式

开发规范实战(一)代码书写规范_封装_05

18.失效代码尽量删除掉 而不是注释

19.是否等可复用魔法值需要放入枚举类中 不要在代码中写死

20.实体类需要写明各字段注释 可使用代码生成器生成 

21.实体中除了设计到计算字段 其他一律使用封装类类型

22.接口类型不需要public等关键字

开发规范实战(一)代码书写规范_代码生成器_06

23.mapper中需要写全jdbcType 可以使用代码生成器生成

其他详细可以参考 ​阿里巴巴Java开发手册(华山版).pdf