Java阿里规范

      无规矩不成方圆，同样在编码时也要遵循一定的规范，因为就会成为面试过程中的必问点，而大多数就以阿里的规范为主，近期看了文档做一个记录，相当于一个建议的阿里规范；

• 官网地址：https://developer.aliyun.com/topic/java2020?spm=a2c6h.12873639.0.0.51a270feIboA1i

文章目录

• Java阿里规范
• 1、编程规范
• • 1.1 命名风格
  • 1.2 常量定义
  • 1.3 代码格式
  • 1.4 OOP规约
  • 1.5 日期时间
  • 1.6 集合处理
  • 1.7 并发处理
  • 1.8 控制语句
  • 1.9 注释规约
  • 1.10 前后端规约
  • 1.11 其他
• 2、异常日志
• • 2.1 错误码
  • 2.2 异常处理
  • 2.3 日志规约
• 3、单元测试
• 4、安全规约
• 5、MySQL数据库
• • 5.1 建表规约
  • 5.2 索引规约
  • 5.3 SQL语句
  • 5.4 ORM映射
• 6、工程结构
• • 6.1 应用分层
  • • 6.1.1 根据业务架构实践，结合业界分层规范与流行技术框架分析；
    • 6.1.2 分层领域模型规约
  • 6.2 二方库依赖
  • 6.3 服务器
• 7、设计规约
• 8、专有名词解释
• 9、阿里规范的插件

1、编程规范

1.1 命名风格

1. 代码中的命名均不能以下划线或者美元符号开始，同时也不能以下划线或者$符号结束；
2. 代码中的命名禁止使用拼音和英文的混合方式，也不可以使用中文；
   • 纯拼音的方式应该避免使用
   • 做到见名知意
   • 地名可以用拼音
3. 代码和注释中都要避免使用任何人类语言中的种族歧视性或侮辱性词语；
4. 类名使用UpperCamelCase（大骆驼拼写法）风格，DO\BO\DTO\VO\AO\PO\UID除外；
   • UserDO、StudentService
5. 方法名、参数名、成员变量、局部变量统一使用lowerCamelCase（小骆驼拼写法）风格
   • localValue
6. 常量命名全部大写，单词间用下划线隔开，不要嫌弃名字过长；
   • MAX_STOCK_COUNT
7. 抽象类命名使用Abstract或者Base开头；异常类命名使用Exception结尾；测试类命名以测试名称开始，以Test结尾；
8. 类型与中括号紧挨相连来表示数组；
   • int[] myArray
9. POJO类中的任何布尔类型的变量都不加is前缀，否则会引起部分框架序列化错误；
10. 包名统一小写，点分隔符之间有且仅有一个自然语义的英语单词；包名统一使用单数的形式，如果类名有复数含义，类名可以使用复数形式；
11. 避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命名，使可理解性降低；
12. 杜绝不规范的缩写，避免望文不知义；
13. 为达到代码自解释的目标，任何自定义编程元素在命名时，尽量使用完整的单词组合表达；
14. 在常量与变量的命名时，表达类型的名词放在词尾，以此提高辨识度；
    • startTime、nameList
15. 如果模块、接口、类、方法使用了设计模式，在命名时需要体现出具体模式，有利于快速理解结构设计；
    • public class LoginFactory;
16. 接口类中的方法和属性不要加任何修饰符号（public 也不要加），保持代码的简洁性，加上有效的 Javadoc 注释。尽量不要在接口里定义变量，如果一定要定义变量，确定与接口方法相关，并且是整个应用的基础常量。
    • JDK8 中接口允许有默认实现，那么这个 default 方法，是对所有实现类都有价值的默认实现。
17. 接口和实现类的命名规则：内部的实现类用Impl与接口进行区别；
    • MyInfoService实现类就是MyInfoServiceImpl
18. 枚举类名带上Enum后缀，枚举成员名称需要大写，单词间用下划线隔开；
    • 枚举就是特殊的常量类，且构造方法被默认强制是私有；
19. 各层命名规约：
    • Service\DAO层：
      1. 获取单个对象的方法用get做前缀；
      2. 获取多个对象的方法用list做前缀，复数结尾；（listObjects）
      3. 获取统计值方法用count做前缀；
      4. 插入的方法用insert、save做前缀；
      5. 删除的方法用remove、delete做前缀；
      6. 修改的方法用update做前缀；
    • 领域模型命名规则：
      1. 数据对象：xxxDO（xxx：数据表名）
      2. 数据传输对象：xxxDTO（xxx：业务领域相关的名称）
      3. 展示对象：xxxVO（xxx：一般为网页名称）
      4. POJO 是 DO/DTO/BO/VO 的统称，禁止命名成 xxxPOJO

1.2 常量定义

1. 不允许任何未经预先定义的常量直接出现在代码中；
   • 可定义一个常量类
2. 在long或者Long赋值时，数值后使用大写的L，不可使用小写的l，容易跟数字混淆；
3. 浮点数类型的数值后缀统一为大写的D或者F；
4. 不要使用一个常量类维护所有常量，要按照常量功能进行归类，分开维护；
5. 常量的复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量；
   • 跨应用共享常量：放到公司内部中央仓库，可提供公司内部其他应用依赖的库；
   • 应用内共享常量：放到本工程内部子项目模块依赖的库中（易懂变量也要定义为应用内的共享常量）；
   • 子工程内部共享常量：放到当前子工程的constant目录下；
   • 包内共享常量：即在当前包下单独的 constant 目录下；
   • 类内共享常量：直接在类内部 private static final 定义；
6. 如果一个变量仅在一个固定范围内变化用enum类型定义；

1.3 代码格式

1. 如果大括号内为空，简洁地写成{}即可，大括号中间无需换行和空格；如果是非空代码块：
   • 左大括号前不换行；
   • 左大括号后换行；
   • 右大括号前换行；
   • 右大括号后还有 else 等代码则不换行；表示终止的右大括号后必须换行；
2. 左小括号和右边相邻字符之间不需要空格；右小括号和左边相邻字符之间也不需要空格；而左大括号前需要加空格；
3. if / for / while / switch / do 等保留字与左右括号之间都必须加空格；
4. 任何二目、三目运算符的左右两边都需要加一个空格；
   • ：包括赋值运算符 =、逻辑运算符 &&、加减乘除符号等；
5. 采用4个空格缩进，禁止使用 Tab 字符；
6. 注释的双斜线与注释内容之间有且仅有一个空格；
7. 在进行类型强制转换时，右括号与强制转换值之间不需要任何空格隔开；
   • int second = (int)first + 2;
