8. 【强制】POJO类中布尔类型的变量，都不要加is前缀，否则部分框架解析会引起序列化错误。
反例：定义为基本数据类型Boolean isDeleted的属性，它的方法也是isDeleted()，RPC框架在反向解析的时候，“误以为”对应的属性名称是deleted，导致属性获取不到，进而抛出异常。

9. 【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。
正例：应用工具类包名为com.alibaba.ai.util、类名为MessageUtils（此规则参考spring的框架结构）

   12.【推荐】如果模块、接口、类、方法使用了设计模式，在命名时需体现出具体模式。
       说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计理念。
       正例：public class OrderFactory;
                   public class LoginProxy;
                   public class ResourceObserver;

   13.【推荐】接口类中的方法和属性不要加任何修饰符号（public 也不要加），保持代码的简洁性，并加上有效的Javadoc注释。尽量不要在接口里定义变量，如果一定要定义变量，肯定是与接口方法相关，并且是整个应用的基础常量。
       正例：接口方法签名void commit();
                   接口基础常量String COMPANY = "alibaba";
       反例：接口方法定义public abstract void f();
       说明：JDK8中接口允许有默认实现，那么这个default方法，是对所有实现类都有价值的默认实现。

   14. 接口和实现类的命名有两套规则：
       1）【强制】对于Service和DAO类，基于SOA的理念，暴露出来的服务一定是接口，内部的实现类用Impl的后缀与接口区别。
       正例：CacheServiceImpl实现CacheService接口。
       2）【推荐】如果是形容能力的接口名称，取对应的形容词为接口名（通常是–able的形式）。
       正例：AbstractTranslator实现Translatable接口。

   16. 【参考】各层命名规约：
       A) Service/DAO层方法命名规约
           1）获取单个对象的方法用get做前缀。
           2）获取多个对象的方法用list做前缀，复数形式结尾如：listObjects。
           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。

(二) 常量定义

   3. 【推荐】不要使用一个常量类维护所有常量，要按常量功能进行归类，分开维护。
       说明：大而全的常量类，杂乱无章，使用查找功能才能定位到修改的常量，不利于理解和维护。
       正例：缓存相关常量放在类CacheConsts下；系统配置相关常量放在类ConfigConsts下。

   4. 【推荐】常量的复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。
       1）跨应用共享常量：放置在二方库中，通常是client.jar中的constant目录下。
       2）应用内共享常量：放置在一方库中，通常是子模块中的constant目录下。
           反例：易懂变量也要统一定义成应用内共享常量，两位攻城师在两个类中分别定义了表示“是”的变量：
               类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. 【强制】大括号的使用约定。如果是大括号内为空，则简洁地写成{}即可，不需要换行；如果是非空代码块则：
       1）左大括号前不换行。
       2）左大括号后换行。
       3）右大括号前换行。
       4）右大括号后还有else等代码则不换行；表示终止的右大括号后必须换行。

2. 【强制】左小括号和字符之间不出现空格；同样，右小括号和字符之间也不出现空格；而左大括号前需要空格。详见第5条下方正例提示。
反例：if (空格a == b空格)

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");
   // 在右大括号后直接结束，则必须换行
   }
   }

(四) OOP规约

1. 【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成本，直接用类名来访问即可。

   6. 【强制】Object的equals方法容易抛空指针异常，应使用常量或确定有值的对象来调用equals。
       正例："test".equals(object);
       反例：object.equals("test");
       说明：推荐使用java.util.Objects#equals（JDK7引入的工具类）

