阿里2020年开发规范手册（泰山版）学习要点梳理

大田酱紫
291 阅读24分钟

前排提醒:

本文为阿里开发规范手册（泰山版）归纳（基本一样）,增强可读性(毕竟掘金有自动生成目录)，要查看各个要点的示例梳理建议查看原册，这里提供下载:

链接： pan.baidu.com/s/16JL78kCe…

提取码：ljwp

编程规约

命名风格

【强制要求】

  1. 代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。

  2. 所有编程相关的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。

  3. 类名使用UpperCamelCase(大驼峰) 风格，但以下情形例外：DO / BO / DTO / VO / AO / PO / UID 等。

  4. 方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase(小驼峰) 风格。

  5. 常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。

  6. 抽象类命名使用Abstract 或Base 开头；异常类命名使用Exception 结尾；测试类命名以它要测试的类的名称开始，以Test 结尾。

  7. 杜绝完全不规范的缩写，避免望文不知义。 反例：AbstractClass“缩写”命名成AbsClass；condition“缩写”命名成condi，此类随意缩写严重降低了代码的可阅读性。

  8. 类型与中括号紧挨相连来表示数组。正例：定义整形数组int[] arrayDemo;

  9. POJO 类(javaBean)中的任何布尔类型的变量，都不要加is 前缀，否则部分框架解析会引起序列化错误。

  10. 包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。

  11. 避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命名，使可读性降低。

【推荐要求】

  1. 为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词组合来表达。

  2. 在常量与变量的命名时，表示类型的名词放在词尾，以提升辨识度。 正例：startTime / workQueue / nameList / TERMINATED_THREAD_COUNT

  3. 如果模块、接口、类、方法使用了设计模式，在命名时需体现出具体模式。 说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计理念。

正例：

public class OrderFactory;
public class LoginProxy; 
public class ResourceObserver;
  1. 接口类中的方法和属性不要加任何修饰符号（public 也不要加），保持代码的简洁性，并加上有效的Javadoc注释。尽量不要在接口里定义变量，如果一定要定义变量，确定与接口方法相关，并且是整个应用的基础常量
  2. 接口和实现类的命名有两套规则：
  • 【强制】对于Service 和DAO 类，基于SOA 的理念，暴露出来的服务一定是接口，内部的实现类用Impl 的后缀与接口区别。 正例：CacheServiceImpl 实现CacheService 接口。
  • 【推荐】如果是形容能力的接口名称，取对应的形容词为接口名（通常是–able 的形容词）。 正例：AbstractTranslator 实现Translatable 接口。

【参考】

  1. 枚举类名带上Enum 后缀，枚举成员名称需要全大写，单词间用下划线隔开。 说明: 枚举其实就是特殊的常量类，且构造方法被默认强制是私有。

正例: 枚举名字为ProcessStatusEnum 的成员名称：SUCCESS / UNKNOWN_REASON。 18. 各层命名规约：

  1. Service/DAO 层方法命名规约

1）获取单个对象的方法用get 做前缀。

2）获取多个对象的方法用list 做前缀，复数结尾，如：listObjects。

3）获取统计值的方法用count 做前缀。

4）插入的方法用save/insert 做前缀。

5）删除的方法用remove/delete 做前缀。

6）修改的方法用update 做前缀。

  1. 领域模型命名规约

1）数据对象：xxxDO，xxx 即为数据表名。

2）数据传输对象：xxxDTO，xxx 为业务领域相关的名称。

3）展示对象：xxxVO，xxx 一般为网页名称。

4）POJO 是DO/DTO/BO/VO 的统称，禁止命名成xxxPOJO。

常量定义

【强制】

  1. 不允许任何魔法值（即未经预先定义的常量）直接出现在代码中。
  2. 在long 或者Long 赋值时，数值后使用大写的L，不能是小写的l，小写容易跟数字混淆，造成误解。

【推荐】

  1. 不要使用一个常量类维护所有常量，要按常量功能进行归类，分开维护。
  2. 常量的复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。
  3. 常量的复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。 1）跨应用共享常量：放置在二方库中，通常是client.jar 中的constant 目录下。

2）应用内共享常量：放置在一方库中，通常是子模块中的constant 目录下。

反例：易懂变量也要统一定义成应用内共享常量，两位工程师在两个类中分别定义了“YES”的变量：

类A 中：public static final String YES = "yes";
类B 中：public static final String YES = "y"; A.YES.equals(B.YES)，预期是true，但实际返回为false，导致线上问题。

3）子工程内部共享常量：即在当前子工程的constant 目录下。

4）包内共享常量：即在当前包下单独的constant 目录下。

5）类内共享常量：直接在类内部private static final 定义。

  1. 如果变量值仅在一个固定范围内变化用enum 类型来定义。

代码格式