8. 单行字符数限制不超过120个，超出需要换行，换行时遵循如下原则：
   • 第二行相对第一行缩进4个空格，从第三行开始，不再继续缩进；
   • 运算符与下文一起换行；
   • 方法调用的点符号与下文一起换行；
   • 方法调用中的多个参数需要换行时，在逗号后进行；
   • 在括号前不要换行；
9. 方法参数在定义和传入时，多个参数逗号后面必须加空格；
10. IDE 的 text file encoding 设置为 UTF-8；IDE 中文件的换行符使用 Unix 格式，不要使用
    Windows格式；
11. 单个方法的总行数不超过80行；
    • 代码逻辑分清个性和共性，单独的逻辑独立出来成为额外方法，使主干代码更加晰；共性逻辑抽取成为共性方法，便于复用和维护；
12. 没有必要增加若干空格来使变量的赋值等号与上一行对应位置的等号对齐；
13. 不同逻辑、不同语义、不同业务的代码之间插入一个空行，分隔开来以提升可读性；

1.4 OOP规约

1. 避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成本，直接用
   类名来访问即可；
2. 所有的覆写方法，必须加 @Override 注解；
   • getObject() 与 get0bject() 的问题。一个是字母的 O，一个是数字的 0，加 @Override 可以准确判断是否覆盖成功。另外，如果在抽象类中对方法签名进行修改，其实现类会马上编译报错；
3. 相同参数类型，相同业务含义，才可以使用的可变参数，参数类型避免定义为Object；
   • 建议开发者尽量不用可变参数编程
   • public List list(String type, Long… ids) {…}
4. 外部正在调用的接口或者二方库依赖的接口，不允许修改方法签名，避免对接口调用方产生影
   响。接口过时必须加 @Deprecated 注解，并清晰地说明采用的新接口或者新服务是什么；
5. 不能使用过时的类或方法;
6. Object 的quals方法容易抛空指针异常，应使用常量或确定有值的对象来调用 equals；
   • 1==equals(a)
   • 推荐使用工具类 java.util.Objects#equals(Object a, Object b)；
7. 所有整型包装类对象之间值的比较，全部使用equals方法比较；
8. 任何货币金额，均以最小货币单位且为整型类型进行存储；
9. 浮点数之间的等值判断，基本数据类型不能使用 == 进行比较，包装数据类型不能使用 equals
   进行判断；
   • 指定一个误差范围，两个浮点数的差值在此范围之内，则认为是相等的；
   • 使用BigDecimal来定义值，再进行浮点数的运算操作；
10. BigDecimal 的等值比较应使用 compareTo() 方法，而不是 equals() 方法；
11. 定义数据对象 DO 类时，属性类型要与数据库字段类型相匹配；
12. 禁止使用构造方法 BigDecimal(double) 的方式把 double 值转化为 BigDecimal 对象；
    • 优先推荐入参为 String 的构造方法，或使用 BigDecimal 的 valueOf 方法；
13. 关于基本数据类型与包装数据类型的使用标准如下：
    • 所有的 POJO 类属性必须使用包装数据类型；
    • RPC方法的返回值和参数必须使用包装数据类型；
    • 所有的局部变量使用基本数据类型；
14. 定义 DO / PO / DTO / VO 等 POJO 类时，不要设定任何属性默认值；
15. 序列化类新增属性时，请不要修改 serialVersionUID 字段，避免反序列失败；如果完全不兼
    容升级，避免反序列化混乱，那么请修改 serialVersionUID 值；
16. 构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在 init 方法中；
17. POJO 类必须写 toString 方法。使用 IDE 中的工具 source > generate toString 时，如果继
    承了另一个 POJO 类，注意在前面加一下 super.toString()；
18. 禁止在 POJO 类中，同时存在对应属性 xxx 的 isXxx() 和 getXxx() 方法；
19. 使用索引访问用 String 的 split 方法得到的数组时，需做最后一个分隔符后有无内容的检查，
    否则会有抛 IndexOutOfBoundsException 的风险；
20. 当一个类有多个构造方法，或者多个同名方法，这些方法应该按顺序放置在一起，便于阅读，
    此条规则优先于下一条；
21. 类内方法定义的顺序依次是：公有方法或保护方法 > 私有方法 > getter / setter 方法；
22. setter 方法中，参数名称与类成员变量名称一致，this.成员名=参数名。在 getter / setter 方
    法中，不要增加业务逻辑，增加排查问题的难度；
23. 循环体内，字符串的连接方式，使用 StringBuilder 的 append 方法进行扩展；
24. final 可以声明类、成员变量、方法、以及本地变量，下列情况使用 final 关键字：
    • 不允许被继承的类，如：String 类；
    • 不允许修改引用的域对象，如：POJO 类的域变量；
    • 不允许被覆写的方法，如：POJO 类的 setter 方法；
    • 不允许运行过程中重新赋值的局部变量；
    • 避免上下文重复使用一个变量，使用 final 关键字可以强制重新定义一个变量，方便更好地进行重构；
25. 慎用Object的clone方法来拷贝对象；
26. 类成员与方法访问控制从严（任何类、方法、参数、变量，严控访问范围。过于宽泛的访问范围，不利于模块解耦）：
    • 如果不允许外部直接通过 new 来创建对象，那么构造方法必须是 private；
    • 工具类不允许有 public 或 default 构造方法；
    • 类非 static 成员变量并且与子类共享，必须是 protected；
    • 类非 static 成员变量并且仅在本类使用，必须是 private；
    • 类 static 成员变量如果仅在本类使用，必须是 private；
    • 若是 static 成员变量，考虑是否为 final；
    • 类成员方法只供类内部调用，必须是 private；
    • 类成员方法只对继承类公开，那么限制为 protected；

1.5 日期时间

1. 日期格式化时，传入pattern中表示年份统一使用小写的y；
2. 在日期格式中分清楚大写的 M 和小写的 m，大写的 H 和小写的 h 分别指代的意义：
   • 表示月份是大写的 M；
   • 表示分钟则是小写的 m；
   • 24 小时制的是大写的 H；
   • 12 小时制的则是小写的 h；
