编码规范有七个维度：编程规约 异常日志 单元测试 安全规约 mysql数据库 工程结构 设计规约
一、编程规约
（一）命名风格
强制
1.命名不能以下划线或美元符号开始，也不能以其结束。
2.严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式 除国际通用的名称
3.类名使用UpperCamelCase风格， DO VO BO DTO AO PO UID例外
4.方法名.参数名.成员变量.局部变量都统一使用lowerCamelCase风格，必须遵从驼峰形式
5.常量名全部大写，单词间用下划线隔开，语义完整
6.抽象类命名使用Abstract或Base开头，异常类命名使用Exception结尾。测试类命名以它要测试的
类的名称开始，以TEST结尾。
7.类型与中括号紧挨相连来表示数组。
8.POJO类中布尔类型的变量，都不要加is前缀，否则部分框架解析会引起序列化错误。
9.包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，除非有复数含义。
10.杜绝完全不规范的缩写，避免望文不知义。
11.为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词组合来表达其意。
12.如果模块、接口、类、方法使用了设计模式，在命名时需提现出具体模式。
13.接口类中的方法和属性不要添加任何修饰符号，public也不要加，保持代码的简介性，并加上有效的
Javadoc注释。尽量不要在接口里定义变量。如果一定要定义变量，肯定是与接口方法相关，并且是整个
应用的基础常量。
14.接口和实现类的命名有两套规则：
1）强制 对于Service和DAO类，基于SOA的理念，暴露出来的服务一定是接口，内部的实现类用Impl
的后缀与接口区别。
2）推荐 如果是形容能力的接口名称，取对应的形容词为接口名 -able
15.枚举类名建议带上Enum后缀，枚举成员名称需要全大写，单词间用下划线隔开。
枚举其实就是特殊的类，域成员均为常量，且构造方法被默认强制是私有
16. 各层命名规约：
A）Service/DAO层方法命名规约
1：获取单个对象的方法用get做前缀
2：获取多个对象的方法用list做前缀，复数形式结尾如：listObjcets。
3：获取统计值的方法用count做前缀。
4：插入的方法用save/insert作前缀。
5：删除的方法用remove/delete作前缀。
6：修改的方法用update做前缀。
B) 领域模型命名规约：
1：数据对象：xxxDO，xxx即为数据表名
2：数据传输对象：xxxDTO，xxx即为业务领域相关的的名称。
3：展示对象：xxxVO，xxx一般为网页名称。
4：POJO是DO/DTO/BO/VO的统称，禁止命名成xxxPOJO。
（二）常量定义
强制
1.不允许任何魔法值（即未经预先定义的常量）直接出现在代码中。
2.在long或者Long赋值时，数值后使用大写的L，不能是小写的l，小写容易误解为1。
3.【推荐】不要使用一个常量类维护所有常量，要按常量功能进行归类，分开维护。eg缓存相关常量放在类CacheConsts下；
系统配置相关常量放在类ConfigConsts下。
4.【推荐】常量的复用层次有五层：
跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。
1）跨应用共享常量：放置在二方库中，通常是client.jar中的constant目录下。
2）应用内共享常量：放置在一方库中，通常是子模块中的constant目录下。
3）子工程内部共享常量：即在当前子工程的constant目录下。
4）包内共享常量：即在当前包下单独的constant目录下。
5）类内共享常量：直接在类内部privatestaticfinal定义。
5.【推荐】如果变量值仅在一个固定范围内变化用enum类型来定义。
(三)代码格式
1.【强制】大括号的使用约定。
如果是大括号内为空，则简洁地写成{}即可，不需要换行；如果是非空代码块则：
1）左大括号前不换行。
2）左大括号后换行。
3）右大括号前换行。
4）右大括号后还有else等代码则不换行；表示终止的右大括号后必须换行。
2.强制】左小括号和字符之间不出现空格；同样，右小括号和字符之间也不出现空格；
而左大 括号前需要空格。
3.强制】if/for/while/switch/do 等保留字与括号之间都必须加空格。
4. 【强制】任何二目、三目运算符的左右两边都需要加一个空格。
说明：运算符包括赋值运算符=、逻辑运算符&&、加减乘除符号等
5. 【强制】采用 4 个空格缩进，禁止使用 tab 字符。
说明：如果使用 tab 缩进，必须设置 1 个 tab 为 4 个空格。
IDEA 设置 tab 为 4 个空格时， 请勿勾选 Use tab character；
而在 eclipse 中，必须勾选 insert spaces for tabs。
正例： （涉及 1-5 点）
public static void main(String[] args) {
// 缩进 4 个空格
String say = "hello"; // 运算符的左右必须有一个空格
int flag = 0; // 关键词 if 与括号之间必须有一个空格，括号内的 f 与左括号，0 与右括号不需要空格
if (flag == 0) {
System.out.println(say);
} // 左大括号前加空格且不换行；左大括号后换行
if (flag == 1) {
System.out.println("world");
// 右大括号前换行，右大括号后有 else，不用换行
} else {
System.out.println("ok");
} // 在右大括号后直接结束，则必须换行
}
6. 【强制】注释的双斜线与注释内容之间有且仅有一个空格。
7. 【强制】单行字符数限制不超过 120 个，超出需要换行，换行时遵循如下原则：
1） 第二行相对第一行缩进 4 个空格，从第三行开始，不再继续缩进，参考示例。
2） 运算符与下文一起换行。
3） 方法调用的点符号与下文一起换行。
4） 方法调用中的多个参数需要换行时，在逗号后进行。
5） 在括号前不要换行，见反例。
8. 【强制】方法参数在定义和传入时，多个参数逗号后边必须加空格。
正例：下例中实参的 args1，后边必须要有一个空格。 method(args1, args2, args3);
9. 【强制】IDE 的 text file encoding 设置为 UTF-8;
IDE 中文件的换行符使用 Unix 格式， 不要使用 Windows 格式
10. 【推荐】单个方法的总行数不超过 80 行。
11. 【推荐】没有必要增加若干空格来使某一行的字符与上一行对应位置的字符对齐。
12. 【推荐】不同逻辑、不同语义、不同业务的代码之间插入一个空行分隔开来以提升可读性。
(四) OOP 规约
1. 【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成 本，直接用类名来访问即可。
2. 【强制】所有的覆写方法，必须加@Override 注解
3. 【强制】相同参数类型，相同业务含义，才可以使用 Java 的可变参数，避免使用 Object
4. 【强制】外部正在调用或者二方库依赖的接口，不允许修改方法签名，避免对接口调用方产生 影响。
接口过时必须加@Deprecated 注解，并清晰地说明采用的新接口或者新服务是什么。
5. 【强制】不能使用过时的类或方法。
6. 【强制】Object 的 equals 方法容易抛空指针异常，应使用常量或确定有值的对象来调用 equals。
7. 【强制】所有的相同类型的包装类对象之间值的比较，全部使用 equals 方法比较。
说明：对于 Integer var = ? 在-128 至 127 范围内的赋值，Integer 对象是在 IntegerCache.cache 产生，
会复用已有对象，这个区间内的 Integer 值可以直接使用==进行 判断，但是这个区间之外的所有数据，
都会在堆上产生，并不会复用已有对象，这是一个大坑， 推荐使用 equals 方法进行判断。
8.关于基本数据类型与包装数据类型的使用标准如下：
1） 【强制】所有的 POJO 类属性必须使用包装数据类型。
2） 【强制】RPC 方法的返回值和参数必须使用包装数据类型。
3） 【推荐】所有的局部变量使用基本数据类型。
9. 【强制】定义 DO/DTO/VO 等 POJO 类时，不要设定任何属性默认值。
【强制】序列化类新增属性时，请不要修改 serialVersionUID 字段，避免反序列失败；
如果完全不兼容升级，避免反序列化混乱，那么请修改 serialVersionUID 值。
11. 【强制】构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在 init 方法中。
12. 【强制】POJO 类必须写 toString 方法。使用 IDE 中的工具：source> generate toString 时，如果继承了另一个 POJO 类，
注意在前面加一下 super.toString。
13. 【强制】禁止在 POJO 类中，同时存在对应属性 xxx 的 isXxx()和 getXxx()方法。
14. 【推荐】使用索引访问用 String 的 split 方法得到的数组时，需做最后一个分隔符后有无 内容的检查，否则会有抛 IndexOutOfBoundsException 的风险。 说
15. 【推荐】当一个类有多个构造方法，或者多个同名方法，这些方法应该按顺序放置在一起， 便于阅读，此条规则优先于第 16 条规则。
16. 【推荐】 类内方法定义的顺序依次是：公有方法或保护方法 > 私有方法 > getter/setter 方法。
17. 【推荐】setter 方法中，参数名称与类成员变量名称一致，this.成员名 = 参数名。在 getter/setter 方法中，不要增加业务逻辑，增加排查问题的难度。
18. 【推荐】循环体内，字符串的连接方式，使用 StringBuilder 的 append 方法进行扩展。
19. 【推荐】final 可以声明类、成员变量、方法、以及本地变量，
下列情况使用 final 关键字：
1） 不允许被继承的类，如：String 类。
2） 不允许修改引用的域对象。
3） 不允许被重写的方法，如：POJO 类的 setter 方法。
4） 不允许运行过程中重新赋值的局部变量。
5） 避免上下文重复使用一个变量，使用 final 描述可以强制重新定义一个变量，方便更好 地进行重构。
20. 【推荐】慎用 Object 的 clone 方法来拷贝对象。
21. 【推荐】类成员与方法访问控制从严：
1） 如果不允许外部直接通过 new 来创建对象，那么构造方法必须是 private。
2） 工具类不允许有 public 或 default 构造方法。
3） 类非 static 成员变量并且与子类共享，必须是 protected。
4） 类非 static 成员变量并且仅在本类使用，必须是 private。
5） 类 static 成员变量如果仅在本类使用，必须是 private。
6） 若是 static 成员变量，考虑是否为 final。
7） 类成员方法只供类内部调用，必须是 private。
8） 类成员方法只对继承类公开，那么限制为 protected。
(五) 集合处理
1. 【强制】关于 hashCode 和 equals 的处理，遵循如下规则：
1） 只要重写 equals，就必须重写 hashCode。
2） 因为 Set 存储的是不重复的对象，依据 hashCode 和 equals 进行判断，所以 Set 存储的 对象
必须重写这两个方法。
3） 如果自定义对象作为 Map 的键，那么必须重写 hashCode 和 equals。
说明：String 重写了 hashCode 和 equals 方法，所以我们可以非常愉快地使用 String 对象 作为 key 来使用。
2.【强制】 ArrayList的subList结果不可强转成ArrayList，否则会抛出ClassCastException 异常，
即 java.util.RandomAccessSubList cannot be cast to java.util.ArrayList。
说明：subList 返回的是 ArrayList 的内部类 SubList，并不是 ArrayList
而是 ArrayList 的一个视图，对于 SubList 子列表的所有操作最终会反映到原列表上。
3. 【强制】在 subList 场景中，高度注意对原集合元素的增加或删除，
均会导致子列表的遍历、 增加、删除产生 ConcurrentModificationException 异常。
4. 【强制】使用集合转数组的方法，必须使用集合的 toArray(T[] array)，传入的是类型完全 一样的数组，
大小就是 list.size()。
5. 【强制】使用工具类 Arrays.asList()把数组转换成集合时，不能使用其修改集合相关的方 法，它的 add/remove/clear 方法
会抛出 UnsupportedOperationException 异常。
说明：asList 的返回对象是一个 Arrays 内部类，并没有实现集合的修改方法。
Arrays.asList 体现的是适配器模式，只是转换接口，后台的数据仍是数组。
String[] str = new String[] { "you", "wu" };
List list = Arrays.asList(str);
第一种情况：list.add("yangguanbao"); 运行时异常。
第二种情况：str[0] = "gujin"; 那么 list.get(0)也会随之修改
6. 【强制】泛型通配符<? extends T>来接收返回的数据，此写法的泛型集合不能使用 add 方 法，而<? super T>不能使用 get 方法，
作为接口调用赋值时易出错。
说明：扩展说一下 PECS(Producer Extends Consumer Super)原则：
第一、频繁往外读取内 容的，适合用<? extends T>。
第二、经常往里插入的，适合用<? super T>。
7.不要在 foreach 循环里进行元素的 remove/add 操作。remove 元素请使用 Iterator 方式，如果并发操作，需要对 Iterator 对象加锁。
8. 【强制】 在 JDK7 版本及以上，Comparator 实现类要满足如下三个条件，
不然 Arrays.sort， Collections.sort 会报 IllegalArgumentException 异常。
说明：三个条件如下
1） x，y 的比较结果和 y，x 的比较结果相反。
2） x>y，y>z，则 x>z。
3） x=y，则 x，z 比较结果和 y，z 比较结果相同
9.集合泛型定义时，在 JDK7 及以上，使用 diamond 语法或全省略。
说明：菱形泛型，即 diamond，直接使用<>来指代前边已经指定的类型。
10. 【推荐】集合初始化时，指定集合初始值大小。 说明：HashMap 使用
HashMap(int initialCapacity) 初始化。
正例：initialCapacity = (需要存储的元素个数 / 负载因子) + 1。
注意负载因子（即loader factor）默认为 0.75，如果暂时无法确定初始值大小，请设置为 16（即默认值）。
反例：HashMap 需要放置 1024 个元素，由于没有设置容量初始大小，
随着元素不断增加，容 量 7 次被迫扩大，resize 需要重建 hash 表，严重影响性能。
11. 【推荐】使用 entrySet 遍历 Map 类集合 KV，而不是 keySet 方式进行遍历。
说明：keySet 其实是遍历了 2 次，一次是转为 Iterator 对象，另一次是从 hashMap 中
取出 key 所对应的 value。而 entrySet 只是遍历了一次就把 key 和 value 都放到了 entry 中，
效率更高。如果是 JDK8，使用 Map.foreach 方法。
12. 【推荐】高度注意 Map 类集合 K/V 能不能存储 null 值的情况，如下表格：
13. 【参考】合理利用好集合的有序性(sort)和稳定性(order)，避免集合的无序性(unsort)和
不稳定性(unorder)带来的负面影响。
14. 【参考】利用 Set 元素唯一的特性，可以快速对一个集合进行去重操作，
避免使用 List 的 contains 方法进行遍历、对比、去重操作。
14. 【参考】利用 Set 元素唯一的特性，可以快速对一个集合进行去重操作，避免使用 List 的 contains 方法进行遍历、
对比、去重操作。
(六) 并发处理
1. 【强制】获取单例对象需要保证线程安全，其中的方法也要保证线程安全。
说明：资源驱动类、工具类、单例工厂类都需要注意。
2. 【强制】创建线程或线程池时请指定有意义的线程名称，方便出错时回溯。
3. 【强制】线程资源必须通过线程池提供，不允许在应用中自行显式创建线程。
4. 【强制】线程池不允许使用 Executors 去创建，而是通过 ThreadPoolExecutor 的方式，
这样 的处理方式让写的同学更加明确线程池的运行规则，规避资源耗尽的风险。
说明：Executors 返回的线程池对象的弊端如下：
1）FixedThreadPool 和 SingleThreadPool: 允许的请求队列长度为 Integer.MAX_VALUE，
可能会堆积大量的请求，从而导致 OOM。
2）CachedThreadPool 和 ScheduledThreadPool:
允许的创建线程数量为 Integer.MAX_VALUE，可能会创建大量的线程，从而导致 OOM。
5. 【强制】SimpleDateFormat 是线程不安全的类，一般不要定义为 static 变量，
如果定义为 static，必须加锁，或者使用 DateUtils 工具类。
6. 【强制】高并发时，同步调用应该去考量锁的性能损耗。能用无锁数据结构，就不要用锁；
能 锁区块，就不要锁整个方法体；能用对象锁，就不要用类锁。
7. 【强制】对多个资源、数据库表、对象同时加锁时，需要保持一致的加锁顺序，
否则可能会造 成死锁。
8. 【强制】并发修改同一记录时，避免更新丢失，需要加锁。要么在应用层加锁，要么在缓存加锁，
要么在数据库层使用乐观锁，使用 version 作为更新依据。
9. 【强制】多线程并行处理定时任务时，Timer 运行多个 TimeTask 时，只要其中之一没有捕获
抛出的异常，其它任务便会自动终止运行，使用 ScheduledExecutorService 则没有这个问题。
10. 【推荐】使用 CountDownLatch 进行异步转同步操作，每个线程退出前必须调用 countDown
方法，线程执行代码注意 catch 异常，确保 countDown 方法被执行到，避免主线程无法执行
至 await 方法，直到超时才返回结果。 说明：注意，子线程抛出异常堆栈，不能在主线程
try-catch 到。
11. 【推荐】避免 Random 实例被多线程使用，虽然共享该实例是线程安全的，
但会因竞争同一 seed 导致的性能下降。
(七) 控制语句
1. 【强制】在一个 switch 块内，每个 case 要么通过 break/return 等来终止，
要么注释说明程 序将继续执行到哪一个 case 为止；在一个 switch 块内，
都必须包含一个 default 语句并且 放在最后，即使空代码。
2.【强制】在 if/else/for/while/do 语句中必须使用大括号。即使只有一行代码，
避免采用 单行的编码方式：if (condition) statements;
3. 【强制】在高并发场景中，避免使用”等于”判断作为中断或退出的条件。 说明：如果并发控制没有处理好，
容易产生等值判断被“击穿”的情况，使用大于或小于的区间 判断条件来代替。
4.【推荐】避免采用取反逻辑运算符。
5.【推荐】接口入参保护，这种场景常见的是用作批量操作的接口。
(八) 注释规约
1. 【强制】类、类属性、类方法的注释必须使用 Javadoc 规范，使用/**内容*/格式，
不得使用 // xxx 方式。 说明：在 IDE 编辑窗口中，Javadoc 方式会提示相关注释，
生成 Javadoc 可以正确输出相应注 释；在 IDE 中，工程调用方法时，
不进入方法即可悬浮提示方法、参数、返回值的意义，提高 阅读效率。
2. 【强制】所有的抽象方法（包括接口中的方法）必须要用 Javadoc 注释、除了返回值、参数、
异常说明外，还必须指出该方法做什么事情，实现什么功能。
说明：对子类的实现要求，或者调用注意事项，请一并说明。
3. 【强制】所有的类都必须添加创建者和创建日期。
4. 【强制】方法内部单行注释，在被注释语句上方另起一行，使用//注释。
方法内部多行注释 使用/* */注释，注意与代码对齐。
5. 【强制】所有的枚举类型字段必须要有注释，说明每个数据项的用途。
6. 【推荐】与其“半吊子”英文来注释，不如用中文注释把问题说清楚。专有名词与关键字保持
英文原文即可。
7. 【推荐】代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻辑
等的修改。
8. 【参考】谨慎注释掉代码。在上方详细说明，而不是简单地注释掉。如果无用，则删除。
9. 【参考】对于注释的要求：第一、能够准确反应设计思想和代码逻辑；第二、能够描述业务含 义，使别的程序员能够迅速
了解到代码背后的信息。完全没有注释的大段代码对于阅读者形同天书，注释是给自己看的，即使
隔很长时间，也能清晰理解当时的思路；注释也是给继任者看的，使其能够快速接替自己的工作。
10.【参考】好的命名、代码结构是自解释的，注释力求精简准确、表达到位。避免出现注释的
一个极端：过多过滥的注释，代码的逻辑一旦修改，修改注释是相当大的负担。
11.【参考】特殊注释标记，请注明标记人与标记时间。注意及时处理这些标记，通过标记扫描，
经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。
1） 待办事宜（TODO）:（ 标记人，标记时间，[预计处理时间]）
表示需要实现，但目前还未实现的功能。这实际上是一个 Javadoc 的标签，
目前的 Javadoc 还没有实现，但已经被广泛使用。
只能应用于类，接口和方法（因为它是一个 Javadoc 标签）。
2） 错误，不能工作（FIXME）:（标记人，标记时间，[预计处理时间]）
在注释中用 FIXME 标记某代码是错误的，而且不能工作，需要及时纠正的情况。
(九) 其它
1. 【强制】在使用正则表达式时，利用好其预编译功能，可以有效加快正则匹配速度。
说明：不要在方法体内定义：Pattern pattern = Pattern.compile(“规则”);
2. 【强制】velocity 调用 POJO 类的属性时，建议直接使用属性名取值即可，模板引擎会自动按
规范调用 POJO 的 getXxx()，如果是 boolean 基本数据类型变量（boolean 命名不需要加 is
前缀），会自动调用 isXxx()方法。 说明：注意如果是 Boolean 包装类对象，优先调用
getXxx()的方法。
3. 【强制】后台输送给页面的变量必须加$!{var}——中间的感叹号。 说明：如果 var 等于 null
或者不存在，那么${var}会直接显示在页面上。
4. 【强制】注意 Math.random() 这个方法返回是 double 类型，注意取值的范围 0≤x<1
（能够 取到零值，注意除零异常），如果想获取整数类型的随机数，不要将 x 放大 10 的若干倍
然后 取整，直接使用 Random 对象的 nextInt 或者 nextLong 方法。
5. 【强制】获取当前毫秒数 System.currentTimeMillis(); 而不是 new Date().getTime();
说明：如果想获取更加精确的纳秒级时间值，使用 System.nanoTime()的方式。
在 JDK8 中， 针对统计时间等场景，推荐使用 Instant 类。
6. 【推荐】不要在视图模板中加入任何复杂的逻辑。 说明：根据 MVC 理论，视图的职责是展示，
不要抢模型和控制器的活。
7. 【推荐】任何数据结构的构造或初始化，都应指定大小，避免数据结构无限增长吃光内存。
8. 【推荐】及时清理不再使用的代码段或配置信息。 说明：对于垃圾代码或过时配置，
坚决清理干净，避免程序过度臃肿，代码冗余。 正例：对于暂时被注释掉，后续可能恢复使用的
代码片断，在注释代码上方，统一规定使用三 个斜杠(///)来说明注释掉代码的理由。
扫一扫
2247
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