【强制】

  1. 如果是大括号内为空，则简洁地写成{}即可，大括号中间无需换行和空格；如果是非空代码块则： 1）左大括号前不换行。

2）左大括号后换行。

3）右大括号前换行。

4）右大括号后还有else 等代码则不换行；表示终止的右大括号后必须换行。

  1. 左小括号和右边相邻字符之间不出现空格；右小括号和左边相邻字符之间也不出现空格；而左大括号前需要加空格。

  2. if/for/while/switch/do 等保留字与括号之间都必须加空格。

  3. 任何二目、三目运算符的左右两边都需要加一个空格。

说明：包括赋值运算符=、逻辑运算符&&、加减乘除符号等。

  1. 采用4 个空格缩进，禁止使用tab 字符。 说明：如果使用tab 缩进，必须设置1 个tab 为4 个空格。IDEA 设置tab 为4 个空格时，请勿勾选Use tab character；而在eclipse 中，必须勾选insert spaces for tabs。

  2. 注释的双斜线与注释内容之间有且仅有一个空格。

  3. 在进行类型强制转换时，右括号与强制转换值之间不需要任何空格隔开。

  4. 单行字符数限制不超过120 个，超出需要换行，换行时遵循如下原则： 1）第二行相对第一行缩进4 个空格，从第三行开始，不再继续缩进，参考示例。

2）运算符与下文一起换行。

3）方法调用的点符号与下文一起换行。

4）方法调用中的多个参数需要换行时，在逗号后进行。

5）在括号前不要换行，见反例。

注:除了逗号，其他的符号都跟后续代码一起换行 9. 方法参数在定义和传入时，多个参数逗号后边必须加空格。

正例：下例中实参的args1，后边必须要有一个空格。

method(args1, args2, args3);

  1. IDE 的text file encoding 设置为UTF-8; IDE 中文件的换行符使用Unix 格式，不要使用Windows 格式。

【推荐】

  1. 单个方法的总行数不超过80 行。

  2. 没有必要增加若干空格来使变量的赋值等号与上一行对应位置的等号对齐。

13.不同逻辑、不同语义、不同业务的代码之间插入一个空行分隔开来以提升可读性。

OOP （面向对象）规约

【强制】

  1. 避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成本，直接用类名来访问即可。
  2. 所有的覆写方法，必须加@Override 注解。
  3. 相同参数类型，相同业务含义，才可以使用Java 的可变参数，避免使用Object
  4. 外部正在调用或者二方库依赖的接口，不允许修改方法签名，避免对接口调用方产生影响。接口过时必须加@Deprecated 注解，并清晰地说明采用的新接口或者新服务是什么。
  5. 不能使用过时的类或方法。
  6. Object 的equals 方法容易抛空指针异常，应使用常量或确定有值的对象来调用equals。
  7. 所有整型包装类对象之间值的比较，全部使用equals 方法比较。
  8. 任何货币金额，均以最小货币单位且整型类型来进行存储。
  9. 浮点数之间的等值判断，基本数据类型不能用==来比较，包装数据类型不能用equals来判断。 正例：
(1) 指定一个误差范围，两个浮点数的差值在此范围之内，则认为是相等的。
float a = 1.0f - 0.9f;
float b = 0.9f - 0.8f;
float diff = 1e-6f;
if (Math.abs(a - b) < diff) {
System.out.println("true");
}
(2) 使用BigDecimal 来定义值，再进行浮点数的运算操作。
BigDecimal a = new BigDecimal("1.0");
BigDecimal b = new BigDecimal("0.9");
BigDecimal c = new BigDecimal("0.8");
BigDecimal x = a.subtract(b);
BigDecimal y = b.subtract(c);
if (x.equals(y)) {
System.out.println("true");
}
  1. 定义数据对象DO 类时，属性类型要与数据库字段类型相匹配。
  2. 禁止使用构造方法BigDecimal(double)的方式把double 值转化为BigDecimal 对象。
  3. 关于基本数据类型与包装数据类型的使用标准如下： 1）【强制】所有的POJO 类属性必须使用包装数据类型。

2）【强制】RPC 方法的返回值和参数必须使用包装数据类型。

3）【推荐】所有的局部变量使用基本数据类型。

说明：POJO 类属性没有初值是提醒使用者在需要使用时，必须自己显式地进行赋值，任何NPE 问题，或者入库检查，都由使用者来保证。

正例：数据库的查询结果可能是null，因为自动拆箱，用基本数据类型接收有NPE 风险。

  1. 定义DO/DTO/VO 等POJO 类时，不要设定任何属性默认值
  2. 序列化类新增属性时，请不要修改serialVersionUID 字段，避免反序列失败；如果完全不兼容升级，避免反序列化混乱，那么请修改serialVersionUID 值。
  3. 构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在init 方法中。
  4. POJO 类必须写toString 方法。
  5. 禁止在POJO 类中，同时存在对应属性xxx 的isXxx()和getXxx()方法。