3. 获取当前毫秒数：System.currentTimeMillis()；而不是 new Date().getTime()；
4. 不允许在程序任何地方中使用：1）java.sql.Date 2）java.sql.Time 3）java.sql.Timestamp；
5. 禁止在程序中写死一年为 365 天，避免在公历闰年时出现日期转换错误或程序逻辑错误；
6. 避免公历闰年 2 月问题。闰年的 2 月份有 29 天，一年后的那一天不可能是 2 月 29 日；
7. 使用枚举值来指代月份。如果使用数字，注意 Date，Calendar 等日期相关类的月份 month 取
   值范围从 0 到 11 之间；
   • Calendar.JANUARY，Calendar.FEBRUARY，Calendar.MARCH 等来指代相应月份来进行传参或比较；

1.6 集合处理

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

   • 只要覆写 equals，就必须覆写 hashCode；
   • 因为 Set 存储的是不重复的对象，依据 hashCode 和 equals 进行判断，所以 Set 存储的对象必须覆写这两种方法；
   • 如果自定义对象作为 Map 的键，那么必须覆写 hashCode 和 equals；

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

3. 在使用 java.util.stream.Collectors 类的 toMap() 方法转为 Map 集合时，一定要使用参数类型
   为 BinaryOperator，参数名为 mergeFunction 的方法，否则当出现相同 key 时会抛出
   IllegalStateException异常；

   • //正例
     Map map = pairArrayList.stream()
     .collect(Collectors.toMap(Pair::getKey, Pair::getValue, (v1, v2) -> v2));
     //反例  抛出 IllegalStateException 异常
     Map map = Arrays.stream(departments)
     .collect(Collectors.toMap(String::hashCode, str -> str));
     

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

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

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

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

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

9. 使用集合转数组的方法，必须使用集合的 toArray(T[] array)，传入的是类型完全一致、长度为
   0 的空数组；

10. 使用 Collection 接口任何实现类的 addAll() 方法时，要对输入的集合参数进行 NPE 判断；

    • 在 ArrayList#addAll 方法的第一行代码即 Object[] a = c.toArray()；其中 c 为输入集合参数，如果为 null，则直接抛出异常；

11. 使用工具类 Arrays.asList() 把数组转换成集合时，不能使用其修改集合相关的方法，它的 add
    / remove / clear 方法会抛出 UnsupportedOperationException 异常；

    • asList 的返回对象是一个 Arrays 内部类，并没有实现集合的修改方法。Arrays.asList 体现的是适配器模式，只是转换接口，后台的数据仍是数组；

12. 泛型通配符来接收返回的数据，此写法的泛型集合不能使用 add 方法，而不能使用 get 方法，两者在接口调用赋值的场景中容易出错；

    • 扩展说一下 PECS(Producer Extends Consumer Super) 原则，即频繁往外读取内容的，适合用>，经常往里插入的，适合用；

13. 在无泛型限制定义的集合赋值给泛型限制的集合时，在使用集合元素时，需要进行
    instanceof 判断，避免抛出 ClassCastException 异常；

14. 不要在 foreach 循环里进行元素的 remove / add 操作。remove 元素请使用 iterator 方式，
    如果并发操作，需要对 iterator 对象加锁；

15. 在 JDK7 版本及以上，Comparator 实现类要满足如下三个条件，不然 Arrays.sort，
    Collections.sort 会抛 IllegalArgumentException异常；

    • x，y 的比较结果和 y，x 的比较结果相反；
    • x > y，y > z，则 x > z；
    • x = y，则 x，z 比较结果和 y，z 比较结果相同；

16. 泛型集合使用时，在 JDK7 及以上，使用 diamond 语法或全省略；

    • // diamond 方式，即<>
      HashMap userCache = new HashMap<>(16);
      // 全省略方式
      ArrayList users = new ArrayList(10);
      

17. 集合初始化时，指定集合初始值大小；

    • initialCapacity = (需要存储的元素个数 / 负载因子) + 1。注意负载因子（即 loaderfactor）默认为 0.75，如果暂时无法确定初始值大小，请设置为 16（即默认值）；

18. 使用 entrySet 遍历 Map 类集合 KV，而不是 keySet 方式进行遍历；

19. 高度注意 Map 类集合 K / V 能不能存储 null 值的情况：

    集合类	key	value	super	说明
    Hashtable	不允许为 null	不允许为 null	Dictionary	线程安全
    TreeMap	不允许为 null	允许为 null	AbstractMap	线程不安全
    ConcurrentHashMap	不允许为 null	不允许为 null	AbstractMap	锁分段技术（JDK8:CAS）
    HashMap	允许为 null	允许为 null	AbstractMap	线程不安全

20. 合理利用好集合的有序性（sort）和稳定性（order），避免集合的无序性（unsort）和不稳定
    性（unorder）带来的负面影响；

21. 利用 Set 元素唯一的特性，可以快速对一个集合进行去重操作，避免使用 List 的
    contains() 进行遍历去重或者判断包含操作；

1.7 并发处理

1. 获取单例对象需要保证线程安全，其中的方法也要保证线程安全；

2. 创建线程或线程池时请指定有意义的线程名称，方便出错时回溯；

3. 线程资源必须通过线程池提供，不允许在应用中自行显式创建线程；

4. 线程池不允许使用 Executors 去创建，而是通过 ThreadPoolExecutor 的方式，这样的处理方
   式让写的同学更加明确线程池的运行规则，规避资源耗尽的风险；

5. SimpleDateFormat 是线程不安全的类，一般不要定义为 static 变量，如果定义为 static，必须
   加锁，或者使用 DateUtils 工具类；

6. 必须回收自定义的 ThreadLocal 变量，尤其在线程池场景下，线程经常会被复用，如果不清理
   自定义的 ThreadLocal 变量，可能会影响后续业务逻辑和造成内存泄露等问题。尽量在代理中使用try-finally 块进行回收；

   • objectThreadLocal.set(userInfo);
     try {
     // ...
     } finally {
     objectThreadLocal.remove();
     }
     

7. 高并发时，同步调用应该去考量锁的性能损耗。能用无锁数据结构，就不要用锁；能锁区块，就不要锁整个方法体；能用对象锁，就不要用类锁；

   • 尽可能使加锁的代码块工作量尽可能的小，避免在锁代码块中调用RPC方法；

8. 对多个资源、数据库表、对象同时加锁时，需要保持一致的加锁顺序，否则可能会造成死锁；

   • 线程一需要对表 A、B、C 依次全部加锁后才可以进行更新操作，那么线程二的加锁顺序也必须是 A、B、C，否则可能出现死锁；

9. 在使用阻塞等待获取锁的方式中，必须在 try 代码块之外，并且在加锁方法与 try 代码块之间没
   有任何可能抛出异常的方法调用，避免加锁成功后，在 finally 中无法解锁；