7. 【强制】所有的相同类型的包装类对象之间值的比较，全部使用equals方法比较。
说明：对于Integer var = ? 在-128至127范围内的赋值，Integer对象是在IntegerCache.cache产生，会复用已有对象，这个区间内的Integer值可以直接使用==进行判断，但是这个区间之外的所有数据，都会在堆上产生，并不会复用已有对象，这是一个大坑，推荐使用equals方法进行判断。

   8. 关于基本数据类型与包装数据类型的使用标准如下：
       1）【强制】所有的POJO类属性必须使用包装数据类型。
       2）【强制】RPC方法的返回值和参数必须使用包装数据类型。
       3）【推荐】所有的局部变量使用基本数据类型。
       说明：POJO类属性没有初值是提醒使用者在需要使用时，必须自己显式地进行赋值，任何NPE问题，或者入库检查，都由使用者来保证。
       正例：数据库的查询结果可能是null，因为自动拆箱，用基本数据类型接收有NPE风险。
       反例：比如显示成交总额涨跌情况，即正负x%，x为基本数据类型，调用的RPC服务，调用不成功时，返回的是默认值，页面显示为0%，这是不合理的，应该显示成中划线。所以包装数据类型的null值，能够表示额外的信息，如：远程调用失败，异常退出。

9. 【强制】定义DO/DTO/VO等POJO类时，不要设定任何属性默认值。
反例：POJO类的gmtCreate默认值为new Date()，但是这个属性在数据提取时并没有置入具体值，在更新其它字段时又附带更新了此字段，导致创建时间被修改成当前时间。

12. 【强制】POJO类必须写toString方法。使用IDE中的工具：source> generate toString时，如果继承了另一个POJO类，注意在前面加一下super.toString。
说明：在方法执行抛出异常时，可以直接调用POJO的toString()方法打印其属性值，便于排查问题。

13. 【强制】禁止在 POJO类中，同时存在对应属性 xxx的 isXxx()和 getXxx()方法。
说明：框架在调用属性 xxx 的提取方法时，并不能确定哪个方法一定是被优先调用到

(五) 集合处理

   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>。

   11. 【推荐】使用entrySet遍历Map类集合KV，而不是keySet方式进行遍历。
       说明：keySet其实是遍历了2次，一次是转为Iterator对象，另一次是从hashMap中取出key所对应的value。而entrySet只是遍历了一次就把key和value都放到了entry中，效率更高。
       如果是JDK8，使用Map.foreach方法。
       正例：values()返回的是V值集合，是一个list集合对象；keySet()返回的是K值集合，是一个Set集合对象；entrySet()返回的是K-V值组合集合。

14. 【参考】利用Set元素唯一的特性，可以快速对一个集合进行去重操作，避免使用List的contains方法进行遍历、对比、去重操作。

(六) 并发处理

3. 【强制】线程资源必须通过线程池提供，不允许在应用中自行显式创建线程。
说明：使用线程池的好处是减少在创建和销毁线程上所消耗的时间以及系统资源的开销，解决资源不足的问题。如果不使用线程池，有可能造成系统创建大量同类线程而导致消耗完内存或者“过度切换”的问题。

   4. 【强制】线程池不允许使用 Executors去创建，而是通过 ThreadPoolExecutor 去创建，这样的处理方式让写同学更加明确线程池运行规则，避资源耗尽风险。
       说明： Executors返回的线程池对象的弊端如下：
       1）FixedThreadPool 和 SingleThreadPoolPool: 允许的请求队列长度为 Integer.MAX_VALUE，可能会堆积大量的请求，从而导致 OOM。
       2）CachedThreadPool 和 ScheduledThreadPool : 允许的创建线程数量为 Integer.MAX_VALUE，可能会创建大量的线程，从而导致 OOM。

8. 【强制】并发修改同一记录时，避免更新丢失，需要加锁。要么在应用层加锁，要么在缓存加锁，要么在数据库层使用乐观锁，使用version作为更新依据。
说明：如果每次访问冲突概率小于20%，推荐使用乐观锁，否则使用悲观锁。乐观锁的重试次数不得小于3次。

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