【推荐】

  1. 使用索引访问用String 的split 方法得到的数组时，需做最后一个分隔符后有无内容的检查，否则会有抛IndexOutOfBoundsException 的风险。
  2. 当一个类有多个构造方法，或者多个同名方法，这些方法应该按顺序放置在一起，便于阅读，此条规则优先于下一条。
  3. 类内方法定义的顺序依次是：公有方法或保护方法> 私有方法> getter / setter 方法。
  4. setter 方法中，参数名称与类成员变量名称一致，this.成员名= 参数名。在getter/setter 方法中，不要增加业务逻辑，增加排查问题的难度。
  5. 循环体内，字符串的连接方式，使用StringBuilder 的append 方法进行扩展。
  6. final 可以声明类、成员变量、方法、以及本地变量，下列情况使用final 关键字： 1）不允许被继承的类，如：String 类。

2）不允许修改引用的域对象，如：POJO 类的域变量。

3）不允许被覆写的方法，如：POJO 类的setter 方法。

4）不允许运行过程中重新赋值的局部变量。

5）避免上下文重复使用一个变量，使用final 可以强制重新定义一个变量，方便更好地进行重构。

  1. 慎用Object 的clone 方法来拷贝对象
  2. 类成员与方法访问控制从严： 1）如果不允许外部直接通过new 来创建对象，那么构造方法必须是private。

2）工具类不允许有public 或default 构造方法。

3）类非static 成员变量并且与子类共享，必须是protected。

4）类非static 成员变量并且仅在本类使用，必须是private。

5）类static 成员变量如果仅在本类使用，必须是private。

6）若是static 成员变量，考虑是否为final。

7）类成员方法只供类内部调用，必须是private。

8）类成员方法只对继承类公开，那么限制为protected。

日期时间

【强制】

  1. 日期格式化时，传入pattern 中表示年份统一使用小写的y。
  2. 在日期格式中分清楚大写的M 和小写的m，大写的H 和小写的h 分别指代的意义。 说明：日期格式中的这两对字母表意如下： 1）表示月份是大写的M；

2）表示分钟则是小写的m；

3）24 小时制的是大写的H；

4）12 小时制的则是小写的h。

  1. 获取当前毫秒数：System.currentTimeMillis(); 而不是new Date().getTime()。

  2. 不允许在程序任何地方中使用：1）java.sql.Date 2）java.sql.Time 3）java.sql.Timestamp。 说明：第1 个不记录时间，getHours()抛出异常；第2 个不记录日期，getYear()抛出异常；第3 个在构造方法super((time/1000)*1000)，fastTime 和nanos 分开存储秒和纳秒信息。

  3. 不要在程序中写死一年为365 天，避免在公历闰年时出现日期转换错误或程序逻辑错误。 正例：

// 获取今年的天数
int daysOfThisYear = LocalDate.now().lengthOfYear(); // 获取指定某年的天数
LocalDate.of(2011, 1, 1).lengthOfYear();

反例：

// 第一种情况：在闰年366 天时，出现数组越界异常
int[] dayArray = new int[365];
// 第二种情况：一年有效期的会员制，今年1 月26 日注册，硬编码365 返回的却是1 月25 日
Calendar calendar = Calendar.getInstance();
calendar.set(2020, 1, 26);
calendar.add(Calendar.DATE, 365);
  1. 避免公历闰年2 月问题。闰年的2 月份有29 天，一年后的那一天不可能是2 月29 日。
  2. 使用枚举值来指代月份。如果使用数字，注意Date，Calendar 等日期相关类的月份 month 取值在0-11 之间。

集合处理

【强制】

  1. 关于hashCode 和equals 的处理，遵循如下规则：

1）只要重写equals，就必须重写hashCode。

2）因为Set 存储的是不重复的对象，依据hashCode 和equals 进行判断，所以Set 存储的对象必须重写这两个方法。

3）如果自定义对象作为Map 的键，那么必须覆写hashCode 和equals。

说明：String 因为重写了hashCode 和equals 方法，所以我们可以愉快地使用String 对象作为key 来使用。

  1. 判断所有集合内部的元素是否为空，使用isEmpty()方法，而不是size()==0 的方式。

  2. 在使用java.util.stream.Collectors 类的toMap()方法转为Map 集合时，一定要使用含有参数类型为BinaryOperator，参数名为mergeFunction 的方法，否则当出现相同key值时会抛出llegalStateException 异常。 说明：参数mergeFunction 的作用是当出现key 重复时，自定义对value 的处理策略。

  3. 在使用java.util.stream.Collectors 类的toMap()方法转为Map 集合时，一定要注意当value 为null 时会抛NPE 异常。

  4. ArrayList 的subList 结果不可强转成ArrayList，否则会抛出ClassCastException 异常：ava.util.RandomAccessSubList cannot be cast to java.util.ArrayList。

  5. 使用Map 的方法keySet()/values()/entrySet()返回集合对象时，不可以对其进行添加元素操作，否则会抛出UnsupportedOperationException 异常。

  6. Collections 类返回的对象，如：emptyList()/singletonList()等都是immutable list，不可对其进行添加或者删除元素的操作。

  7. 在subList 场景中，高度注意对父集合元素的增加或删除，均会导致子列表的遍历、增加、删除产生ConcurrentModificationException 异常。

  8. 使用集合转数组的方法，必须使用集合的toArray(T[] array)，传入的是类型完全一致、长度为0 的空数组。 反例：直接使用toArray 无参方法存在问题，此方法返回值只能是Object[]类，若强转其它类型数组将出现 ClassCastException 错误。

