超级文档
编码规范摘录
登录
免费注册 / 登录

编码规范摘录

维护人:刘洋
适用范围:行政协同平台服务端
语言:Java 17
日期:0000-00-00
状态:主干按本摘录执行

一、摘录目的

本文只摘行政协同平台服务端每天会碰到的约定,不是完整的语言手册。仓库用 Java 17。新代码在合并前由评审人按下面四条看一眼。9月的热修和预占分支都按此执行。张伟是例外情况的批准人,例外要写在合并说明里。

二、命名与包

请假提交的类放在 leave 包,不放到 common。路径名词与数据字典里的表名对应,评审时刘洋会对照。配置键与功能开关说明用同一套拼写。

三、日志与错误

  1. info 日志带 time、level、traceId、empId、action、bizId。事由正文不写入。
  2. 手机号只留后 4 位。密钥和令牌全文不出现在日志里。
  3. 业务失败返回约定的结果码,例如日期格式是 40012,越权是 40003。
  4. 异常只在 error 打堆栈,堆栈去掉个人目录。

四、测试要求

新增写接口至少有一条成功和一条重复提交。库存会变成 0 或 1 的逻辑要有一条边界用例。王芳的每晚任务目前 246 条,新用例用模块前缀,避免和手工编号 TC 混淆。9月27日缺少「库存为 1」的自动化,导致集中试用才发现两笔预占,这条从 9月28日起列为合并前必有。刘洋在评审里看到没有边界用例时,不合入主干。9月27日集中试用后,他把「库存为 1」补进合并清单的第 1 条。评审人张伟在 9月28日会先看有没有这条用例,再看条件更新本身。没有这条用例的提交,即使编译和单测通过,也不合入主干。