10. 在使用尝试机制来获取锁的方式中，进入业务代码块之前，必须先判断当前线程是否持有锁。
    锁的释放规则与锁的阻塞等待方式相同；

11. 并发修改同一记录时，避免更新丢失，需要加锁。要么在应用层加锁，要么在缓存加锁，要么
    在数据库层使用乐观锁，使用 version 作为更新依据；

    • 如果每次访问冲突概率小于20%，推荐使用乐观锁，否则使用悲观锁。乐观锁的重试次数不得小于3次；

12. 多线程并行处理定时任务时，Timer 运行多个 TimeTask 时，只要其中之一没有捕获抛出的异
    常，其它任务便会自动终止运行，使用 ScheduledExecutorService 则没有这个问题；

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

    • 悲观锁遵循一锁二判三更新四释放的原则；
    • 乐观锁在获得锁的同时已经完成了更新操作，校验逻辑容易出现漏洞，另外，乐观锁对冲突的解决策略有较复杂的要求，处理不当容易造成系统压力或数据异常，所以资金相关的金融敏感信息不建议使用乐观锁更新；

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

    • 子线程抛出异常堆栈，不能在主线程 try-catch 到；

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

16. volatile 解决多线程内存不可见问题对于一写多读，是可以解决变量同步问题，但是如果多
    写，同样无法解决线程安全问题；

17. HashMap 在容量不够进行 resize 时由于高并发可能出现死链，导致 CPU 飙升，在开发过程
    中注意规避此风险；

18. ThreadLocal 对象使用 static 修饰，ThreadLocal 无法解决共享对象的更新问题；

1.8 控制语句

1. 在一个 switch 块内，每个 case 要么通过 continue / break / return 等来终止，要么注释说明
   程序将继续执行到哪一个 case 为止；在一个 switch 块内，都必须包含一个 default 语句并且放在最后，即使它什么代码也没有；

   • break 是退出 switch 语句块，而 return 是退出方法体；

2. 当 switch 括号内的变量类型为 String 并且此变量为外部参数时，必须先进行 null 判断；

3. 在 if / else / for / while / do 语句中必须使用大括号；

4. 三目运算符 condition ? 表达式 1：表达式 2 中，高度注意表达式 1 和 2 在类型对齐时，可能
   抛出因自动拆箱导致的 NPE 异常；

   • Integer a = 1;
     Integer b = 2;
     Integer c = null;
     Boolean flag = false;
     // a*b 的结果是 int 类型，那么 c 会强制拆箱成 int 类型，抛出 NPE 异常
     Integer result = (flag ? a * b : c);
     

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

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

6. 当方法的代码总行数超过 10 行时，return / throw 等中断逻辑的右大括号后需要加一个空行；

7. 表达异常的分支时，少用 if-else 方式，应该及时return终止；

8. 除常用方法（如 getXxx / isXxx）等外不要在条件判断中执行其它复杂的语句，将复杂逻辑判
   断的结果赋值给一个有意义的布尔变量名，以提高可读性；

9. 不要在其它表达式（尤其是条件表达式）中，插入赋值语句；

10. 循环体中的语句要考量性能，以下操作尽量移至循环体外处理；

    • 定义对象、变量、获取数据库连接；
    • 进行不必要的 try-catch 操作（这个try-catch 是否可以移至循环体外）；

11. 避免采用取反逻辑运算符；

12. 公开接口需要进行入参保护，尤其是批量操作的接口；

1.9 注释规约

1. 类、类属性、类方法的注释必须使用 Javadoc 规范，使用 /** 内容 */ 格式，不得使用 // xxx
   方式；
2. 所有的抽象方法（包括接口中的方法）必须要用 Javadoc 注释、除了返回值、参数异常说明
   外，还必须指出该方法做什么事情，实现什么功能；
3. 所有的类都必须添加创建者和创建日期；
4. 方法内部单行注释，在被注释语句上方另起一行，使用 // 注释。方法内部多行注释使用 /* */
   注释，注意与代码对齐；
5. 所有的枚举类型字段必须要有注释，说明每个数据项的用途；
6. 与其用半吊子英文来注释，不如用中文注释说清楚。专有名词与关键字保持英文原文即可；
7. 代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻辑；
8. 在类中删除未使用的任何字段和方法、内部类；在方法中删除未使用的参数声明与内部变量；
9. 谨慎注释掉代码。在上方详细说明，而不是简单地注释掉。如果无用，则删除；
   • 后续会恢复此段代码逻辑—要有备注信息；
   • 永久不用—删除；
10. 对于注释的要求：第一、能够准确反映设计思想和代码逻辑；第二、能够描述业务含义，使别
    的程序员能够迅速了解到代码背后的信息。完全没有注释的大段代码对于阅读者形同天书，注释是给自己看的，即使隔很长时间，也能清晰理解当时的思路；注释也是给继任者看的，使其能够快速接替自己的工作；
11. 好的命名、代码结构是自解释的，注释力求精简准确、表达到位。避免出现注释的另一个极
    端：过多过滥的注释，代码的逻辑一旦修改，修改注释又是相当大的负担；
12. 特殊注释标记，请注明标记人与标记时间。注意及时处理这些标记，通过标记扫描，经常清理
    此类标记；
    • 待办事宜（TODO）：（标记人，标记时间，[预计处理时间]）表示需要实现，但目前还未实现的功能。这实际上是一个 Javadoc 的标签，目前的 Javadoc 还没有实现，但已经被广泛使用。只能应用于类，接口和方法；
    • 错误，不能工作（FIXME）：（标记人，标记时间，[预计处理时间]）在注释中用 FIXME 标记某代码是错误的，而且不能工作，需要及时纠正的情况；

1.10 前后端规约

1. 前后端交互的 API，需要明确协议、域名、路径、请求方法、请求内容、状态码、响应体；

2. 前后端数据列表相关的接口返回，如果为空，则返回空数组[]或空集合{}；

3. 服务端发生错误时，返回给前端的响应信息必须包含 HTTP 状态码，errorCode、
   errorMessage、用户提示信息四个部分；

   • 200 OK：表明该请求被成功地完成，所请求的资源发送到客户端；
   • 401 Unauthorized：请求要求身份验证，常见对于需要登录而用户未登录的情况；
   • 403 Forbidden：服务器拒绝请求，常见于机密信息或复制其它登录用户链接访问服务器的情况；
   • 404 NotFound：服务器无法取得所请求的网页，请求资源不存在；
   • 500 InternalServerError：服务器内部错误；