正例：

List<String> list = new ArrayList<>(2);
list.add("guan");
list.add("bao");
String[] array = list.toArray(new String[0]);
  1. 在使用Collection 接口任何实现类的addAll()方法时，都要对输入的集合参数进行NPE(空指针异常)判断
  2. 使用工具类Arrays.asList()把数组转换成集合时，不能使用其修改集合相关的方法，它的add/remove/clear 方法会抛出UnsupportedOperationException 异常。 说明：asList 的返回对象是一个Arrays 内部类，并没有实现集合的修改方法。Arrays.asList 体现的是适配器模式，只是转换接口，后台的数据仍是数组。

String[] str = new String[] { "yang", "hao" }; List list = Arrays.asList(str);

第一种情况：list.add("yangguanbao"); 运行时异常。

第二种情况：str[0] = "changed"; 也会随之修改，反之亦然。

  1. 泛型通配符<? extends T>来接收返回的数据，此写法的泛型集合不能使用add 方法，而<? super T>不能使用get 方法，两者在接口调用赋值的场景中容易出错。
  2. 在无泛型限制定义的集合赋值给泛型限制的集合时，在使用集合元素时，需要进行 instanceof 判断，避免抛出ClassCastException 异常。
  3. 不要在foreach 循环里进行元素的remove/add 操作。remove 元素请使用Iterator方式，如果并发操作，需要对Iterator 对象加锁。 正例：
List<String> list = new ArrayList<>();
list.add("1");
list.add("2");
Iterator<String> iterator = list.iterator();
while (iterator.hasNext()) {
String item = iterator.next();
if (删除元素的条件) {
iterator.remove();
}
}
  1. 在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 比较结果相同。

【推荐】

  1. 集合泛型定义时，在JDK7 及以上，使用diamond 语法或全省略。
  2. 集合初始化时，指定集合初始值大小。
  3. 使用entrySet 遍历Map 类集合KV，而不是keySet 方式进行遍历。
  4. 高度注意Map 类集合K/V 能不能存储null 值的情况，如下表格

【参考】

  1. 合理利用好集合的有序性(sort)和稳定性(order)，避免集合的无序性(unsort)和不稳定性(unorder)带来的负面影响。
  2. 利用Set 元素唯一的特性，可以快速对一个集合进行去重操作，避免使用List 的 contains()进行遍历去重或者判断包含操作。

并发

【强制】

  1. 获取单例对象需要保证线程安全，其中的方法也要保证线程安全。
  2. 创建线程或线程池时请指定有意义的线程名称，方便出错时回溯。
  3. 线程资源必须通过线程池提供，不允许在应用中自行显式创建线程。
  4. 线程池不允许使用Executors 去创建，而是通过ThreadPoolExecutor 的方式，这样的处理方式让写的同学更加明确线程池的运行规则，规避资源耗尽的风险。
  5. SimpleDateFormat 是线程不安全的类，一般不要定义为static 变量，如果定义为static，必须加锁，或者使用DateUtils 工具类。
  6. 必须回收自定义的ThreadLocal 变量，尤其在线程池场景下，线程经常会被复用，如果不清理自定义的ThreadLocal 变量，可能会影响后续业务逻辑和造成内存泄露等问题。尽量在代理中使用try-finally 块进行回收。
  7. 高并发时，同步调用应该去考量锁的性能损耗。能用无锁数据结构，就不要用锁；能锁区块，就不要锁整个方法体；能用对象锁，就不要用类锁。
  8. 对多个资源、数据库表、对象同时加锁时，需要保持一致的加锁顺序，否则可能会造成死锁。
  9. 在使用阻塞等待获取锁的方式中，必须在try 代码块之外，并且在加锁方法与try 代码块之间没有任何可能抛出异常的方法调用，避免加锁成功后，在finally 中无法解锁。
  10. 在使用尝试机制来获取锁的方式中，进入业务代码块之前，必须先判断当前线程是否持有锁。锁的释放规则与锁的阻塞等待方式相同。
  11. 并发修改同一记录时，避免更新丢失，需要加锁。要么在应用层加锁，要么在缓存加锁，要么在数据库层使用乐观锁，使用version 作为更新依据。
  12. 多线程并行处理定时任务时，Timer 运行多个TimeTask 时，只要其中之一没有捕获抛出的异常，其它任务便会自动终止运行，使用ScheduledExecutorService 则没有这个问题。

