系统整容纪:揭秘Java编程之美:掌握这些编码规范,让你的代码一跃成为行业典范
💡
原文中文,约25000字,阅读约需60分钟。
📝
内容提要
本文强调了代码规范的重要性和常见规范要求,如条件判断、Mybatis分页查询、线程池创建、定时任务处理和ThreadLocal回收。遵循规范可提高代码可读性、可维护性和稳定性,减少错误和混淆。
🎯
关键要点
- 代码规范的重要性和常见规范要求
- 编码规范是通往代码优雅之路的基础
- 基础知识的重要性,优秀代码库的积累需要时间
- 命名规范:类名使用UpperCamelCase,抽象类命名使用Abstract或Base开头
- 异常类命名使用Exception结尾,单元测试类命名以被测试类名称开始,以Test结尾
- 方法名、参数名、成员变量使用lowerCamelCase,常量命名使用全大写
- 禁止使用下划线或美元符号作为命名的开始或结束
- Service和DAO类应使用接口,内部实现类用Impl后缀区分
- 包名使用小写,点分隔符之间有且仅有一个自然语义的英语单词
- POJO类中的布尔类型变量不加is前缀,类型与中括号紧挨相连表示数组
- 禁止在POJO类中同时存在对应属性的isXxx()和getXxx()方法
- 所有字段和方法必须用javadoc注释,枚举类型字段必须有注释
- 方法内部单行注释在被注释语句上方,使用//注释
- 禁止使用构造方法BigDecimal(double)来创建BigDecimal对象
- 避免使用取反逻辑运算符,'!'运算符不利于快速理解
- Mybatis的queryForList不推荐使用,建议使用分页插件
- 线程池不允许使用Executors创建,使用ThreadPoolExecutor
- 多线程定时任务使用ScheduledExecutorService而非Timer
- 必须回收自定义的ThreadLocal变量以防止内存泄露
➡️