10.【推荐】使用CountDownLatch进行异步转同步操作，每个线程退出前必须调用countDown方法，线程执行代码注意catch异常，确保countDown方法被执行到，避免主线程无法执行至await方法，直到超时才返回结果。
说明：注意，子线程抛出异常堆栈，不能在主线程try-catch到。

   11.【推荐】避免Random实例被多线程使用，虽然共享该实例是线程安全的，但会因竞争同一seed导致的性能下降。
       说明：Random实例包括java.util.Random 的实例或者 Math.random()的方式。
       正例：在JDK7之后，可以直接使用API ThreadLocalRandom，而在 JDK7之前，需要编码保证每个线程持有一个实例。

   13. 【参考】volatile解决多线程内存不可见问题。对于一写多读，是可以解决变量同步问题，但是如果多写，同样无法解决线程安全问题。
       如果是count++操作，使用如下类实现：
           AtomicInteger count = new AtomicInteger();
           count.addAndGet(1);
       如果是JDK8，推荐使用LongAdder对象，比AtomicLong性能更好（减少乐观锁的重试次数）。

15. 【参考】ThreadLocal无法解决共享对象的更新问题，ThreadLocal对象建议使用static修饰。这个变量是针对一个线程内所有操作共享的，所以设置为静态变量，所有此类实例共享此静态变量，也就是说在类第一次被使用时装载，只分配一块存储空间，所有此类的对象(只要是这个线程内定义的)都可以操控这个变量。

(七) 控制语句

   3. 【强制】在高并发场景中，避免使用 ”等于 ”判断作为中或退出的条件。判断作为中或退出的条件。
       说明：如果并发控制没有处理好，容易产生等值判断被“击穿 ”的情况，使用大于或小区间判断条件来代替。
       反例：判断剩余奖品数量等于0时，终止发放奖品，但因为并处理错误导致数量瞬间变成了负数，这样的话，活动无法终止。

   9. 【参考】下列情形，需要进行参数校验：
       1）调用频次低的方法。
       2）执行时间开销很大的方法。此情形中，参数校验时间几乎可以忽略不计，但如果因为参数错误导致中间执行回退，或者错误，那得不偿失。
       3）需要极高稳定性和可用性的方法。
       4）对外提供的开放接口，不管是RPC/API/HTTP接口。
       5）敏感权限入口。

   10. 【参考】下列情形，不需要进行参数校验：
       1）极有可能被循环调用的方法。但在方法说明里必须注明外部参数检查要求。
       2）底层调用频度比较高的方法。毕竟是像纯净水过滤的最后一道，参数错误不太可能到底层才会暴露问题。一般DAO层与Service层都在同一个应用中，部署在同一台服务器中，所以DAO的参数校验，可以省略。
       3）被声明成private只会被自己代码所调用的方法，如果能够确定调用方法的代码传入参数已经做过检查或者肯定不会有问题，此时可以不校验参数。

(八) 注释规约

(九) 其它

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

二、异常日志

(一) 异常处理

6. 【强制】finally块必须对资源对象、流对象进行关闭，有异常也要做try-catch。
说明：如果JDK7及以上，可以使用try-with-resources方式。

7. 【强制】不要在finally块中使用return。
说明：finally块中的return返回后方法结束执行，不会再执行try块中的return语句。

   10. 【推荐】防止NPE，是程序员的基本修养，注意NPE产生的场景：
       1）返回类型为基本数据类型，return包装数据类型的对象时，自动拆箱有可能产生NPE。
           反例：public int f() { return Integer对象}，如果为null，自动解箱抛NPE。
       2）数据库的查询结果可能为null。
       3）集合里的元素即使isNotEmpty，取出的数据元素也可能为null。
       4）远程调用返回对象时，一律要求进行空指针判断，防止NPE。
       5）对于Session中获取的数据，建议NPE检查，避免空指针。
       6）级联调用obj.getA().getB().getC()；一连串调用，易产生NPE。
           正例：使用JDK8的Optional类来防止NPE问题。

   12. 【参考】对于公司外的http/api开放接口必须使用“错误码”；而应用内部推荐异常抛出；跨应用间RPC调用优先考虑使用Result方式，封装isSuccess()方法、“错误码”、“错误简短信息”。
       说明：关于RPC方法返回方式使用Result方式的理由：
           1）使用抛异常返回方式，调用方如果没有捕获到就会产生运行时错误。
           2）如果不加栈信息，只是new自定义异常，加入自己的理解的error message，对于调用端解决问题的帮助不会太多。如果加了栈信息，在频繁调用出错的情况下，数据序列化和传输的性能损耗也是问题。