4. 在前后端交互的 JSON 格式数据中，所有的 key 必须为小写字母开始的 lowerCamelCase
   风格，符合英文表达习惯，且表意完整；

5. errorMessage 是前后端错误追踪机制的体现，可以在前端输出到 type=“hidden” 文字类控
   件中，或者用户端的日志中，帮助我们快速地定位出问题；

6. 对于需要使用超大整数的场景，服务端一律使用 String 字符串类型返回，禁止使用 Long 类型；

   • 如果过大，前端用number接会损失精度；

7. HTTP 请求通过 URL 传递参数时，不能超过 2048 字节；

8. HTTP 请求通过 body 传递内容时，必须控制长度，超出最大长度后，后端解析会出错；

9. 在翻页场景中，用户输入参数的小于 1，则前端返回第一页参数给后端；后端发现用户输入的
   参数大于总页数，直接返回最后一页；

10. 服务器内部重定向必须使用 forward；外部重定向地址必须使用 URL 统一代理模块生成，否
    则会因线上采用 HTTPS 协议而导致浏览器提示“不安全”，并且还会带来 URL 维护不一致的问题；

11. 服务端返回的数据，使用 JSON 格式而非 XML；

12. 前后端的时间格式统一为"yyyy-MM-dd HH:mm:ss"，统一为 GMT；

1.11 其他

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

   • /**
     * 首位非0的正整数
     */
     private static Pattern IS_INTEGER = Pattern.compile("^[1-9]([0-9]*)$|^[0-9]$");public Boolean check() {return IS_INTEGER.matcher("dsf").matches();
     }
     

2. 避免用 ApacheBeanutils 进行属性的 copy；

   • 使用浅拷贝SpringBeanUtils，CglibBeanCopie；

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

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

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

6. 枚举 enum（括号内）的属性字段必须是私有且不可变；

7. 任何数据结构的构造或初始化，都应指定大小，避免数据结构无限增长吃光内存；

8. 及时清理不再使用的代码段或配置信息；

2、异常日志

2.1 错误码

1. 错误码的制定原则：快速溯源、沟通标准化；
   • 错误码回答的问题是谁的错？错在哪？
2. 错误码不体现版本号和错误等级信息；
3. 编号不与公司业务架构，更不与组织架构挂钩，以先到先得的原则在统一平台上进行，审批生
   效，编号即被永久固定；
4. 错误码使用者避免随意定义新的错误码；
5. 错误码不能直接输出给用户作为提示信息使用；

2.2 异常处理

1. Java 类库中定义的可以通过预检查方式（防御势编程）规避的 RuntimeException 异常不应该通过 catch 的方式来处理，比如：NullPointerException，IndexOutOfBoundsException；
2. 异常捕获后不要用来做流程控制，条件控制；
3. catch 时请分清稳定代码和非稳定代码，稳定代码指的是无论如何不会出错的代码。对于非稳定
   代码的 catch 尽可能进行区分异常类型，再做对应的异常处理；
4. 捕获异常是为了处理它，不要捕获了却什么都不处理而抛弃之，如果不想处理它，请将该异常
   抛给它的调用者。最外层的业务使用者，必须处理异常，将其转化为用户可以理解的内容；
5. 事务场景中，抛出异常被 catch 后，如果需要回滚，一定要注意手动回滚事务；
6. finally 块必须对资源对象、流对象进行关闭，有异常也要做 try-catch；
7. 不要在 finally 块中使用 return；
   • try 块中的 return 语句执行成功后，并不马上返回，而是继续执行 finally 块中的语句，如果此处存在 return 语句，则会在此直接返回，无情丢弃掉 try 块中的返回点；
8. 捕获异常与抛异常，必须是完全匹配，或者捕获异常是抛异常的父类；
9. 方法的返回值可以为 null，不强制返回空集合，或者空对象等，必须添加注释充分说明什么情
   况下会返回 null 值；
10. 防止 NPE；
    • 返回类型为基本数据类型，return 包装数据类型的对象时，自动拆箱有可能产生 NPE；
    • 数据库的查询结果可能为 null；
    • 集合里的元素即使 isNotEmpty，取出的数据元素也可能为 null；
    • 远程调用返回对象时，一律要求进行空指针判断；
    • 对于 Session 中获取的数据，建议进行 NPE 检查，避免空指针；
    • 级联调用 obj.getA().getB().getC()；一连串调用，易产生 NPE；

2.3 日志规约

1. 应用中不可直接使用日志系统（Log4j、Logback）中的 API，可使用SLF4J；

2. 日志文件至少保存 15 天，因为有些异常具备以“周”为频次发生的特点；

3. 根据国家法律，网络运行状态、网络安全事件、个人敏感信息操作等相关记录，留存的日志不少于六个月，并且进行网络多机备份；

4. 在日志输出时，字符串变量之间的拼接使用占位符的方式；

   • String的拼接用的是StringBuilder的append的方式有性能损耗；

   • logger.debug("Processing trade with id : {} and symbol : {}", id, symbol);
     

5. 对于 trace / debug / info 级别的日志输出，必须进行日志级别的开关判断；

6. 生产环境禁止使用 System.out 或 System.err 输出或使用 e.printStackTrace() 打印异常堆栈；

7. 异常信息应该包括两类信息：案发现场信息和异常堆栈信息。如果不处理，那么通过关键字throws 往上抛出；

8. 日志打印时禁止直接用 JSON 工具将对象转换成 String；

   • 打印日志时仅打印出业务相关属性值或者调用其对象的 toString() 方法；

9. 尽量用英文来描述日志错误信息，如果日志中的错误信息用英文描述不清楚的话使用中文描述即可，否则容易产生歧义；

10. 为了保护用户隐私，日志文件中的用户敏感信息需要进行脱敏处理；

    • 日志排查问题时，推荐使用订单号、UUID（UUID.randomUUID()）之类的唯一编号进行查询；

3、单元测试

1. 好的单元测试必须遵守AIR（Automatic（自动化）、Independent（独立性）、Repeatable（可重复））原则；
   • 单元测试在线上运行时，感觉像空气（AIR）一样感觉不到，但在测试质量的保障上，却是非常关键的。好的单元
     测试宏观上来说，具有自动化、独立性、可重复执行的特点；
