项目命名规范.md · 抽烟喝酒写bug/bugboys-docs

### 一.模型篇
##### 请求入参

- 所有Controller入参,一律使用 DTO结尾进行交互
- 所有 DTO 命名,前面采用驼峰命名,后面DTO大写
- 所有DTO内参数,如果是一组,请用List<类型>进行接口,尽量不用分隔符隔开,然后字符串接收,
- 所有DTO放置在子模块Model下,根据业务进行分组,例如：
```
com.bugboys.shop.goods.dto
```

##### 请求出参

- 所有Controller出参,一律使用Result进行包装返回
- 所有Controller出参,Result泛型包装对象,一律用VO结尾进行命名
- 所有 VO 命名,前面采用驼峰命名,后面VO大写
- 所有VO放置在子模块Model下,根据业务进行分组,例如
```
com.bugboys.shop.goods.vo 
```

##### 数据库交互对象

- 跟数据库打交道的对象,一律使用PO进行结尾
- 跟数据库交互的对象,全部通过逆向生成工具进行生成
- 所有PO对象,放置在子模块dao下
- 所有映射生成的xml文件,在子模块dao的resources/mapper下

##### 1.分层领域模型规约：

- DO（ Data Object）：与数据库表结构一一对应，通过DAO层向上传输数据源对象。
- DTO（ Data Transfer Object）：数据传输对象，Service或Manager向外传输的对象。
- BO（ Business Object）：业务对象。 由Service层输出的封装业务逻辑的对象。
- AO（ Application Object）：应用对象。 在Web层与Service层之间抽象的复用对象模型，极为贴近展示层，复用度不高。
- VO（ View Object）：显示层对象，通常是Web向模板渲染引擎层传输的对象。
- POJO（ Plain Ordinary Java Object）：在本手册中，POJO专指只有setter/getter/toString的简单类，包括DO/DTO/BO/VO等。
- Query：数据查询对象，各层接收上层的查询请求。 注意超过2个参数的查询封装，禁止使用Map类来传输。

##### 2.领域模型命名规约：

- 数据对象：xxxDO，xxx即为数据表名。
- 数据传输对象：xxxDTO，xxx为业务领域相关的名称。
- 展示对象：xxxVO，xxx一般为网页名称。
- POJO是DO/DTO/BO/VO的统称，禁止命名成xxxPOJO。

https://blog.csdn.net/programmeryu/article/details/81333607

https://www.cnblogs.com/wangxiayun/p/10739243.html
https://www.cnblogs.com/wangxiayun/p/10740046.html

二.命名篇

关于枚举的使用

在服务接口的定义中，参数可以使用枚举值，在返回值的DTO中禁止使用枚举值。

类命名

Controller必须根据业务进行命名,驼峰,Controller结尾

Service必须根据业务进行命名,驼峰,Service结尾

implement必须根据业务进行命名,驼峰,业务+service+impl结尾

辅助类的命名,根据功能进行命名,如果是工具类,请使用final修饰,并且以utils或者util进行结尾

函数命名

函数命名使用驼峰命名

辅助函数,例如构建对象,请用build开头,表示只用于构建对象,并且返回

辅助函数,请使用 private修饰

DAO层函数命名

查询单个尽量使用queryXX或者selectXX命名

查询多个尽量使用queryXXs或者selectXXs复数形式进行命名

更新单个尽量使用modifyXX或者updateXX命名

更新多个尽量使用modifyXXs或者updateXX复数形式进行命名

插入单个尽量使用insert或者add命名

插入多个尽量使用insertXXs或者addXXs命名

DAO所有传参如果是单个参数,请使用@param注解进行注明

所有XXMapper.xml获取参数,请使用@param("XX") 命名, #{XX}获取,${XX}会有SQL注入的风险,具体细节请参考Mysql手册`跟'的区别

变量命名

使用驼峰

状态类的变量,请使用int类型

boolean类型的变量,请使用has开头,请勿使用is开头,在某些序列化框架下,可能会导致反序列化失败

枚举/常量命名

枚举类型使用全大写,_进行分割

枚举命名请使用业务+Enum进行命名

接口常量命名请使用业务+Constant进行命名(尽量使用枚举来定义常量)

抽烟喝酒写bug/bugboys-docs

简介

发行版

贡献者

近期动态

抽烟喝酒写bug/bugboys-docs .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

抽烟喝酒写bug/bugboys-docs