(二) 日志规约

   1. 【强制】应用中不可直接使用日志系统（Log4j、Logback）中的API，而应依赖使用日志框架SLF4J中的API，使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一。
       import org.slf4j.Logger;
       import org.slf4j.LoggerFactory;
       private static final Logger logger = LoggerFactory.getLogger(Abc.class);

   4. 【强制】对trace/debug/info级别的日志输出，必须使用条件输出形式或者使用占位符的方式。
       说明：logger.debug("Processing trade with id: " + id + " and symbol: " + symbol);
       如果日志级别是warn，上述日志不会打印，但是会执行字符串拼接操作，如果symbol是对象，会执行toString()方法，浪费了系统资源，执行了上述操作，最终日志却没有打印。
       正例：（条件）建设采用如下方式
           if (logger.isDebugEnabled()) {
               logger.debug("Processing trade with id: " + id + " and symbol: " + symbol);
           }
       正例：（占位符）
           logger.debug("Processing trade with id: {} and symbol : {} ", id, symbol);

5. 【强制】避免重复打印日志，浪费磁盘空间，务必在log4j.xml中设置additivity=false。
正例：<logger name="com.taobao.dubbo.config" additivity="false">

6. 【强制】异常信息应该包括两类信息：案发现场信息和异常堆栈信息。如果不处理，那么通过关键字throws往上抛出。
正例：logger.error(各类参数或者对象toString() + "_" + e.getMessage(), e);

8. 【推荐】可以使用warn日志级别来记录用户输入参数错误的情况，避免投诉时，无所适从。如非必要，请不在此场景打出error级别，避免频繁报警。
说明：注意日志输出的级别，error级别只记录系统逻辑出错、异常或者重要的错误信息

三、单元测试

   15. 【参考】为了更方便地进行单元测试，业务代码应避免以下情况：
       . 构造方法中做的事情过多。
       . 存在过多的全局变量和静态方法。
       . 存在过多的外部依赖。
       . 存在过多的条件语句。
       说明：多层条件语句建议使用卫语句、策略模式、状态模式等方式重构

   16. 【参考】不要对单元测试存在如下误解： 
       . 那是测试同学干的事情。本文开发手册，凡是本文内容都与开发同学强相关的。 
       . 单元测试代码是多余的。系统的整体功能与各单元部件的测试正常否是强相关。 
       . 单元测试代码不需要维护。一年半载后，那么几乎处于废弃状态
       . 单元测试与线上故障没有辩证关系。好的单元测试能够最大限度的规避线上故障

四、安全规约

1. 【强制】隶属于用户个人的页面或者功能必须进行权限控制校验。
说明：防止没有做水平权限校验就可随意访问、修改、删除别人的数据，比如查看他人的私信内容、修改他人的订单。

2. 【强制】用户敏感数据禁止直接展示，必须对展示数据进行脱敏。
说明：中国大陆个人手机号码显示为:158****9119，隐藏中间4位，防止隐私泄露。

3. 【强制】用户输入的SQL参数严格使用参数绑定或者METADATA字段值限定，防止SQL注入，禁止字符串拼接SQL访问数据库。

   6. 【强制】表单、AJAX提交必须执行CSRF安全验证。
       说明：CSRF(Cross-site request forgery)跨站请求伪造是一类常见编程漏洞。
       对于存在CSRF漏洞的应用/网站，攻击者可以事先构造好URL，只要受害者用户一访问，后台便在用户不知情的情况下对数据库中用户参数进行相应修改。

五、MySQL数据库

(一) 建表规约

5. 【强制】主键索引名为pk_字段名；唯一索引名为uk_字段名；普通索引名则为idx_字段名。
说明：pk_ 即primary key；uk_ 即 unique key；idx_ 即index的简称。

   6. 【强制】小数类型为decimal，禁止使用float和double。
       说明：float和double在存储的时候，存在精度损失的问题，很可能在值的比较时，得到不正确的结果。
       如果存储的数据范围超过decimal的范围，建议将数据拆成整数和小数分开存储。

