文档标记说明
- 是 :必须按照要求
- 否:建议
- 无标记默认建议
1、 基础规范
- 是|方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格。如:localValue / getHttpMessage() / inputUserId。
- 是|常量命名全部大写,单词间用下划线隔开。
- 是|枚举类名带上 Enum 后缀,枚举成员名称需要全大写,单词间用下划线隔开。
- 是|实体类的布尔类型不要以is开头,有时候会序列化和反序列化错误。
- 是|入参使用Integer。因为int默认值为0,可能会产生异常情况。
- 是|类名使用驼峰风格,以下情况例外:DAO,DTO,VO等。如TestNameService,UserDAO。
- 是|代码使用utf-8编码。
- 是|过时的接口、方法,如果能确保无调用者应立即删除,否则使用@Deprecated 注解,并清晰说明新接口、新方法
- 是|不要使用过时方法、接口
- 是|序列化类新增属性时,请不要修改 serialVersionUID 字段,避免反序列失败;如果完全不兼容升级,避免反序列化混乱,那么请修改 serialVersionUID 值。(serialVersionUID 不一致会抛出序列化运行时异常)
- 是|异常必须被处理,而不能被捕获却什么都不处理,如果实在不想处理,请抛给上层