数据库规范
除公共字段和主键外,数据库表中的其他字段必须添加注释;对于表示多种状态的字段,需在注释中完整列明各状态含义。
表示多种状态的字段,不允许使用 0、1、2 等数字直接表示状态,必须使用具有明确语义的英文单词;逻辑删除类字段除外,但字段名必须以
is_开头(如is_delete),且需能清晰表达 0、1 的含义。在分布式系统或数据量较大的服务中,表必须合理添加索引;索引命名规范为:
i_+ 表名 +_+ 字段名。
代码规范
1. JAVA 代码:
调用第三方或他人提供的接口时,凡存在出错风险的场景必须进行异常捕获,确保自身程序的稳定性;对于 HTTP 请求、返回数据处理等封装方法,必须显式抛出异常。
对于复杂业务逻辑,应在代码开头通过注释先列出整体处理步骤,按“一、二、三”的形式清晰说明。
使用
foreach循环时,仍需对相关变量进行判空处理。每次设计接口时,需充分考虑接口对外提供的通用性,不得仅针对当前使用场景进行设计。
在
service层中,查询集合的方法以list开头,查询单条数据的方法以get开头;在mapper层中,查询方法统一以select开头。实体类字段若需使用枚举,应在对应字段下定义枚举类型;若为通用枚举,应放置在公共包中统一维护。在程序中必须使用枚举类型表示,并在实体类中引用枚举;禁止直接使用字符串,更不允许使用
static final常量。(数据库规范中的第2点)日志必须分级使用(
info、warn、error),禁止使用System.out.println;异常日志需包含必要的上下文信息。service层方法应保持职责单一,避免出现一个方法承担多个业务流程的情况。