7. 【强制】如果存储的字符串长度几乎相等，使用char定长字符串类型。

8. 【强制】varchar是可变长字符串，不预先分配存储空间，长度不要超过5000，如果存储长度大于此值，定义字段类型为text，独立出来一张表，用主键来对应，避免影响其它字段索引效率。

   9. 【强制】表必备三字段：id, gmt_create, gmt_modified。
       说明：其中id必为主键，类型bigint unsigned、单表时自增、步长为1。
       gmt_create, gmt_modified的类型均为datetime类型，前者现在时表示主动创建，后者过去分词表示被动更新。

10. 【推荐】表的命名最好是加上“业务名称_表的作用”。
正例：alipay_task / force_project / trade_config

14. 【推荐】单表行数超过500万行或者单表容量超过2GB，才推荐进行分库分表。
说明：如果预计三年后的数据量根本达不到这个级别，请不要在创建表时就分库分表。

(二) 索引规约

   1. 【强制】业务上具有唯一特性的字段，即使是多个字段的组合，也必须建成唯一索引。
       说明：不要以为唯一索引影响了insert速度，这个速度损耗可以忽略，但提高查找速度是明显的；
       另外，即使在应用层做了非常完善的校验控制，只要没有唯一索引，根据墨菲定律，必然有脏数据产生。

2. 【强制】超过三个表禁止join。需要join的字段，数据类型必须绝对一致；多表关联查询时，保证被关联的字段需要有索引。
说明：即使双表join也要注意表索引、SQL性能。

4. 【强制】页面搜索严禁左模糊或者全模糊，如果需要请走搜索引擎来解决。
说明：索引文件具有B-Tree的最左前缀匹配特性，如果左边的值未确定，那么无法使用此索引。

   7. 【推荐】利用延迟关联或者子查询优化超多分页场景。
       说明：MySQL并不是跳过offset行，而是取offset+N行，然后返回放弃前offset行，返回N行，那当offset特别大的时候，效率就非常的低下，要么控制返回的总页数，要么对超过特定阈值的页数进行SQL改写。
       正例：先快速定位需要获取的id段，然后再关联：
           SELECT a.* FROM 表1 a, (select id from 表1 where 条件 LIMIT 100000,20 ) b where a.id=b.id

   9. 【推荐】建组合索引的时候，区分度最高的在最左边。
       正例：如果where a=? and b=? ，如果a列的几乎接近于唯一值，那么只需要单建idx_a索引即可。
       说明：存在非等号和等号混合时，在建索引时，请把等号条件的列前置。如：where c>? and d=? 那么即使c的区分度更高，也必须把d放在索引的最前列，即索引idx_d_c。

(三) SQL语句

   1. 【强制】不要使用count(列名)或count(常量)来替代count(*)，
       count(*)是SQL92定义的标准统计行数的语法，跟数据库无关，跟NULL和非NULL无关。
       说明：count(*)会统计值为NULL的行，而count(列名)不会统计此列为NULL值的行。

2. 【强制】count(distinct col) 计算该列除NULL之外的不重复行数，注意 count(distinct col1, col2) 如果其中一列全为NULL，那么即使另一列有不同的值，也返回为0。

3. 【强制】当某一列的值全是NULL时，count(col)的返回结果为0，但sum(col)的返回结果为NULL，因此使用sum()时需注意NPE问题。正例：可以使用如下方式来避免sum的NPE问题：SELECT IF(ISNULL(SUM(g)),0,SUM(g)) FROM table;

   4. 【强制】使用ISNULL()来判断是否为NULL值。
       说明：NULL与任何值的直接比较都为NULL。
           1） NULL<>NULL的返回结果是NULL，而不是false。
           2） NULL=NULL的返回结果是NULL，而不是true。
           3） NULL<>1的返回结果是NULL，而不是true。

7. 【强制】禁止使用存储过程，存储过程难以调试和扩展，更没有移植性。

