先说结论:编码规范真的很重要!!!重要的事情说三遍
从业14年来写过无数的代码也见过很多人写的代码.真是世间万物,千奇百怪啊.
当你接手一个项目的时候,如果项目资料不全的话,好的编码规范会让你快速理解并上手.差的编码规范真的是难以直视啊.下面总结下自己日常中使用的编码规范.抛砖引玉.
-
类、变量、方法名的命名
命名的最高境界就是见名知义，在此列举源码中的一些命名，如 ReentrantLock
方法命名： nonfairTryAcquire()、compareAndSetState()、getExclusiveOwnerThread()、tryAcquire()
变量命名： Thread exclusiveOwnerThread;
类的命名：LinkedBlockingDeque ConcurrentHashMap RejectedExecutionHandler
好的命名不加注释也能理解类的意思、方法的作用、变量的作用。这就是命名规范的意义。
- 注释的作用
1. 复杂的业务逻辑方法一定要加注释进行说明
2. 对外提供的接口变量如果是枚举的一定要加枚举的列表说明
- 避免大方法
1. 某个方法如果超过30-40行（具体情况具体分析），就要考虑是不是要拆分，方法要实现单一性原则，一个方法只干一件事情
- 避免长事务
1. 避免在for循环中执行服务间调用
2. 避免在for循环中执行sql操作
3. 避免在@Transaction事务方法中执行耗时操作