【推荐】

  1. 资金相关的金融敏感信息，使用悲观锁策略。

  2. 使用CountDownLatch 进行异步转同步操作，每个线程退出前必须调用countDown 方法，线程执行代码注意catch 异常，确保countDown 方法被执行到，避免主线程无法执行至await 方法，直到超时才返回结果。

  3. 避免Random 实例被多线程使用，虽然共享该实例是线程安全的，但会因竞争同一seed导致的性能下降。

  4. 通过双重检查锁（double-checked locking）（在并发场景下）实现延迟初始化的优化问题隐患(可参考The "Double-Checked Locking is Broken" Declaration)，推荐解决方案中较为简单一种（适用于JDK5 及以上版本），将目标属性声明为volatile 型（比如修改helper 的属性声明为private volatile Helper helper = null;）。

【参考】

  1. volatile 解决多线程内存不可见问题。对于一写多读，是可以解决变量同步问题，但是如果多写，同样无法解决线程安全问题。
  2. HashMap 在容量不够进行resize 时由于高并发可能出现死链，导致CPU 飙升，在开发过程中注意规避此风险。
  3. ThreadLocal 对象使用static 修饰，ThreadLocal 无法解决共享对象的更新问题。

【控制语句】

【强制】

  1. 在一个switch 块内，每个case 要么通过continue/break/return 等来终止，要么注释说明程序将继续执行到哪一个case 为止；在一个switch 块内，都必须包含一个default语句并且放在最后，即使它什么代码也没有。
  2. 当switch 括号内的变量类型为String 并且此变量为外部参数时，必须先进行null判断。
  3. 在if/else/for/while/do 语句中必须使用大括号。
  4. 三目运算符condition? 表达式1 : 表达式2 中，高度注意表达式1 和2 在类型对齐时，可能抛出因自动拆箱导致的NPE 异常。

说明：以下两种场景会触发类型对齐的拆箱操作：

1）表达式1 或表达式2 的值只要有一个是原始类型。

2）表达式1 或表达式2 的值的类型不一致，会强制拆箱升级成表示范围更大的那个类型。

  1. 在高并发场景中，避免使用”等于”判断作为中断或退出的条件。

说明：如果并发控制没有处理好，容易产生等值判断被“击穿”的情况，使用大于或小于的区间判断条件来代替。

【推荐】

  1. 当某个方法的代码行数超过10 行时，return / throw 等中断逻辑的右大括号后加一个空行。
  2. 表达异常的分支时，少用if-else 方式
  3. 除常用方法（如getXxx/isXxx）等外，不要在条件判断中执行其它复杂的语句，将复杂逻辑判断的结果赋值给一个有意义的布尔变量名，以提高可读性。
  4. 不要在其它表达式（尤其是条件表达式）中，插入赋值语句。
  5. 循环体中的语句要考量性能，以下操作尽量移至循环体外处理，如定义对象、变量、获取数据库连接，进行不必要的try-catch 操作（这个try-catch 是否可以移至循环体外）。
  6. 避免采用取反逻辑运算符。
  7. 接口入参保护，这种场景常见的是用作批量操作的接口。

注释规约

【强制】

  1. 类、类属性、类方法的注释必须使用Javadoc 规范，使用/*内容/格式，不得使用
  2. 所有的抽象方法（包括接口中的方法）必须要用Javadoc 注释、除了返回值、参数、异常说明外，还必须指出该方法做什么事情，实现什么功能。
  3. 所有的类都必须添加创建者和创建日期。
  4. 方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释使用/* */注释，注意与代码对齐。
  5. 所有的枚举类型字段必须要有注释，说明每个数据项的用途。

【推荐】

  1. 与其“半吊子”英文来注释，不如用中文注释把问题说清楚。专有名词与关键字保持英文原文即可。
  2. 代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻辑等的修改。
  3. 在类中删除未使用的任何字段和方法；在方法中删除未使用的任何参数声明与内部变量。

其他

【强制】

  1. 在使用正则表达式时，利用好其预编译功能，可以有效加快正则匹配速度。

  2. 避免用Apache Beanutils 进行属性的copy。 说明：Apache BeanUtils 性能较差，可以使用其他方案比如Spring BeanUtils, Cglib BeanCopier，注意均是浅拷贝。

  3. velocity 调用POJO 类的属性时，直接使用属性名取值即可，模板引擎会自动按规范调用POJO 的getXxx()，如果是boolean 基本数据类型变量（boolean 命名不需要加is 前缀），会自动调用isXxx()方法

  4. 后台输送给页面的变量必须加$!{var}——中间的感叹号。

  5. 注意Math.random() 这个方法返回是double 类型，注意取值的范围0≤x<1（能够取到零值，注意除零异常），如果想获取整数类型的随机数，不要将x 放大10 的若干倍然后取整，直接使用Random 对象的nextInt 或者nextLong 方法。

