简介:项⽬编码规范介绍和POJO实体类约定
注意
任何框架,不要使⽤过多的侵⼊或者框架定制化深的内容,防⽌后续改动耦合性⾼,成本⼤
N⽅库说明
⼀⽅库: 本⼯程内部⼦项⽬模块依赖的库(jar 包)。
⼆⽅库: 公司内部发布到*仓库,可供公司内部其它应⽤依赖的库(jar包)。
三⽅库: 公司之外的开源库(jar 包)。
POJO实体类
POJO(Plain Ordinary Java Object): 在⼿册中,POJO专指只有 setter / getter / toString的简单类,包括DO/DTO/BO/VO等, 禁⽌命名成xxxPOJO
各个层级约束规范
A) Service/DAO层⽅法命名规约
- 获取单个对象的⽅法⽤get做前缀。
- 获取多个对象的⽅法⽤list做前缀,复数形式结尾如:listObjects。
- 获取统计值的⽅法⽤count做前缀。
- 插⼊的⽅法⽤save/insert做前缀。
- 删除的⽅法⽤remove/delete做前缀。
- 修改的⽅法⽤update做前缀。
B) 领域模型命名规约 - 数据对象:xxxDO,xxx即为数据表名。
- ⼀般数据传输对象:xxxDTO,xxx为业务领域相关的名
称,项⽬⾥⾯也⽤VO。 - 展示对象:xxxVO,也就是响应给前端的实体包装类。
- 接收前端json对象请求的命名为 XXXRequest
更多开发规范,可以参考阿⾥巴巴编码⼿册(需要的同学可以加我私发,QQ:2101531489)