"代码开发规范旨在提升代码质量,降低维护难度,提高开发效率。文档涵盖了大小写规范、常量定义、变量定义、注释书写、异常处理和日志输出等多个方面,提供了详细的指导原则和示例。"
1. **大小写规范**:
- 类名遵循首字母大写的驼峰规则,如`FirstName`、`LastName`。
- 包名全小写,不使用驼峰规则。
- 常量全部大写,单词间用下划线分隔,如`ACCOUNT_TYPE_FREEZE`。
- 数据库表名和字段名全大写,使用下划线分隔。
2. **常量定义**:
- 避免在方法内部定义字符串常量,推荐在类中以静态常量形式定义。
- 实体相关的常量应在对应的TO(Transfer Object)中定义,便于管理和分类。
- 常量命名遵循特定格式,如`ACCOUNT_TYPE_FREEZE`表示“帐户类型:冻结”。
3. **变量定义**:
- 变量名首字母小写,采用驼峰规则,如`firstName`。
- 变量默认声明为`private`,避免`public`或`protected`。
4. **注释书写**:
- 注释需用中文书写。
- 类、方法、域前均应添加注释,格式如`/** 注释内容 */`。
- 每10行代码分为一段,每段前写注释说明代码功能,段与段间留空行。
5. **异常处理**:
- 每个业务类只抛出业务异常,底层异常需封装到系统异常中。
- 错误码定义在业务代码表中,业务异常以包含错误码和参数的形式抛出。
- 底层异常不应被屏蔽,以免难以追踪问题。
6. **日志输出**:
- 只有异常不再往外抛时,才打印异常堆栈信息。
- 日志级别应严格控制:
- `FATAL`:系统性异常,如数据库、网络或参数异常,需要在最外层打印。
- `ERROR`:业务异常,系统可继续执行,如密码错误、余额不足等。
- `WARN`:警告级别,如数据库连接过多、安全范围内差错账等。
通过这些规范,可以提高代码可读性,便于团队协作,同时降低后期维护的复杂性,提升软件系统的稳定性和可靠性。开发者应严格按照这些规范进行编码,以实现高效、高质量的代码开发。