2. 保持单元测试的独立性。为了保证单元测试稳定可靠且便于维护，单元测试用例之间决不能互相调用，也不能依赖执行的先后次序；
3. 单元测试是可以重复执行的，不能受到外界环境的影响；
4. 对于单元测试，要保证测试粒度足够小，有助于精确定位问题。单测粒度至多是类级别，一般是方法级别；
5. 核心业务、核心应用、核心模块的增量代码确保单元测试通过；
6. 单元测试代码必须写在如下工程目录： src/test/java，不允许写在业务代码目录下；
7. 编写单元测试代码遵守 BCDE 原则，以保证被测试模块的交付质量；
   • Border：边界值测试，包括循环边界、特殊取值、特殊时间点、数据顺序等；
   • Correct：正确的输入，并得到预期的结果；
   • Design：与设计文档相结合，来编写单元测试；
   • Error：强制错误信息输入（如：非法数据、异常流程、业务允许外等），并得到预期的结果；
8. 对于数据库相关的查询，更新，删除等操作，不能假设数据库里的数据是存在的，或者直接操作数据库把数据插入进去，请使用程序插入或者导入数据的方式来准备数据；
9. 和数据库相关的单元测试，可以设定自动回滚机制，不给数据库造成脏数据。或者对单元测试产生的数据有明确的前后缀标识；
10. 对于不可测的代码在适当的时机做必要的重构，使代码变得可测避免为了达到测试要求而书写不规范测试代码；
11. 在设计评审阶段，开发人员需要和测试人员一起确定单元测试范围，单元测试最好覆盖所有测试用例（UC）；
12. 单元测试作为一种质量保障手段，在项目提测前完成单元测试，不建议项目发布后补充单元测试用例；

4、安全规约

1. 隶属于用户个人的页面或者功能必须进行权限控制校验；
   • 防止没有做水平权限校验就可随意访问、修改、删除别人的数据，比如查看他人的私信内容；
2. 用户敏感数据禁止直接展示，必须对展示数据进行脱敏；
3. 用户输入的 SQL 参数严格使用参数绑定或者 METADATA 字段值限定，防止 SQL 注入，禁止字符串拼接 SQL 访问数据库；
4. 用户请求传入的任何参数必须做有效性验证；
   • 页面 page size 过大导致内存溢出；
   • 恶意 order by 导致数据库慢查询；
   • 缓存击穿；
   • 任意重定向；
   • SQL 注入，Shell 注入，反序列化注入；
   • 正则输入源串拒绝服务 ReDoS；
5. 禁止向 HTML 页面输出未经安全过滤或未正确转义的用户数据；
6. 表单、AJAX 提交必须执行 CSRF 安全验证；
7. URL 外部重定向传入的目标地址必须执行白名单过滤；
8. 在使用平台资源，譬如短信、邮件、电话、下单、支付，必须实现正确的防重放的机制，如数量限制、疲劳度控制、验证码校验，避免被滥刷而导致资损；
   • 如注册时发送验证码到手机，如果没有限制次数和频率，那么可以利用此功能骚扰到其它用户，并造成短信平台资源浪费；
9. 对于文件上传功能，需要对于文件大小、类型进行严格检查和控制；
10. 配置文件中的密码需要加密；
11. 发贴、评论、发送等即时消息，需要用户输入内容的场景。必须实现防刷、内容违禁词过滤等风控策略；

5、MySQL数据库

5.1 建表规约

1. 表达是与否概念的字段，必须使用 is_xxx 的方式命名，数据类型是 unsigned tinyint（1 表示是，0 表示否）；
2. 表名、字段名必须使用小写字母或数字，禁止出现数字开头禁止两个下划线中间只出现数字。数据库字段名的修改代价很大，因为无法进行预发布，所以字段名称需要慎重考虑；
   • MySQL 在 Windows 下不区分大小写，但在 Linux 下默认是区分大小写。因此，数据库名、表名、字段名，都不允
     许出现任何大写字母，避免节外生枝；
3. 表名不使用复数名词；
4. 禁用保留字，如 desc、range、match、delayed；
5. 主键索引名为 pk_字段名；唯一索引名为 uk_字段名；普通索引名则为 idx_ 字段名；
6. 小数类型为 decimal，禁止使用 float 和 double；
   • float 和 double 都存在精度损失的问题；
   • 如果超过decimal范围，将整数、小数分开存；
7. 如果存储的字符串长度几乎相等，使用 char 定长字符串类型；
8. varchar 是可变长字符串，不预先分配存储空间，长度不要超过 5000，如果存储长度大于此值，定义字段类型为 text，独立出来一张表，用主键来对应，避免影响其它字段索引率；
9. 表必备三字段：id，create_time，update_time；
10. 在数据库中不能使用物理删除操作，要使用逻辑删除；
11. 表的命名最好是遵循“业务名称_表的作用”；
12. 库名与应用名称尽量一致；
13. 如果修改字段含义或对字段表示的状态追加时，需要及时更新字段注释；
14. 字段允许适当冗余，以提高查询性能，但必须考虑数据一致。冗余字段应遵循：
    • 不是频繁修改的字段；
    • 不是唯一索引的字段；
    • 不是 varchar 超长字段，更不能是 text 字段；
15. 单表行数超过 500 万行或者单表容量超过 2GB，才推荐进行分库分表；
16. 合适的字符存储长度，不但节约数据库表空间、节约索引存储，更重要的是提升检索速度；

5.2 索引规约

1. 业务上具有唯一特性的字段，即使是组合字段，也必须建成唯一索引；
   • 不要以为唯一索引影响了 insert 速度，这个速度损耗可以忽略，但提高查找速度是明显的；另外，即使在应用层
     做了非常完善的校验控制，只要没有唯一索引，根据墨菲定律，必然有脏数据产生；
2. 超过三个表禁止 join。需要 join 的字段，数据类型保持绝对一致；多表关联查询时，保证被关联的字段需要有索引；
3. 在 varchar 字段上建立索引时，必须指定索引长度，没必要对全字段建立索引，根据实际文本区分度决定索引长度；
4. 页面搜索严禁左模糊或者全模糊，如果需要请走搜索引擎来解决；
   • 索引文件具有 B-Tree 的最左前缀匹配特性，如果左边的值未确定，那么无法使用此索引；
5. 如果有 order by 的场景，请注意利用索引的有序性。order by 最后的字段是组合索引的一部分，并且放在索引组合顺序的最后，避免出现 filesort 的情况，影响查询性能；
   • where a = ? and b = ? order by c；索引：a_b_c
