开发规范实战(一)代码书写规范

简介: 开发规范实战(一)代码书写规范


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

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

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

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

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

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

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

image.png

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

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

10.实体类需要继承 BaseEntity

image.png


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

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

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

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

image.png

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

16.方法命名规范:

image.png

17.事务书写方式

image.png

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

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

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

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

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

image.png

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

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


相关文章
|
10月前
|
存储 设计模式 人工智能
规范:前端代码开发规范
规范:前端代码开发规范
1068 0
|
19天前
|
前端开发 JavaScript 算法
比较流行的前端代码书写规范都有哪些
【4月更文挑战第13天】前端代码规范增进代码可读性和团队协作,包括缩进(用2空格)、命名(变量 camelCase,常量 MY_CONSTANT,类 PascalCase)、注释、语句与表达式、错误处理、代码复用。文件命名规范涉及扩展名、目录结构、简洁文件名、入口文件和配置文件命名。遵循这些规范能提高代码一致性,但需按项目需求调整。不断学习新规范以适应前端技术发展。
18 1
|
2月前
|
算法 Unix 程序员
【C/C++ 基本知识 注释规范】C/C++中注释方式以及规范
【C/C++ 基本知识 注释规范】C/C++中注释方式以及规范
22 0
|
2月前
|
Java
Java开发规范(简洁明了)
Java开发规范(简洁明了)
|
8月前
|
SQL 监控 Java
【开发规范系列】(三)代码提交规范
【开发规范系列】(三)代码提交规范
|
10月前
|
程序员
代码的规范
代码的规范
114 0
|
10月前
|
算法 IDE 程序员
代码编写规范
代码编写规范
|
10月前
|
开发工具 git
代码统一风格、代码规范和提交规范
1、安装模块 全局安装 eslint、commitlint 、 check-prettier npm install eslint commitlint check-prettier -g 本地安装 npm install eslint-config-prettier  stylelint  stylelint-config-prettier stylelint-config-standard husky  @commitlint/config-conventional -D VSCode 安装 Eslint和Prettier插件
120 0
|
11月前
|
前端开发 JavaScript
前端代码如何规范编写?
前端代码如何规范编写?
93 0
|
11月前
|
数据采集 算法 Shell
【C#编程最佳实践 七】代码书写规范实践
【C#编程最佳实践 七】代码书写规范实践
88 0
【C#编程最佳实践 七】代码书写规范实践