代码开发规范-常见问题

代码编写规范:

1. controller层对应数据库bean 原子对应

2. 方法执行关键节点要有日志

3. 方法名见名知意 新增 addXXX 编辑 modifyXXX 删除 removeXXX 查询 原子数据 单数据 queryByXAndX 列表 queryListByXAndX 分页查询 pageByXAndX 组合数据 单数据 queryXXByXAndX 列表 queryXXListByXAndX 分页查询 pageXXByXAndX

4. 方法体要求 方法只干单一业务 冗余代码抽离 注释要全面 例: /**

   • 同步刷新缓存数据

   • @title refreshCacheSync

   • @author songqinglong

   • @updateTime 2022/7/1 11:10 AM

   • @throws */

5. 常量 通用常量类 PublicConstant 含业务特定常量 XXConstant

6. 工具类全局统一 构建树 TreeBuildUtil 新增其他 XXXUtil

7. dto命名大写 例子StaffDTO

8. bean里全部用注解@Data 不写set get

9. do转dto统一命名transfer2DTO

10. dto里页面目前用到的字段再复制进来 不要do中所有字段全复制进来

11. 数据库相关 普通索引命名 idx{字段名} 唯一索引命名 unique{字段名} 组合索引命名 idx{字段1}{字段2} unique{字段1}{字段2} 用哪些字段查哪些字段 减少select * update 的时候 按照需要 update 更新哪个字段 set 哪个字段 更新要引入 乐观锁 因为咱们这次 查询语句要 最大限度可以命中索引 （开发时需要测试执行计划） 后台接口需要在开发阶段上简单压测（压测方案待制定） 减少pg次数,能单次查询出来尽量单次查询出结果 sql变更 第一时间进行归档

接口命名:

1. url起始统一 base-data/xx/xx

2. url长度 max < 4 命名规范 批量 新增 base-data/{XX}/add-batch 删除 base-data/{XX}/delete-batch 修改 base-data/{XX}/update-batch 查询 根据内部字段查询 base-data/{XX}/query-batch 根据另一个类查询 base-data/{XX}/{B}-query-batch 单个 新增 base-data/{XX}/add 删除 base-data/{XX}/delete 修改 base-data/{XX}/update 查询 根据内部字段查询 base-data/{XX}/query 根据另一个类查询 base-data/{XX}/{B}-query

日志:

1. 每个方法要有日志

2. 内部日志规范 {方法名} {节点1} {参数} {方法名} {节点2} {参数} {方法名} {节点3} {参数}

3. 对接等关键节点日志级别info 返回值过大但联调使用使用debug 规范:

   1. 汉字

   2. {节点描述} {请求方式} {参数} {url} {返回值} 例如: 请求三方鉴权接口 [GET] [username=张三] [http://127.0.0.1:8080/login] [{code:200}]

4. 日志等级 info 关键节点 warn 手动控制的非想要结果日志 debug error 系统异常 业务异常 其他 待确定 返回值