【推荐】

  1. 不要在视图模板中加入任何复杂的逻辑。
  2. 任何数据结构的构造或初始化，都应指定大小，避免数据结构无限增长吃光内存。
  3. 及时清理不再使用的代码段或配置信息。

异常日志

错误码

【强制】

  1. 错误码的制定原则：快速溯源、简单易记、沟通标准化。
  2. 错误码不体现版本号和错误等级信息。
  3. 全部正常，但不得不填充错误码时返回五个零：00000。
  4. 错误码为字符串类型，共5 位，分成两个部分：错误产生来源+四位数字编号。
  5. 编号不与公司业务架构，更不与组织架构挂钩，一切与平台先到先申请的原则进行，审批生效，编号即被永久固定。
  6. 错误码使用者避免随意定义新的错误码。
  7. 错误码不能直接输出给用户作为提示信息使用。

【推荐】

  1. 错误码之外的业务独特信息由error_message 来承载，而不是让错误码本身涵盖过多具体业务属性。
  2. 在获取第三方服务错误码时，向上抛出允许本系统转义，由C 转为B，并且在错误信息上带上原有的第三方错误码。

异常处理

【强制】

  1. Java 类库中定义的可以通过预检查方式规避的RuntimeException 异常不应该通过catch 的方式来处理，比如：NullPointerException，IndexOutOfBoundsException 等等。
  2. 异常不要用来做流程控制，条件控制。
  3. catch 时请分清稳定代码和非稳定代码，稳定代码指的是无论如何不会出错的代码。对于非稳定代码的catch 尽可能进行区分异常类型，再做对应的异常处理。
  4. 捕获异常是为了处理它，不要捕获了却什么都不处理而抛弃之，如果不想处理它，请将该异常抛给它的调用者。最外层的业务使用者，必须处理异常，将其转化为用户可以理解的内容。
  5. 事务场景中，抛出异常被catch 后，如果需要回滚，一定要注意手动回滚事务。
  6. finally 块必须对资源对象、流对象进行关闭，有异常也要做try-catch。
  7. 不要在finally 块中使用return。
  8. 捕获异常与抛异常，必须是完全匹配，或者捕获异常是抛异常的父类。
  9. 在调用RPC、二方包、或动态生成类的相关方法时，捕捉异常必须使用Throwable类来进行拦截。

【推荐】

  1. 方法的返回值可以为null，不强制返回空集合，或者空对象等，必须添加注释充分说明什么情况下会返回null 值。
  2. 使用JDK8 的Optional 类来防止NPE 问题。
  3. 定义时区分unchecked / checked 异常，避免直接抛出new RuntimeException()，更不允许抛出Exception 或者Throwable，应使用有业务含义的自定义异常。推荐业界已定义过的自定义异常，如：DAOException / ServiceException 等。

日志规约

【强制】

  1. 应用中不可直接使用日志系统（Log4j、Logback）中的API，而应依赖使用日志框架（SLF4J、JCL--Jakarta Commons Logging）中的API，使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一。
  2. 所有日志文件至少保存15 天，因为有些异常具备以“周”为频次发生的特点。对于当天日志，以“应用名.log”来保存，保存在/home/admin/应用名/logs/目录下，过往日志格式为: {logname}.log.{保存日期}，日期格式：yyyy-MM-dd
  3. 应用中的扩展日志（如打点、临时监控、访问日志等）命名方式
  4. 在日志输出时，字符串变量之间的拼接使用占位符的方式。
  5. 对于trace/debug/info级别的日志输出，必须进行日志级别的开关判断。
  6. 避免重复打印日志，浪费磁盘空间，务必在log4j.xml 中设置additivity=false。
  7. 生产环境禁止直接使用System.out 或System.err 输出日志或使用e.printStackTrace()打印异常堆栈。
  8. 异常信息应该包括两类信息：案发现场信息和异常堆栈信息。如果不处理，那么通过关键字throws 往上抛出。
  9. 日志打印时禁止直接用JSON 工具将对象转换成String。

【推荐】

  1. 谨慎地记录日志。生产环境禁止输出debug 日志；有选择地输出info 日志；如果使用warn 来记录刚上线时的业务行为信息，一定要注意日志输出量的问题，避免把服务器磁盘撑爆，并记得及时删除这些观察日志。
  2. 可以使用warn 日志级别来记录用户输入参数错误的情况，避免用户投诉时，无所适从。如非必要，请不要在此场景打出error 级别，避免频繁报警。
  3. 尽量用英文来描述日志错误信息，如果日志中的错误信息用英文描述不清楚的话使用中文描述即可，否则容易产生歧义。

