代码开发指南

发布时间 2023-12-19 10:20:38作者: 梅丹隆

一、排期应该怎么预估?
1、怎么能够穷尽需求范围?
2、怎么能够保证使用接口的准确?
2.1、需求调研阶段
对原有接口梳理
2.2、需求梳理阶段
评估原有接口是否可以复用
评估调研新接口数据是否满足要求
3、如何输出合理排期
合理开发时间*自己buffer系数
二、代码流水线开发
1、参数校验
1.1、controller层参数校验
1.2、biz层是否需要参数校验
1.3、service层返回值校验
1.3.1、service命名
1.3.2、返回值校验
2、异常捕获
2.1、controller层异常捕获
2.2、thriftService层异常捕获
2.2.1、捕获
2.2.2、抛出
2.3、serveice层异常捕获
2.3.1、转化异常
2.4、其他异常
2.4.1、事务手动回滚
3、日志输出
3.1、哪些地方必须要打日志
3.2、哪些地方建议打日志
3.3、多线程日志记录
4、代码注释
4.1、有哪些注释是必须的
4.2、方法注释中都包括什么
目的是什么
获得的结果是什么
相关需求链接
相关枚举/类
4.3、代码注释包括什么
步骤
关键处理
三、代码review的正确姿势

PR应该review什么?

  1. 每周一次增量代码review
  2. review应以java类为单位,完成在“reviewed”打勾
  3. 正式包(开发完成时)
    1. 依赖正式包
    2. 本版本开发正式包
  4. 非本次开发的代码
  5. 外层(或public)的参数校验
  6. 获取第三方服务的返回值校验
  7. 关键日志和打点
  8. 方法注释
  9. sonar代码扫描

如果集中有大量代码,我重点看什么?

  1. 正式包
  2. 非本次开发的代码(携带错误代码)
  3. sonar代码扫描