被吐槽代码风格
前几天被同事吐槽代码风格差,说的还是相对比较婉转的,但是当事人十分尴尬。
总结一下Code Review
时的问题,有的是我的,有的是别人的。有则改之,无则加勉。
- 判断不完整:判断逻辑没有
else
导致部分情况没有处理。 - 代码中经常出现类似
"1"
这种常量:需要定义常量然后再去使用常量提高代码可读性。 - 一个工具类实现了两遍:即创造新函数/类时,先看看是否既有方法已经实现过。
- 开发时尽可能多打日志。
- 命名规范问题:就算是临时变量也需要规范命名,禁止出现
tmp
、tmp1
之类的变量。 - 代码注释:写不了好的代码就多写注释。
- 日志打印级别:不要都打
info
….。 - 善用枚举:提高代码可读性,规范性。
- 尽量避免循环调用
SQL
/接口:SQL
多用IN
等,接口尽量规避这个问题。循环调用会十分影响性能,因为你不知道会循环多少遍。 - 避免方法过长:考虑做拆分,优化逻辑,也为了更好的单元测试。
- 空值检查:对于一个不确定来源的值,一定要做空值判断。值判断这部分最好在Controller中统一去做(注解很全面也很方便)。
- 重要/核心逻辑一定要有单元测试。先设计测试再写逻辑。
- 不要写双重否定的逻辑:
!isNotBlank(param)
。 - 方法命名规范:英文不好去找翻译…不要怕名字长,就怕意思不对。
- 配置禁止写死在代码中:拿到配置去。
- 定义数字类常量推荐:
ONE_DAY = 24 * 60 * 60
,而不是ONE_DAY = 86400
这种。 - 避免维护是直接修改原来方法的逻辑:尽量用静态代理的方式去写新逻辑。
- 代码顺序的问题:尽量写块状代码,逻辑分散会非常影响可读性。
- 不要用
System.out.println()
和这种类似的东西。 - 不要过于追求好看/简洁:写一行长长的不如把它分解成多行易懂的。
- 提交前删除掉注释的代码。
这几天总在意代码风格的问题,之前都不甚在意,只觉得按期能上就行。现在看之前自己写的东西,吐槽都不知道从哪开始。