单元测试

【强制】

  1. 好的单元测试必须遵守AIR 原则。

说明：单元测试在线上运行时，感觉像空气（AIR）一样并不存在，但在测试质量的保障上，却是非常关键的。好的单元测试宏观上来说，具有自动化、独立性、可重复执行的特点。

  1. 单元测试应该是全自动执行的，并且非交互式的。测试用例通常是被定期执行的，执行过程必须完全自动化才有意义。输出结果需要人工检查的测试不是一个好的单元测试。单元测试中不准使用System.out 来进行人肉验证，必须使用assert 来验证。
  2. 保持单元测试的独立性。为了保证单元测试稳定可靠且便于维护，单元测试用例之间决不能互相调用，也不能依赖执行的先后次序。
  3. 单元测试是可以重复执行的，不能受到外界环境的影响。
  4. 对于单元测试，要保证测试粒度足够小，有助于精确定位问题。单测粒度至多是类级别，一般是方法级别。
  5. 核心业务、核心应用、核心模块的增量代码确保单元测试通过。
  6. 单元测试代码必须写在如下工程目录：src/test/java，不允许写在业务代码目录下。

【推荐】

  1. 单元测试的基本目标：语句覆盖率达到70%；核心模块的语句覆盖率和分支覆盖率都要达到100%
  2. 编写单元测试代码遵守BCDE 原则，以保证被测试模块的交付质量。
  3. 对于数据库相关的查询，更新，删除等操作，不能假设数据库里的数据是存在的，或者直接操作数据库把数据插入进去，请使用程序插入或者导入数据的方式来准备数据。
  4. 和数据库相关的单元测试，可以设定自动回滚机制，不给数据库造成脏数据。或者对单元测试产生的数据有明确的前后缀标识。
  5. 对于不可测的代码在适当的时机做必要的重构，使代码变得可测，避免为了达到测试要求而书写不规范测试代码。
  6. 在设计评审阶段，开发人员需要和测试人员一起确定单元测试范围，单元测试最好覆盖所有测试用例（UC）。
  7. 单元测试作为一种质量保障手段，在项目提测前完成单元测试，不建议项目发布后补充单元测试用例。

安全规约

【强制】

  1. 隶属于用户个人的页面或者功能必须进行权限控制校验。
  2. 用户敏感数据禁止直接展示，必须对展示数据进行脱敏。
  3. 用户输入的SQL 参数严格使用参数绑定或者METADATA 字段值限定，防止SQL 注入，禁止字符串拼接SQL 访问数据库。
  4. 用户请求传入的任何参数必须做有效性验证。
  5. 禁止向HTML 页面输出未经安全过滤或未正确转义的用户数据
  6. 表单、AJAX 提交必须执行CSRF 安全验证。
  7. URL 外部重定向传入的目标地址必须执行白名单过滤。
  8. 在使用平台资源，譬如短信、邮件、电话、下单、支付，必须实现正确的防重放的机制，如数量限制、疲劳度控制、验证码校验，避免被滥刷而导致资损。
  9. 发贴、评论、发送即时消息等用户生成内容的场景必须实现防刷、文本内容违禁词过滤等风控策略

MySql数据库

建表规约

【强制】

  1. 表达是与否概念的字段，必须使用is_xxx 的方式命名，数据类型是unsigned tinyint（1 表示是，0 表示否） 2.表名、字段名必须使用小写字母或数字，禁止出现数字开头，禁止两个下划线中间只出现数字。数据库字段名的修改代价很大，因为无法进行预发布，所以字段名称需要慎重考虑。
  2. 表名不使用复数名词。
  3. 禁用保留字，如desc、range、match、delayed 等，请参考MySQL 官方保留字。
  4. 小数类型为decimal，禁止使用float 和double。
  5. 如果存储的字符串长度几乎相等，使用char 定长字符串类型。
  6. 主键索引名为pk_字段名；唯一索引名为uk_字段名；普通索引名则为idx_字段名。
  7. varchar 是可变长字符串，不预先分配存储空间，长度不要超过5000，如果存储长度大于此值，定义字段类型为text，独立出来一张表，用主键来对应，避免影响其它字段索引效率。
  8. 表必备三字段：id, gmt_create, gmt_modified。

【推荐】

  1. 表的命名最好是遵循“业务名称_表的作用”。
  2. 库名与应用名称尽量一致。
  3. 如果修改字段含义或对字段表示的状态追加时，需要及时更新字段注释。
  4. 字段允许适当冗余，以提高查询性能，但必须考虑数据一致。冗余字段应遵循：

1）不是频繁修改的字段。

2）不是唯一索引的字段。