6. 利用覆盖索引来进行查询操作，避免回表；
   • 能够建立索引的种类分为主键索引、唯一索引、普通索引三种，而覆盖索引只是一种查询的一种效果，用 explain
     的结果，extra 列会出现：using index；
7. 利用延迟关联或者子查询优化超多分页场景；
   • SELECT t1.* FROM 表 1 as t1 , (select id from 表 1 where 条件 LIMIT 100000 , 20) as t2 where t1.id = t2.id
8. SQL 性能优化的目标：至少要达到 range 级别，要求是 ref 级别，如果可以是 const 最好；
   • consts 单表中最多只有一个匹配行（主键或者唯一索引），在优化阶段即可读取到数据；
   • ref 指的是使用普通的索引（normal index）；
   • range 对索引进行范围检索；
   • index 级别比较 range 还低，与全表扫描是小巫见大巫；
9. 建组合索引的时候，区分度最高的在最左边；
10. 防止因字段类型不同造成的隐式转换，导致索引失效；
11. 错误使用方式：
    • 索引宁滥勿缺。认为一个查询就需要建一个索引；
    • 吝啬索引的创建。认为索引会消耗空间、严重拖慢记录的更新以及行的新增速度；
    • 抵制唯一索引。认为唯一索引一律需要在应用层通过“先查后插”方式解决；

5.3 SQL语句

1. 不要使用 count(列名) 或 count(常量) 来替代 count()，count() 是 SQL92 定义的标准统计行数的语法，跟数据库无关，跟 NULL 和非 NULL 无关；
   • count(*) 会统计值为 NULL 的行，而 count(列名) 不会统计此列为 NULL 值的行；
2. 当某一列的值全是 NULL 时，count(col) 的返回结果为 0；但 sum(col) 的返回结果为 NULL，因此使用 sum() 时需注意 NPE 问题；
   • SELECT IFNULL(SUM(column) , 0) FROM table
3. 使用 ISNULL() 来判断是否为 NULL 值；
4. 代码中写分页查询逻辑时，若 count 为 0 应直接返回，避免执行后面的分页语句；
5. 不得使用外键与级联，一切外键概念必须在应用层解决；
6. 禁止使用存储过程，存储过程难以调试和扩展，更没有移植性；
7. 数据订正（特别是删除或修改记录操作）时，要先 select，避免出现误删除的情况，确认无误才能执行更新语句；
   • 可用Mybatis-plus里面的LambdaUpdateWrapper；
8. 对于数据库中表记录的查询和变更，只要涉及多个表，都需要在列名前加表的别名（或表名）进行限定；
9. SQL 语句中表的别名前加 as，并且以 t1、t2、t3、…的顺序依次命名；
   • 别名可以是表的简称，或者是依照表在 SQL 语句中出现的顺序，以 t1、t2、t3 的方式命名；
   • 别名前加 as 使别名更容易识别；
10. in 操作能避免则避免，若实在避免不了，需要仔细评估 in 后边的集合元素数量，控制在1000 个之内；
11. 因国际化需要，所有的字符存储与表示，均采用utf8字符集，那么字符计数方法需要注意；

5.4 ORM映射

1. 在表查询中，一律不要使用 * 作为查询的字段列表，需要哪些字段必须明确写明；
   • 增加查询分析器解析成本；
   • 增减字段容易与 resultMap 配置不一致；
   • 无用字段增加网络消耗，尤其是 text 类型的字段；
2. POJO类的布尔属性不能加 is，而数据库字段必须加 is_，要求在 resultMap 中进行字段与属性之间的映射；
3. 不要用resultClass当返回参数，即使所有类属性名与数据库字段一一对应，也需要定义；反过来，每一个表也必然有一个与之对应；
4. sql.xml 配置参数使用：#{}，#param#不要使用 ${}此种方式容易出现SQL注入；
5. 不允许直接拿HashMap与Hashtable作为查询结果集的输出；
6. 更新数据表记录时，必须同时更新记录对应的 update_time 字段值为当前时间；
7. 不要写一个大而全的数据更新接口，执行 SQL 时，不要更新无改动的字段，一是易出错；二是效率低；三是增加 binlog 存储；
8. @Transactional 事务不要滥用。事务会影响数据库的 QPS，另外使用事务的地方需要考虑各方面的回滚方案，包括缓存回滚、搜索引擎回滚、消息补偿、统计修正等；

6、工程结构

6.1 应用分层

6.1.1 根据业务架构实践，结合业界分层规范与流行技术框架分析；

• 开放API层：可直接封装Service接口暴露成RPC接口；通过Web封装成http接口；网关控制层；

• 终端显示层：各个端的模板渲染并执行显示的层。当前主要是 velocity 渲染，JS 渲染，JSP 渲染，移动端展示；

• Web层：主要是对访问控制进行转发，各类基本参数校验，或者不复用的业务简单处理；

• Service层：相对具体的业务逻辑服务层；

• Manager层：通用业务处理层，

  对第三方平台封装的层，预处理返回结果及转化异常信息，适配上层接口；

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

  与 DAO 层交互，对多个 DAO 的组合复用；

• 第三方服务：包括其它部门 RPC 服务接口，基础平台，其它公司的 HTTP 接口，如淘宝开放平台、支付宝付款服务、高德地图服务；

• 外部数据接口：外部（应用）数据存储服务提供的接口，多见于数据迁移场景中；

6.1.2 分层领域模型规约

DO（Data Object）：此对象与数据库表结构一一对应，通过 DAO 层向上传输数据源对象；

DTO（Data Transfer Object）：数据传输对象，Service 或 Manager 向外传输的对象；

BO（Business Object）：业务对象，可以由 Service 层输出的封装业务逻辑的对象；

Query：数据查询对象，各层接收上层的查询请求。注意超过 2 个参数的查询封装，禁止使用 Map 类来传输；

VO（View Object）：显示层对象，通常是 Web 向模板渲染引擎层传输的对象；

6.2 二方库依赖

1. 定义 GAV 遵从以下规则：
   • GroupId 格式：com.{公司/BU}.业务线.[子业务线]，最多4级；
   • ArtifactId 格式：产品线名-模块名。语义不重复不遗漏；
   • Version：主版本号.次版本号.修订号；
2. 二方库的新增或升级，保持除功能点之外的其它 jar 包仲裁结果不变。如果有改变，必须明确评
   估和验证；
