编写 Java 好习惯
约 587 字
- 类、类属性、类方法的注释必须使用 /** xx */ 注解格式(不得使用// xx方式,不符合 JavaDoc 注释规范)
- 在 if / for / while 等语句块中,即使只有一行代码也必须使用花括号
- 所有判断布尔值的数字,必须使用 0 表示 false、1 表示 true
- 注释与内容之间必须间隔一个空格(注释标准写法: // comment)
- 项目名用全小写,多个单词用 - 来分割 (common-project)
- 包名必须使用单数形式的单个小写单词(例如工具类包名用 util,而不是 commonUtils)
- 类名必须用大号驼峰命名法、方法名必须用小号驼峰命名法
- equals()方法必须使用有确定值的对象来调用(防止 NPE 异常)
- 常量必须写在 class 中,禁止写在 interface 中
- 实体类的类型必须使用包装类型且实现序列化
- 每行代码长度不超过121个,右侧代码线截止,超出必须换行(增加可读性),下述为可能遇到的情况:
- 方法调用的点符号与下文一起换行
- 运算符与下文一起换行
- 在多个参数超长,逗号后进行换行
- Redis Key 以业务名为前缀用:分隔,业务模块名:业务逻辑:业务键名,比如 test:user:access
- Redis Key 以英文字母开头,命名中只能出现小写字母、数字、英文点号、英文半角冒号
- Mapper 层接口加上 @Resposity 注解(强烈推荐!防止编译前的识别报错)
- Service 层接口开头不建议加I(推荐:UserService 不推荐:IUserService)
- @Autowired 的变量命名,建议使用类名的小号驼峰命名法(格式:UserMapper userMapper)
- 注解 SQL 语句中不建议含有 \n \t 等转义符
- VO、DO 等类字母建议用全大写
- 获取单个对应的方法用 get 前缀
- 获取多个对象的方法用 list 前缀
- 获取统计值的方法用 count 前缀
- 插⼊方法用 save / insert 前缀
- 删除方法用 remove / delete 前缀
- 修改方法用 update 前缀