3）不是varchar 超长字段，更不能是text 字段。

  1. 单表行数超过500 万行或者单表容量超过2GB，才推荐进行分库分表。

索引规约

【强制】

  1. 业务上具有唯一特性的字段，即使是组合字段，也必须建成唯一索引
  2. 超过三个表禁止join。需要join 的字段，数据类型保持绝对一致；多表关联查询时，保证被关联的字段需要有索引。
  3. 在varchar 字段上建立索引时，必须指定索引长度，没必要对全字段建立索引，根据实际文本区分度决定索引长度。
  4. 页面搜索严禁左模糊或者全模糊，如果需要请走搜索引擎来解决。

【推荐】

  1. 如果有order by 的场景，请注意利用索引的有序性。order by 最后的字段是组合索引的一部分，并且放在索引组合顺序的最后，避免出现file_sort 的情况，影响查询性能。
  2. 利用覆盖索引来进行查询操作，避免回表。
  3. 利用延迟关联或者子查询优化超多分页场景。
  4. SQL 性能优化的目标：至少要达到range 级别，要求是ref 级别，如果可以是consts最好
  5. 建组合索引的时候，区分度最高的在最左边。
  6. 防止因字段类型不同造成的隐式转换，导致索引失效。

SQL语句

【强制】

  1. 不要使用count(列名)或count(常量)来替代count()，count()是SQL92 定义的标准统计行数的语法，跟数据库无关，跟NULL 和非NULL 无关。
  2. count(distinct col) 计算该列除NULL 之外的不重复行数，注意count(distinct col1, col2) 如果其中一列全为NULL，那么即使另一列有不同的值，也返回为0。
  3. 当某一列的值全是NULL 时，count(col)的返回结果为0，但sum(col)的返回结果为NULL，因此使用sum()时需注意NPE 问题。
  4. 使用ISNULL()来判断是否为NULL 值。
  5. 代码中写分页查询逻辑时，若count 为0 应直接返回，避免执行后面的分页语句。
  6. 不得使用外键与级联，一切外键概念必须在应用层解决。
  7. 禁止使用存储过程，存储过程难以调试和扩展，更没有移植性。
  8. 数据订正（特别是删除或修改记录操作）时，要先select，避免出现误删除，确认无误才能执行更新语句。
  9. 对于数据库中表记录的查询和变更，只要涉及多个表，都需要在列名前加表的别名（或表名）进行限定。

【推荐】

  1. SQL 语句中表的别名前加as，并且以t1、t2、t3、...的顺序依次命名。
  2. in 操作能避免则避免，若实在避免不了，需要仔细评估in 后边的集合元素数量，控制在1000 个之内。

【ORM 映射】

【强制】

  1. 在表查询中，一律不要使用* 作为查询的字段列表，需要哪些字段必须明确写明。
  2. POJO 类的布尔属性不能加is，而数据库字段必须加is_，要求在resultMap 中进行字段与属性之间的映射。
  3. 不要用resultClass 当返回参数，即使所有类属性名与数据库字段一一对应，也需要定；反过来，每一个表也必然有一个与之对应。
  4. sql.xml 配置参数使用：#{}，#param# 不要使用${} 此种方式容易出现SQL 注入
  5. 不允许直接拿HashMap 与Hashtable 作为查询结果集的输出。
  6. 更新数据表记录时，必须同时更新记录对应的gmt_modified 字段值为当前时间。
  7. 不要写一个大而全的数据更新接口。传入为POJO 类，不管是不是自己的目标更新字段，都进行update table set c1=value1,c2=value2,c3=value3; 这是不对的。执行SQL 时，不要更新无改动的字段，一是易出错；二是效率低；三是增加binlog 存储。

工程结构

应用分层

【推荐】

  1. 图中默认上层依赖于下层，箭头关系表示可直接依赖，如：开放接口层可以依赖于Web 层，也可以直接依赖于Service 层，依此类推：
  • 开放接口层：可直接封装Service 方法暴露成RPC 接口；通过Web 封装成http 接口；网关控制层等。
  • 终端显示层：各个端的模板渲染并执行显示的层。当前主要是velocity 渲染，JS 渲染，JSP 渲染，移动端展示等。
  • Web 层：主要是对访问控制进行转发，各类基本参数校验，或者不复用的业务简单处理等。
  • Service 层：相对具体的业务逻辑服务层。
  • Manager 层：通用业务处理层，它有如下特征：

1）对第三方平台封装的层，预处理返回结果及转化异常信息。

2）对Service 层通用能力的下沉，如缓存方案、中间件通用处理。

3）与DAO 层交互，对多个DAO 的组合复用。

  • DAO 层：数据访问层，与底层MySQL、Oracle、Hbase、OB 等进行数据交互。
  • 外部接口或第三方平台：包括其它部门RPC 开放接口，基础平台，其它公司的HTTP 接口。
avatar
文章
阅读
粉丝