3. 二方库里可以定义枚举类型，参数可以使用枚举类型，但是接口返回值不允许使用枚举类型或者包含枚举类型的 POJO 对象；
4. 依赖于一个二方库群时，必须定义一个统一的版本变量，避免版本号不一致；
5. 禁止在子项目的 pom 依赖中出现相同的 GroupId，相同的 ArtifactId，但是不同的 Version；

6.3 服务器

1. 调用远程操作必须有超时设置；
   • 类似于 HttpClient 的超时设置需要自己明确去设置 Timeout。根据经验表明，无数次的故障都是因为没有设置超时时间；
2. 客户端设置远程接口方法的具体超时时间（单位 ms），超时设置生效顺序一般为：1）客户端 Special Method；2）客户端接口级别；3）服务端 Special Method；4）服务端接口级别；
3. 高并发服务器建议调小 TCP 协议的 time_wait 超时时间；
4. 在线上生产环境，JVM 的 Xms 和 Xmx 设置一样大小的内存容量，避免在 GC 后调整堆大小带来的压力；
5. 给 JVM 环境参数设置-XX：+HeapDumpOnOutOfMemoryError 参数，让 JVM 碰到 OOM 场景时输出 dump 信息；

7、设计规约

1. 存储方案和底层数据结构的设计获得评审一致通过，并沉淀成为文档；
2. 在需求分析阶段，如果与系统交互的 User 超过一类并且相关的 UserCase 超过 5 个，使用用例图来表达更加清晰的结构化需求；
3. 如果某个业务对象的状态超过 3 个，使用状态图来表达并且明确状态变化的各个触发条件；
   • 状态图的核心是对象状态，首先明确对象有多少种状态，然后明确两两状态之间是否存在直接转换关系，再明确触发状态转换的条件是什么；
4. 如果系统中某个功能的调用链路上的涉及对象超过 3 个，使用时序图来表达并且明确各调用环节的输入与输出；
5. 如果系统中模型类超过 5 个，且存在复杂的依赖关系，使用类图来表达并且明确类之间的关系；
6. 如果系统中超过 2 个对象之间存在协作关系，并需要表示复杂的处理流程，使用活动图来表示；
7. 系统设计时要准确识别出弱依赖，并针对性地设计降级和应急预案，保证核心系统正常可用；
8. 类在设计与实现时要符合单一原则；
9. 需求分析与系统设计在考虑主干功能的同时，需要充分评估异常流程与业务边界；
10. 系统架构设计时明确以下目标：
    • 确定系统边界。确定系统在技术层面上的做与不做；
    • 确定系统内模块之间的关系。确定模块之间的依赖关系及模块的宏观输与输出；
    • 确定指导后续设计与演化的原则。使后续的子系统或模块设计在一个既定的框架内和技术方向上继续演化；
    • 确定非功能性需求。非功能性需求是指安全性、可用性、可扩展性；
11. 系统设计阶段，注意对扩展开放，对修改闭合；
12. 系统设计阶段，共性业务或公共行为抽取出来公共模块、公共配置、公共类、公共方法等，在系统中不出现重复代码的情况，即 DRY 原则（Don’t Repeat Yourself）；
13. 敏捷开发！=讲故事+编码+发布
    • ：敏捷开发是快速交付迭代可用的系统，省略多余的设计方案，摒弃传统的审批流程，但核心关键点上的必要设计
      和文档沉淀是需要的；
14. 设计文档的作用是明确需求、理顺逻辑、后期维护，次要目的用于指导编码；
15. 可扩展性的本质是找到系统的变化点，并隔离变化点；
16. 设计的本质就是识别和表达系统难点；

8、专有名词解释

1. POJO（Plain Ordinary Java Object）：在本规约中，POJO 专指只有 setter / getter / toString 的简单类，包括DO / DTO / BO / VO 等；

2. DO（Data Object）：阿里巴巴专指数据库表一 一对应的 POJO 类。此对象与数据库表结构一 一对应，通过 DAO 层向上传输数据源对象；

3. PO（Persistent Object）：也指数据库表一 一对应的 POJO 类。此对象与数据库表结构一 一对应，通过 DAO 层向上传输数据源对象；

4. DTO（Data Transfer Object ）：数据传输对象，Service 或 Manager 向外传输的对象；

5. BO（Business Object）：业务对象，可以由 Service 层输出的封装业务逻辑的对象；

6. Query：数据查询对象，各层接收上层的查询请求。注意超过 2 个参数的查询封装，禁止使用 Map 类来传输；

7. VO（View Object）：显示层对象，通常是 Web 向模板渲染引擎层传输的对象；

8. CAS（Compare And Swap）：解决多线程并行情况下使用锁造成性能损耗的一种机制，这是硬件实现的原子操作。CAS 操作包含三个操作数：内存位置、预期原值和新值。如果内存位置的值与预期原值相匹配，那么处理器会自动将该位置值更新为新值。否则，处理器不做任何操作；

9. GAV（GroupId、ArtifactId、Version）：Maven 坐标，是用来唯一标识 jar 包；

10. OOP（Object Oriented Programming）：本文泛指类、对象的编程处理方式；

11. AQS（AbstractQueuedSynchronizer）：利用先进先出队列实现的底层同步工具类，它是很多上层同步实现类的基础，比如：ReentrantLock、CountDownLatch、Semaphore 等，它们通过继承 AQS 实现其模版方法，然后将 AQS子类作为同步组件的内部类，通常命名为 Sync；

12. ORM（Object Relation Mapping）：对象关系映射，对象领域模型与底层数据之间的转换，本文泛指 iBATIS，mybatis 等框架；

13. NPE（java.lang.NullPointerException）：空指针异常；

14. OOM（Out Of Memory）：源于 java.lang.OutOfMemoryError，当 JVM 没有足够的内存来为对象分配空间并且垃圾回收器也无法回收空间时，系统出现的严重状况；

15. GMT（Greenwich Mean Time）：指位于英国伦敦郊区的皇家格林尼治天文台的标准时间，因为本初子午线被定义在通过那里的经线。地球每天的自转是有些不规则的，而且正在缓慢减速，现在的标准时间是协调世界时（UTC），它由原子钟提供；

16. 一方库：本工程内部子项目模块依赖的库（jar 包）；

17. 二方库：公司内部发布到中央仓库，可供公司内部其它应用依赖的库（jar 包）；

18. 三方库：公司之外的开源库（jar 包）；

9、阿里规范的插件

这么多我们也不可能一时间都记住，因此就有了阿里规范的插件，可以安装在我们的编译器上实时的监测；

开启实时扫描

这样就可以实时监测我们写的代码了