9. 【推荐】in操作能避免则避免，若实在避免不了，需要仔细评估in后边的集合元素数量，控制在1000个之内。

(四) ORM映射

   1. 【强制】在表查询中，一律不要使用 * 作为查询的字段列表，需要哪些字段必须明确写明。
       说明：
           1）增加查询分析器解析成本。
           2）增减字段容易与resultMap配置不一致。
           3）无用字段增加网络消耗，尤其是text类型的字段。

4. 【强制】sql.xml配置参数使用：#{}，#param# 不要使用${} 此种方式容易出现SQL注入。

   5. 【强制】iBATIS自带的queryForList(String statementName,int start,int size)不推荐使用。
       说明：其实现方式是在数据库取到statementName对应的SQL语句的所有记录，再通过subList取start,size的子集合。
       正例：Map<String, Object> map = new HashMap<>();
                   map.put("start", start);
                   map.put("size", size);

6. 【强制】不允许直接拿HashMap与Hashtable作为查询结果集的输出。
说明：resultClass=”Hashtable”，会置入字段名和属性值，但是值的类型不可控。

8. 【推荐】不要写一个大而全的数据更新接口。传入为POJO类，不管是不是自己的目标更新字段，都进行update table set c1=value1,c2=value2,c3=value3; 这是不对的。执行SQL时，不要更新无改动的字段，一是易出错；二是效率低；三是增加binlog存储。

9. 【参考】@Transactional事务不要滥用。事务会影响数据库的QPS，另外使用事务的地方需要考虑各方面的回滚方案，包括缓存回滚、搜索引擎回滚、消息补偿、统计修正等。

六、工程结构

(一) 应用分层

   3. 【参考】分层领域模型规约：
    DO（Data Object）：此对象与数据库表结构一一对应，通过DAO层向上传输数据源对象。
    DTO（Data Transfer Object）：数据传输对象，Service或Manager向外传输的对象。
    BO（Business Object）：业务对象，由Service层输出的封装业务逻辑的对象。
    AO（Application Object）：应用对象，在Web层与Service层之间抽象的复用对象模型，极为贴近展示层，复用度不高。
    VO（View Object）：显示层对象，通常是Web向模板渲染引擎层传输的对象。
    Query：数据查询对象，各层接收上层的查询请求。注意超过2个参数的查询封装，禁止使用Map类来传输。

(二) 二方库依赖

   1. 【强制】定义GAV遵从以下规则：
       1） GroupID格式：com.{公司/BU }.业务线 [.子业务线]，最多4级。
           说明：{公司/BU} 例如：alibaba/taobao/tmall/aliexpress等BU一级；子业务线可选。
           正例：com.taobao.jstorm 或 com.alibaba.dubbo.register
       2） ArtifactID格式：产品线名-模块名。语义不重复不遗漏，先到中央仓库去查证一下。
           正例：dubbo-client / fastjson-api / jstorm-tool
       3） Version：详细规定参考下方。

   2. 【强制】二方库版本号命名方式：主版本号.次版本号.修订号
       1）主版本号：产品方向改变，或者大规模API不兼容，或者架构不兼容升级。
       2）次版本号：保持相对兼容性，增加主要功能特性，影响范围极小的API不兼容修改。
       3）修订号：保持完全兼容性，修复BUG、新增次要功能特性等。
       说明：注意起始版本号必须为： 1.0.0，而不是0.0.1 正式发布的类库必须先去中央仓库进行查证，使版本号有延续性，正式版本号不允许覆盖升级。如当前版本：1.3.3，那么下一个合理的版本号：1.3.4 或 1.4.0 或 2.0.0

8. 【推荐】所有pom文件中的依赖声明放在<dependencies>语句块中，所有版本仲裁放在<dependencyManagement>语句块中。
说明：<dependencyManagement>里只是声明版本，并不实现引入，因此子项目需要显式的声明依赖，version和scope都读取自父pom。而<dependencies>所有声明在主pom的<dependencies>里的依赖都会自动引入，并默认被所有的子项目继承。

(三) 服务器

   1. 【推荐】高并发服务器建议调小TCP协议的time_wait超时时间。
       说明：操作系统默认240秒后，才会关闭处于time_wait状态的连接，在高并发访问下，服务器端会因为处于time_wait的连接数太多，可能无法建立新的连接，所以需要在服务器上调小此等待值。
       正例：在linux服务器上请通过变更/etc/sysctl.conf文件去修改该缺省值（秒）：
           net.ipv4.tcp_fin_timeout = 30

   2. 【推荐】调大服务器所支持的最大文件句柄数（File Descriptor，简写为fd）。
       说明：主流操作系统的设计是将TCP/UDP连接采用与文件一样的方式去管理，即一个连接对应于一个fd。主流的linux服务器默认所支持最大fd数量为1024，当并发连接数很大时很
       容易因为fd不足而出现“open too many files”错误，导致新的连接无法建立。
       建议将linux服务器所支持的最大句柄数调高数倍（与服务器的内存数量相关）。

3. 【推荐】给JVM环境参数设置-XX:+HeapDumpOnOutOfMemoryError参数，让JVM碰到OOM场景时输出dump信息。
说明：OOM的发生是有概率的，甚至相隔数月才出现一例，出错时的堆内信息对解决问题非常有帮助。

4. 【推荐】在线上生产环境，JVM的Xms和Xmx设置一样大小的内存容量，避免在GC 后调整堆大小带来的压力。

七、设计规约

8. 【推荐】类在设计与实现时要符合单一原则。
说明：单一原则最易理解却是最难实现的一条规则，随着系统演进，很多时候，忘记了类设计的初衷。

9. 【推荐】谨慎使用继承的方式来进行扩展，优先使用聚合/组合的方式来实现。
说明：不得已使用继承的话，必须符合里氏代换原则，此原则说父类能够出现的地方子类一定能够出现，比如，“把钱交出来”，钱的子类美元、欧元、人民币等都可以出现。

10.【推荐】系统设计时，根据依赖倒置原则，尽量依赖抽象类与接口，有利于扩展与维护。
说明：低层次模块依赖于高层次模块的抽象，方便系统间的解耦。

11.【推荐】系统设计时，注意对扩展开放，对修改闭合。
说明：极端情况下，交付的代码都是不可修改的，同一业务域内的需求变化，通过模块或类的扩展来实现。

12.【推荐】系统设计阶段，共性业务或公共行为抽取出来公共模块、公共配置、公共类、公共方法等，避免出现重复代码或重复配置的情况。
说明：随着代码的重复次数不断增加，维护成本指数级上升。

13. 【推荐】避免如下误解：敏捷开发 = 讲故事 + 编码 + 发布。
说明：敏捷开发是快速交付迭代可用的系统，省略多余的设计方案，摒弃传统的审批流程，但核心关键点上的必要设计和文档沉淀是需要的。
反例：某团队为了业务快速发展，敏捷成了产品经理催进度的借口，系统中均是勉强能运行但像面条一样的代码，可维护性和可扩展性极差，一年之后，不得不进行大规模重构，得不偿失。

14.【参考】系统设计主要目的是明确需求、理顺逻辑、后期维护，次要目的用于指导编码。
说明：避免为了设计而设计，系统设计文档有助于后期的系统维护，所以设计结果需要进行分类归档保存。

15.【参考】设计的本质就是识别和表达系统难点，找到系统的变化点，并隔离变化点。
说明：世间众多设计模式目的是相同的，即隔离系统变化点。

16. 【参考】系统架构设计的目的：
   . 确定系统边界。确定系统在技术层面上的做与不做。
   . 确定系统内模块之间的关系。确定模块之间的依赖关系及模块的宏观输入和输出。
   . 确定指导后续设计与演化的原则。使后续的子系统或模块设计在规定的框架内继续演化。
   . 确定非功能性需求。非功能性需求是指安全性、可用性、可扩展性。

来源：CSDN

作者：云麾_SinnEr

链接：https://blog.csdn.net/aogujianhanjianming/article/details/102683951

标签

常量与变量

大括号

alibaba