-
【强制】代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。
-
【强制】代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。 说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式 也要避免采用。
-
【强制】类名使用 UpperCamelCase 风格，但以下情形例外：DO / BO / DTO / VO / AO / PO / UID 等。
-
【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格，必须遵从 驼峰形式。lower
-
【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。
-
【强制】抽象类命名使用 Abstract 或 Base 开头；异常类命名使用 Exception 结尾；测试类 命名以它要测试的类的名称开始，以 Test 结尾。
-
【强制】类型与中括号紧挨相连来表示数组。
-
【强制】POJO 类中布尔类型的变量，都不要加 is 前缀，否则部分框架解析会引起序列化错误。
说明：定义为基本数据类型
Boolean isDeleted的属性，它的方法也是isDeleted()，RPC 框架在反向解析的时候，“误以为”对应的属性名称是deleted，导致属性获取不到，进而抛出异常。 -
【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用 单数形式，但是类名如果有复数含义，类名可以使用复数形式。
-
【强制】杜绝完全不规范的缩写，避免望文不知义。
-
【推荐】为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词 组合来表达其意。
-
【推荐】如果模块、接口、类、方法使用了设计模式，在命名时需体现出具体模式。
说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计理念。
-
【推荐】接口类中的方法和属性不要加任何修饰符号（
public也不要加），保持代码的简洁 性，并加上有效的 Javadoc 注释。尽量不要在接口里定义变量，如果一定要定义变量，肯定是 与接口方法相关，并且是整个应用的基础常量。 -
接口和实现类的命名有两套规则：
1）【强制】对于 Service 和 Mapper 类，基于 SOA 的理念，暴露出来的服务一定是接口，内部 的实现类用 Impl 的后缀与接口区别。
2） 【推荐】 如果是形容能力的接口名称，取对应的形容词为接口名（通常是–able 的形式）。 正例：AbstractTranslator实现Translatable接口。 -
【参考】枚举类名建议带上 Enum 后缀，枚举成员名称需要全大写，单词间用下划线隔开。
说明：枚举其实就是特殊的类，域成员均为常量，且构造方法被默认强制是私有。
-
【参考】各层命名规约：
A) Service / Mapper 层方法命名规约
1） 获取单个对象的方法用 get 做前缀。 2） 获取多个对象的方法用 list 做前缀，复数形式结尾。 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。
-
【强制】不允许任何魔法值（即未经预先定义的常量）直接出现在代码中。
-
【强制】在
long或者Long赋值时，数值后使用大写的 L，不能是小写的 l，小写容易跟数字 1 混淆，造成误解。说明：
Long a = 2l; 写的是数字的 21，还是Long型的 2? -
【推荐】不要使用一个常量类维护所有常量，要按常量功能进行归类，分开维护。
说明：大而全的常量类，杂乱无章，使用查找功能才能定位到修改的常量，不利于理解和维护。
-
【推荐】常量的复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。
1） 跨应用共享常量：放置在二方库中，通常是 client.jar 中的 constant 目录下。
2） 应用内共享常量：放置在一方库中，通常是子模块中的 constant 目录下。
3） 子工程内部共享常量：即在当前子工程的 constant 目录下。
4） 包内共享常量：即在当前包下单独的 constant 目录下。
5） 类内共享常量：直接在类内部private static final定义。 -
【推荐】如果变量值仅在一个固定范围内变化用
enum类型来定义。说明：如果存在名称之外的延伸属性应使用
enum类型。
-
【强制】大括号的使用约定。如果是大括号内为空，则简洁地写成{}即可，不需要换行；如果是非空代码块则：
1） 左大括号前不换行。
2） 左大括号后换行。
3） 右大括号前换行。
4） 右大括号后还有else等代码则不换行；表示终止的右大括号后必须换行。 -
【强制】左小括号和字符之间不出现空格；同样，右小括号和字符之间也不出现空格；而左大括号前需要空格。详见第 5 条下方正例提示。
-
【强制】
if/for/while/switch/do等保留字与括号之间都必须加空格。 -
【强制】任何二目、三目运算符的左右两边都需要加一个空格。
说明：运算符包括赋值运算符=、逻辑运算符&&、加减乘除符号等。
-
【强制】采用 4 个空格缩进，禁止使用 tab 字符。
说明：如果使用 tab 缩进，必须设置 1 个 tab 为 4 个空格。IDEA 设置 tab 为 4 个空格时，请勿勾选 Use tab character；而在 eclipse 中，必须勾选 insert spaces for tabs。
-
【强制】注释的双斜线与注释内容之间有且仅有一个空格。
-
【强制】单行字符数限制不超过 120 个，超出需要换行，换行时遵循如下原则：
1） 第二行相对第一行缩进 4 个空格，从第三行开始，不再继续缩进，参考示例。
2） 运算符与下文一起换行。
3） 方法调用的点符号与下文一起换行。
4） 方法调用中的多个参数需要换行时，在逗号后进行。
5） 在括号前不要换行。 -
【强制】方法参数在定义和传入时，多个参数逗号后边必须加空格。
-
【强制】IDE 的 text file encoding 设置为 UTF-8; IDE 中文件的换行符使用 Unix 格式，不要使用 Windows 格式。
-
【推荐】单个方法的总行数不超过 80 行。
说明：包括方法签名、结束右大括号、方法内代码、注释、空行、回车及任何不可见字符的总行数不超过 80 行。
-
【推荐】没有必要增加若干空格来使某一行的字符与上一行对应位置的字符对齐。
说明：增加 sb 这个变量，如果需要对齐，则给 a、b、c 都要增加几个空格，在变量比较多的情况下，是非常累赘的事情。
-
【推荐】不同逻辑、不同语义、不同业务的代码之间插入一个空行分隔开来以提升可读性。
说明：任何情形，没有必要插入多个空行进行隔开。
-
【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成本，直接用类名来访问即可。
-
【强制】所有的覆写方法，必须加@Override 注解。
说明：
getObject()与get0bject()的问题。一个是字母的 O，一个是数字的 0，加@Override可以准确判断是否覆盖成功。另外，如果在抽象类中对方法签名进行修改，其实现类会马上编译报错。 -
【强制】相同参数类型，相同业务含义，才可以使用 Java 的可变参数，避免使用
Object。说明：可变参数必须放置在参数列表的最后。（提倡同学们尽量不用可变参数编程）
-
【强制】外部正在调用或者二方库依赖的接口，不允许修改方法签名，避免对接口调用方产生影响。接口过时必须加
@Deprecated注解，并清晰地说明采用的新接口或者新服务是什么。 -
【强制】不能使用过时的类或方法。
说明：
java.net.URLDecoder中的方法decode(String encodeStr)这个方法已经过时，应该使用双参数decode(String source, String encode)。接口提供方既然明确是过时接口，那么有义务同时提供新的接口；作为调用方来说，有义务去考证过时方法的新实现是什么。 -
【强制】Object 的
equals方法容易抛空指针异常，应使用常量或确定有值的对象来调用equals。说明：推荐使用
java.util.Objects#equals（JDK7 引入的工具类） -
【强制】所有的相同类型的包装类对象之间值的比较，全部使用
equals方法比较。说明：对于
Integer var = ?在-128 至 127 范围内的赋值，Integer对象是在IntegerCache.cache产生，会复用已有对象，这个区间内的Integer值可以直接使用==进行判断，但是这个区间之外的所有数据，都会在堆上产生，并不会复用已有对象，这是一个大坑，推荐使用equals方法进行判断。 -
关于基本数据类型与包装数据类型的使用标准如下：
1） 【强制】所有的 POJO 类属性必须使用包装数据类型。
2） 【强制】RPC 方法的返回值和参数必须使用包装数据类型。
3） 【推荐】所有的局部变量使用基本数据类型。说明：POJO 类属性没有初值是提醒使用者在需要使用时，必须自己显式地进行赋值，任何 NPE 问题，或者入库检查，都由使用者来保证。
-
【强制】定义 DO / DTO / VO 等 POJO 类时，不要设定任何属性默认值。
-
【强制】序列化类新增属性时，请不要修改
serialVersionUID字段，避免反序列失败；如果完全不兼容升级，避免反序列化混乱，那么请修改serialVersionUID值。说明：注意
serialVersionUID不一致会抛出序列化运行时异常。 -
【强制】构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在 init 方法中。
-
【强制】POJO 类必须写
toString方法。使用 IDE 中的工具：source> generate toString 时，如果继承了另一个 POJO 类，注意在前面加一下super.toString。说明：在方法执行抛出异常时，可以直接调用 POJO 的
toString()方法打印其属性值，便于排查问题。 -
【强制】禁止在 POJO 类中，同时存在对应属性 xxx 的
isXxx()和getXxx()方法。说明：框架在调用属性 xxx 的提取方法时，并不能确定哪个方法一定是被优先调用到。
-
【推荐】使用索引访问用
String的split方法得到的数组时，需做最后一个分隔符后有无内容的检查，否则会有抛IndexOutOfBoundsException的风险。说明：
String str = "a,b,c,,"; String[] ary = str.split(","); // 预期大于 3，结果是 3 System.out.println(ary.length);
-
【推荐】当一个类有多个构造方法，或者多个同名方法，这些方法应该按顺序放置在一起，便于阅读，此条规则优先于第 16 条规则。
-
【推荐】 类内方法定义的顺序依次是：
公有方法或保护方法>私有方法>getter/setter方法。说明：公有方法是类的调用者和维护者最关心的方法，首屏展示最好；保护方法虽然只是子类关心，也可能是“模板设计模式”下的核心方法；而私有方法外部一般不需要特别关心，是一个黑盒实现；因为承载的信息价值较低，所有 Service 和 Mapper 的
getter/setter方法放在类体最后。 -
【推荐】
setter方法中，参数名称与类成员变量名称一致，this.成员名 = 参数名。在getter/setter方法中，不要增加业务逻辑，增加排查问题的难度。 -
【推荐】循环体内，字符串的连接方式，使用
StringBuilder的append方法进行扩展。说明：下例中，反编译出的字节码文件显示每次循环都会
new出一个StringBuilder对象，然后进行append操作，最后通过toString方法返回String对象，造成内存资源浪费。 -
【推荐】
final可以声明类、成员变量、方法、以及本地变量，下列情况使用final关键字：
1） 不允许被继承的类，如：String类。
2） 不允许修改引用的域对象。
3） 不允许被重写的方法，如：POJO 类的setter方法。
4） 不允许运行过程中重新赋值的局部变量。
5） 避免上下文重复使用一个变量，使用final描述可以强制重新定义一个变量，方便更好地进行重构。 -
【推荐】慎用
Object的clone方法来拷贝对象。说明：对象的
clone方法默认是浅拷贝，若想实现深拷贝需要重写clone方法实现域对象的深度遍历式拷贝。 -
【推荐】类成员与方法访问控制从严：
1） 如果不允许外部直接通过new来创建对象，那么构造方法必须是private。
2） 工具类不允许有public或default构造方法。
3） 类非static成员变量并且与子类共享，必须是protected。
4） 类非static成员变量并且仅在本类使用，必须是private。
5） 类static成员变量如果仅在本类使用，必须是private。
6） 若是static成员变量，考虑是否为final。
7） 类成员方法只供类内部调用，必须是private。
8） 类成员方法只对继承类公开，那么限制为protected。说明：任何类、方法、参数、变量，严控访问范围。过于宽泛的访问范围，不利于模块解耦。
思考：如果是一个
private的方法，想删除就删除，可是一个public的service成员方法或成员变量，删除一下，不得手心冒点汗吗？变量像自己的小孩，尽量在自己的视线内，变量作用域太大，无限制的到处跑，那么你会担心的。
-
【强制】关于
hashCode和equals的处理，遵循如下规则：
1） 只要重写equals，就必须重写hashCode。
2） 因为Set存储的是不重复的对象，依据hashCode和equals进行判断，所以Set存储的对象必须重写这两个方法。
3） 如果自定义对象作为Map的键，那么必须重写hashCode和equals。说明：
String重写了hashCode和equals方法，所以我们可以非常愉快地使用String对象作为 key 来使用。 -
【强制】
ArrayList的subList结果不可强转成ArrayList，否则会抛出ClassCastException异常，即 java.util.RandomAccessSubList cannot be cast to java.util.ArrayList。说明：
subList返回的是ArrayList的内部类SubList，并不是ArrayList而是ArrayList的一个视图，对于SubList子列表的所有操作最终会反映到原列表上。 -
【强制】在
subList场景中，高度注意对原集合元素的增加或删除，均会导致子列表的遍历、增加、删除产生ConcurrentModificationException异常。 -
【强制】使用集合转数组的方法，必须使用集合的
toArray(T[] array)，传入的是类型完全一样的数组，大小就是list.size()。说明：使用
toArray带参方法，入参分配的数组空间不够大时，toArray 方法内部将重新分配内存空间，并返回新数组地址；如果数组元素个数大于实际所需，下标为[ list.size() ]的数组元素将被置为null，其它数组元素保持原值，因此最好将方法入参数组大小定义与集合元素个数一致。 -
【强制】使用工具类
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)也会随之修改。 -
【强制】泛型通配符
<? extends T>来接收返回的数据，此写法的泛型集合不能使用add方法，而<? super T>不能使用get方法，作为接口调用赋值时易出错。说明：扩展说一下 PECS(Producer Extends Consumer Super)原则：第一、频繁往外读取内容的，适合用
<? extends T>。第二、经常往里插入的，适合用<? super T>。 -
【强制】不要在
foreach循环里进行元素的remove/add操作。remove元素请使用Iterator方式，如果并发操作，需要对Iterator对象加锁。说明：以上代码的执行结果肯定会出乎大家的意料，那么试一下把“1”换成“2”，会是同样的结果吗？
-
【强制】在 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比较结果相同。 -
【推荐】集合泛型定义时，在 JDK7 及以上，使用 diamond 语法或全省略。
说明：菱形泛型，即 diamond，直接使用<>来指代前边已经指定的类型。
-
【推荐】集合初始化时，指定集合初始值大小。
说明：
HashMap使用HashMap(int initialCapacity)初始化。 -
【推荐】使用
entrySet遍历Map类集合 KV，而不是keySet方式进行遍历。说明：
keySet其实是遍历了 2 次，一次是转为Iterator对象，另一次是从hashMap中取出key所对应的value。而entrySet只是遍历了一次就把key和value都放到了entry中，效率更高。如果是 JDK8，使用Map.foreach方法。 -
【推荐】高度注意
Map类集合 K / V 能不能存储null值的情况，如下表格：集合类 Key Value Super 说明 Hashtable 不允许为 null 不允许为 null Dictionary 线程安全 ConcurrentHashMap 不允许为 null 不允许为 null AbstractMap 锁分段技术 （JDK8:CAS） TreeMap 不允许为 null 允许为 null AbstractMap 线程不安全 HashMap 允许为 null 允许为 null AbstractMap 线程不安全 -
【参考】合理利用好集合的有序性(sort)和稳定性(order)，避免集合的无序性(unsort)和不稳定性(unorder)带来的负面影响。
说明：有序性是指遍历的结果是按某种比较规则依次排列的。稳定性指集合每次遍历的元素次序是一定的。
-
【参考】利用
Set元素唯一的特性，可以快速对一个集合进行去重操作，避免使用List的contains方法进行遍历、对比、去重操作。
-
【强制】获取单例对象需要保证线程安全，其中的方法也要保证线程安全。
说明：资源驱动类、工具类、单例工厂类都需要注意。
-
【强制】创建线程或线程池时请指定有意义的线程名称，方便出错时回溯。
-
【强制】线程资源必须通过线程池提供，不允许在应用中自行显式创建线程。
说明：使用线程池的好处是减少在创建和销毁线程上所消耗的时间以及系统资源的开销，解决资源不足的问题。如果不使用线程池，有可能造成系统创建大量同类线程而导致消耗完内存或者“过度切换”的问题。
-
【强制】线程池不允许使用
Executors去创建，而是通过ThreadPoolExecutor的方式，这样的处理方式让写的同学更加明确线程池的运行规则，规避资源耗尽的风险。说明：
Executors返回的线程池对象的弊端如下：
1）FixedThreadPool和SingleThreadPool:
允许的请求队列长度为Integer.MAX_VALUE，可能会堆积大量的请求，从而导致 OOM。
2）CachedThreadPool和ScheduledThreadPool:
允许的创建线程数量为Integer.MAX_VALUE，可能会创建大量的线程，从而导致 OOM。 -
【强制】
SimpleDateFormat是线程不安全的类，一般不要定义为static变量，如果定义为 static，必须加锁，或者使用 DateUtils 工具类。说明：如果是 JDK8 的应用，可以使用
Instant代替Date，LocalDateTime代替Calendar，DateTimeFormatter代替SimpleDateFormat，官方给出的解释：simple beautiful strong immutable thread-safe。 -
【强制】高并发时，同步调用应该去考量锁的性能损耗。能用无锁数据结构，就不要用锁；能锁区块，就不要锁整个方法体；能用对象锁，就不要用类锁。
说明：尽可能使加锁的代码块工作量尽可能的小，避免在锁代码块中调用 RPC 方法。
-
【强制】对多个资源、数据库表、对象同时加锁时，需要保持一致的加锁顺序，否则可能会造成死锁。
说明：线程一需要对表 A、B、C 依次全部加锁后才可以进行更新操作，那么线程二的加锁顺序也必须是 A、B、C，否则可能出现死锁。
-
【强制】并发修改同一记录时，避免更新丢失，需要加锁。要么在应用层加锁，要么在缓存加锁，要么在数据库层使用乐观锁，使用 version 作为更新依据。
说明：如果每次访问冲突概率小于 20%，推荐使用乐观锁，否则使用悲观锁。乐观锁的重试次数不得小于 3 次。
-
【强制】多线程并行处理定时任务时，
Timer运行多个TimeTask时，只要其中之一没有捕获抛出的异常，其它任务便会自动终止运行，使用ScheduledExecutorService则没有这个问题。 -
【推荐】使用
CountDownLatch进行异步转同步操作，每个线程退出前必须调用countDown方法，线程执行代码注意catch异常，确保countDown方法被执行到，避免主线程无法执行至await方法，直到超时才返回结果。说明：注意，子线程抛出异常堆栈，不能在主线程
try-catch到。 -
【推荐】避免
Random实例被多线程使用，虽然共享该实例是线程安全的，但会因竞争同一 seed 导致的性能下降。说明：
Random实例包括java.util.Random的实例或者Math.random()的方式。 -
【推荐】在并发场景下，通过双重检查锁（double-checked locking）实现延迟初始化的优化问题隐患(可参考 The "Double-Checked Locking is Broken" Declaration)，推荐解决方案中较为简单一种（适用于 JDK5 及以上版本），将目标属性声明为
volatile型。 -
【参考】
volatile解决多线程内存不可见问题。对于一写多读，是可以解决变量同步问题，但是如果多写，同样无法解决线程安全问题。如果是count++操作，使用如下类实现：AtomicInteger count = new AtomicInteger(); count.addAndGet(1);
如果是 JDK8，推荐使用
LongAdder对象，比AtomicLong性能更好（减少乐观锁的重试次数）。 -
【参考】
HashMap在容量不够进行resize时由于高并发可能出现死链，导致 CPU 飙升，在开发过程中可以使用其它数据结构或加锁来规避此风险。 -
【参考】
ThreadLocal无法解决共享对象的更新问题，ThreadLocal对象建议使用static修饰。这个变量是针对一个线程内所有操作共享的，所以设置为静态变量，所有此类实例共享此静态变量 ，也就是说在类第一次被使用时装载，只分配一块存储空间，所有此类的对象(只要是这个线程内定义的)都可以操控这个变量。
-
【强制】在一个
switch块内，每个case要么通过break/return等来终止，要么注释说明程序将继续执行到哪一个case为止；在一个switch块内，都必须包含一个default语句并且放在最后，即使空代码。 -
【强制】在
if/else/for/while/do语句中必须使用大括号。即使只有一行代码，避免采用单行的编码方式：if (condition) statements; -
【强制】在高并发场景中，避免使用”等于”判断作为中断或退出的条件。
说明：如果并发控制没有处理好，容易产生等值判断被“击穿”的情况，使用大于或小于的区间判断条件来代替。
-
【推荐】表达异常的分支时，少用 if-else 方式，这种方式可以改写成：
if (condition) { ... return obj; } // 接着写 else 的业务逻辑代码;
说明：如果非得使用
if()...else if()...else...方式表达逻辑，【强制】避免后续代码维护困难，请勿超过 3 层。 -
【推荐】除常用方法（如 getXxx / isXxx）等外，不要在条件判断中执行其它复杂的语句，将复杂逻辑判断的结果赋值给一个有意义的布尔变量名，以提高可读性。
说明：很多
if语句内的逻辑相当复杂，阅读者需要分析条件表达式的最终结果，才能明确什么样的条件执行什么样的语句，那么，如果阅读者分析逻辑表达式错误呢？ -
【推荐】循环体中的语句要考量性能，以下操作尽量移至循环体外处理，如定义对象、变量、获取数据库连接，进行不必要的
try-catch操作（这个 try-catch 是否可以移至循环体外）。 -
【推荐】避免采用取反逻辑运算符。
说明：取反逻辑不利于快速理解，并且取反逻辑写法必然存在对应的正向逻辑写法。
-
【推荐】接口入参保护，这种场景常见的是用作批量操作的接口。
-
【参考】下列情形，需要进行参数校验：
1） 调用频次低的方法。
2） 执行时间开销很大的方法。此情形中，参数校验时间几乎可以忽略不计，但如果因为参数错误导致中间执行回退，或者错误，那得不偿失。
3） 需要极高稳定性和可用性的方法。
4） 对外提供的开放接口，不管是 RPC / API / HTTP 接口。
5） 敏感权限入口。 -
【参考】下列情形，不需要进行参数校验：
1） 极有可能被循环调用的方法。但在方法说明里必须注明外部参数检查要求。
2） 底层调用频度比较高的方法。毕竟是像纯净水过滤的最后一道，参数错误不太可能到底层才会暴露问题。一般 Mapper 层与 Service 层都在同一个应用中，部署在同一台服务器中，所以 Mapper 的参数校验，可以省略。
3） 被声明成private只会被自己代码所调用的方法，如果能够确定调用方法的代码传入参数已经做过检查或者肯定不会有问题，此时可以不校验参数。
-
【强制】类、类属性、类方法的注释必须使用 Javadoc 规范，使用
/**内容*/格式，不得使用// xxx方式。说明：在 IDE 编辑窗口中，Javadoc 方式会提示相关注释，生成 Javadoc 可以正确输出相应注释；在 IDE 中，工程调用方法时，不进入方法即可悬浮提示方法、参数、返回值的意义，提高阅读效率。
-
【强制】所有的抽象方法（包括接口中的方法）必须要用 Javadoc 注释、除了返回值、参数、异常说明外，还必须指出该方法做什么事情，实现什么功能。
说明：对子类的实现要求，或者调用注意事项，请一并说明。
-
【强制】所有的类都必须添加创建者和创建日期。
-
【强制】方法内部单行注释，在被注释语句上方另起一行，使用
//注释。方法内部多行注释使用/* */注释，注意与代码对齐。 -
【强制】所有的枚举类型字段必须要有注释，说明每个数据项的用途。
-
【推荐】与其“半吊子”英文来注释，不如用中文注释把问题说清楚。专有名词与关键字保持英文原文即可。
-
【推荐】代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻辑等的修改。
说明：代码与注释更新不同步，就像路网与导航软件更新不同步一样，如果导航软件严重滞后，就失去了导航的意义。
-
【参考】谨慎注释掉代码。在上方详细说明，而不是简单地注释掉。如果无用，则删除。
说明：代码被注释掉有两种可能性：1）后续会恢复此段代码逻辑。2）永久不用。前者如果没有备注信息，难以知晓注释动机。后者建议直接删掉（代码仓库保存了历史代码）。
-
【参考】对于注释的要求：第一、能够准确反应设计思想和代码逻辑；第二、能够描述业务含义，使别的程序员能够迅速了解到代码背后的信息。完全没有注释的大段代码对于阅读者形同天书，注释是给自己看的，即使隔很长时间，也能清晰理解当时的思路；注释也是给继任者看的，使其能够快速接替自己的工作。
-
【参考】好的命名、代码结构是自解释的，注释力求精简准确、表达到位。避免出现注释的一个极端：过多过滥的注释，代码的逻辑一旦修改，修改注释是相当大的负担。
-
【参考】特殊注释标记，请注明标记人与标记时间。注意及时处理这些标记，通过标记扫描，经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。
1） 待办事宜（TODO）:（ 标记人，标记时间，[预计处理时间]）
表示需要实现，但目前还未实现的功能。这实际上是一个 Javadoc 的标签，目前的 Javadoc 还没有实现，但已经被广泛使用。只能应用于类，接口和方法（因为它是一个 Javadoc 标签）。
2） 错误，不能工作（FIXME）:（标记人，标记时间，[预计处理时间]）
在注释中用 FIXME 标记某代码是错误的，而且不能工作，需要及时纠正的情况。
-
【强制】在使用正则表达式时，利用好其预编译功能，可以有效加快正则匹配速度。
说明：不要在方法体内定义：
Pattern pattern = Pattern.compile(“规则”); -
【强制】
velocity调用 POJO 类的属性时，建议直接使用属性名取值即可，模板引擎会自动按规范调用 POJO 的getXxx()，如果是boolean基本数据类型变量（boolean命名不需要加 is 前缀），会自动调用isXxx()方法。说明：注意如果是
Boolean包装类对象，优先调用getXxx()的方法。 -
【强制】后台输送给页面的变量必须加
$!{var}——中间的感叹号。说明：如果
var等于null或者不存在，那么${var}会直接显示在页面上。 -
【强制】注意
Math.random()这个方法返回是double类型，注意取值的范围 0≤x<1（能够取到零值，注意除零异常），如果想获取整数类型的随机数，不要将 x 放大 10 的若干倍然后取整，直接使用Random对象的nextInt或者nextLong方法。 -
【强制】获取当前毫秒数
System.currentTimeMillis(); 而不是new Date().getTime();说明：如果想获取更加精确的纳秒级时间值，使用
System.nanoTime()的方式。在 JDK8 中，针对统计时间等场景，推荐使用Instant类。 -
【推荐】不要在视图模板中加入任何复杂的逻辑。
说明：根据 MVC 理论，视图的职责是展示，不要抢模型和控制器的活。
-
【推荐】任何数据结构的构造或初始化，都应指定大小，避免数据结构无限增长吃光内存。
-
【推荐】及时清理不再使用的代码段或配置信息。
说明：对于垃圾代码或过时配置，坚决清理干净，避免程序过度臃肿，代码冗余。
-
【强制】Java 类库中定义的可以通过预检查方式规避的
RuntimeException异常不应该通过catch的方式来处理，比如：NullPointerException，IndexOutOfBoundsException等等。说明：无法通过预检查的异常除外，比如，在解析字符串形式的数字时，不得不通过
catch NumberFormatException来实现。 -
【强制】异常不要用来做流程控制，条件控制。
说明：异常设计的初衷是解决程序运行中的各种意外情况，且异常的处理效率比条件判断方式要低很多。
-
【强制】
catch时请分清稳定代码和非稳定代码，稳定代码指的是无论如何不会出错的代码。对于非稳定代码的catch尽可能进行区分异常类型，再做对应的异常处理。说明：对大段代码进行
try-catch，使程序无法根据不同的异常做出正确的应激反应，也不利于定位问题，这是一种不负责任的表现。 -
【强制】捕获异常是为了处理它，不要捕获了却什么都不处理而抛弃之，如果不想处理它，请将该异常抛给它的调用者。最外层的业务使用者，必须处理异常，将其转化为用户可以理解的内容。
-
【强制】有
try块放到了事务代码中，catch异常后，如果需要回滚事务，一定要注意手动回滚事务。 -
【强制】
finally块必须对资源对象、流对象进行关闭，有异常也要做try-catch。说明：如果 JDK7 及以上，可以使用
try-with-resources方式。 -
【强制】不要在
finally块中使用return。说明：
finally块中的return返回后方法结束执行，不会再执行try块中的return语句。 -
【强制】捕获异常与抛异常，必须是完全匹配，或者捕获异常是抛异常的父类。
说明：如果预期对方抛的是绣球，实际接到的是铅球，就会产生意外情况。
-
【推荐】方法的返回值可以为
null，不强制返回空集合，或者空对象等，必须添加注释充分说明什么情况下会返回null值。说明：本手册明确防止 NPE 是调用者的责任。即使被调用方法返回空集合或者空对象，对调用者来说，也并非高枕无忧，必须考虑到远程调用失败、序列化失败、运行时异常等场景返回
null的情况。 -
【推荐】防止 NPE，是程序员的基本修养，注意 NPE 产生的场景：
1）返回类型为基本数据类型，return包装数据类型的对象时，自动拆箱有可能产生 NPE。
2） 数据库的查询结果可能为null。
3） 集合里的元素即使isNotEmpty，取出的数据元素也可能为null。
4） 远程调用返回对象时，一律要求进行空指针判断，防止 NPE。
5） 对于 Session 中获取的数据，建议 NPE 检查，避免空指针。
6） 级联调用obj.getA().getB().getC()；一连串调用，易产生 NPE。 -
【推荐】定义时区分
unchecked/checked异常，避免直接抛出 new RuntimeException()，更不允许抛出Exception或者Throwable，应使用有业务含义的自定义异常。推荐业界已定义过的自定义异常，如：MapperException/ServiceException等。 -
【参考】对于公司外的 http / api 开放接口必须使用“错误码”；而应用内部推荐异常抛出；跨应用间 RPC 调用优先考虑使用 Result 方式，封装
isSuccess()方法、“错误码”、“错误简短信息”。说明：关于 RPC 方法返回方式使用 Result 方式的理由：
1）使用抛异常返回方式，调用方如果没有捕获到就会产生运行时错误。
2）如果不加栈信息，只是 new 自定义异常，加入自己的理解的 error message，对于调用端解决问题的帮助不会太多。如果加了栈信息，在频繁调用出错的情况下，数据序列化和传输的性能损耗也是问题。 -
【参考】避免出现重复的代码（Don’t Repeat Yourself），即 DRY 原则。
说明：随意复制和粘贴代码，必然会导致代码的重复，在以后需要修改时，需要修改所有的副本，容易遗漏。必要时抽取共性方法，或者抽象公共类，甚至是组件化。
-
【强制】应用中不可直接使用日志系统（Log4j、Logback）中的 API，而应依赖使用日志框架 SLF4J 中的 API，使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一。
import org.slf4j.Logger; import org.slf4j.LoggerFactory; private static final Logger logger = LoggerFactory.getLogger(Abc.class);
-
【强制】日志文件至少保存 15 天，因为有些异常具备以“周”为频次发生的特点。
-
【强制】应用中的扩展日志（如打点、临时监控、访问日志等）命名方式：appName_logType_logName.log。
logType:日志类型，如stats/monitor/access等；
logName:日志描述。
这种命名的好处：通过文件名就可知道日志文件属于什么应用，什么类型，什么目的，也有利于归类查找。说明：推荐对日志进行分类，如将错误日志和业务日志分开存放，便于开发人员查看，也便于通过日志对系统进行及时监控。
-
【强制】对
trace/debug/info级别的日志输出，必须使用条件输出形式或者使用占位符的方式。说明：
logger.debug("Processing trade with id: " + id + " and symbol: " + symbol);如果日志级别是 warn，上述日志不会打印，但是会执行字符串拼接操作，如果 symbol 是对象，会执行toString()方法，浪费了系统资源，执行了上述操作，最终日志却没有打印。 -
【强制】避免重复打印日志，浪费磁盘空间，务必在 log4j.xml 中设置
additivity = false。 -
【强制】异常信息应该包括两类信息：案发现场信息和异常堆栈信息。如果不处理，那么通过关键字
throws往上抛出。 -
【推荐】谨慎地记录日志。生产环境禁止输出 debug 日志；有选择地输出 info 日志；如果使用 warn 来记录刚上线时的业务行为信息，一定要注意日志输出量的问题，避免把服务器磁盘撑爆，并记得及时删除这些观察日志。
说明：大量地输出无效日志，不利于系统性能提升，也不利于快速定位错误点。记录日志时请思考：这些日志真的有人看吗？看到这条日志你能做什么？能不能给问题排查带来好处？
-
【推荐】可以使用 warn 日志级别来记录用户输入参数错误的情况，避免用户投诉时，无所适从。如非必要，请不要在此场景打出 error 级别，避免频繁报警。
说明：注意日志输出的级别，error 级别只记录系统逻辑出错、异常或者重要的错误信息。
-
【推荐】尽量用英文来描述日志错误信息，如果日志中的错误信息用英文描述不清楚的话使用中文描述即可，否则容易产生歧义。国际化团队或海外部署的服务器由于字符集问题，【强制】使用全英文来注释和描述日志错误信息。
-
【强制】好的单元测试必须遵守 AIR 原则。
说明：单元测试在线上运行时，感觉像空气（AIR）一样并不存在，但在测试质量的保障上，却是非常关键的。好的单元测试宏观上来说，具有自动化、独立性、可重复执行的特点。
- A：Automatic（自动化）
- I：Independent（独立性）
- R：Repeatable（可重复）
-
【强制】单元测试应该是全自动执行的，并且非交互式的。测试用例通常是被定期执行的，执行过程必须完全自动化才有意义。输出结果需要人工检查的测试不是一个好的单元测试。单元测试中不准使用
System.out来进行人肉验证，必须使用assert来验证。 -
【强制】保持单元测试的独立性。为了保证单元测试稳定可靠且便于维护，单元测试用例之间决不能互相调用，也不能依赖执行的先后次序。
-
【强制】单元测试是可以重复执行的，不能受到外界环境的影响。
说明：单元测试通常会被放到持续集成中，每次有代码 check in 时单元测试都会被执行。如果单测对外部环境（网络、服务、中间件等）有依赖，容易导致持续集成机制的不可用。
-
【强制】对于单元测试，要保证测试粒度足够小，有助于精确定位问题。单测粒度至多是类级别，一般是方法级别。
说明：只有测试粒度小才能在出错时尽快定位到出错位置。单测不负责检查跨类或者跨系统的交互逻辑，那是集成测试的领域。
-
【强制】核心业务、核心应用、核心模块的增量代码确保单元测试通过。
说明：新增代码及时补充单元测试，如果新增代码影响了原有单元测试，请及时修正。
-
【强制】单元测试代码必须写在如下工程目录：src/test/java，不允许写在业务代码目录下。
说明：源码构建时会跳过此目录，而单元测试框架默认是扫描此目录。
-
【推荐】单元测试的基本目标：语句覆盖率达到 70%；核心模块的语句覆盖率和分支覆盖率都要达到 100%
说明：在工程规约的应用分层中提到的 Mapper 层，Manager 层，可重用度高的 Service，都应该进行单元测试。
-
【推荐】编写单元测试代码遵守 BCDE 原则，以保证被测试模块的交付质量。
- B：Border，边界值测试，包括循环边界、特殊取值、特殊时间点、数据顺序等。
- C：Correct，正确的输入，并得到预期的结果。
- D：Design，与设计文档相结合，来编写单元测试。
- E：Error，强制错误信息输入（如：非法数据、异常流程、非业务允许输入等），并得到预期的结果。
-
【推荐】对于数据库相关的查询，更新，删除等操作，不能假设数据库里的数据是存在的，或者直接操作数据库把数据插入进去，请使用程序插入或者导入数据的方式来准备数据。
-
【推荐】和数据库相关的单元测试，可以设定自动回滚机制，不给数据库造成脏数据。或者对单元测试产生的数据有明确的前后缀标识。
-
【推荐】对于不可测的代码建议做必要的重构，使代码变得可测，避免为了达到测试要求而书写不规范测试代码。
-
【推荐】在设计评审阶段，开发人员需要和测试人员一起确定单元测试范围，单元测试最好覆盖所有测试用例。
-
【推荐】单元测试作为一种质量保障手段，不建议项目发布后补充单元测试用例，建议在项目提测前完成单元测试。
-
【参考】为了更方便地进行单元测试，业务代码应避免以下情况：
- 构造方法中做的事情过多。
- 存在过多的全局变量和静态方法。
- 存在过多的外部依赖。
- 存在过多的条件语句。
说明：多层条件语句建议使用卫语句、策略模式、状态模式等方式重构。
-
【参考】不要对单元测试存在如下误解：
- 那是测试同学干的事情。本文是开发手册，凡是本文内容都是与开发同学强相关的。
- 单元测试代码是多余的。系统的整体功能与各单元部件的测试正常与否是强相关的。
- 单元测试代码不需要维护。一年半载后，那么单元测试几乎处于废弃状态。
- 单元测试与线上故障没有辩证关系。好的单元测试能够最大限度地规避线上故障。
-
【强制】隶属于用户个人的页面或者功能必须进行权限控制校验。
说明：防止没有做水平权限校验就可随意访问、修改、删除别人的数据，比如查看他人的私信内容、修改他人的订单。
-
【强制】用户敏感数据禁止直接展示，必须对展示数据进行脱敏。
说明：中国大陆个人手机号码显示为:158****9119，隐藏中间 4 位，防止隐私泄露。
-
【强制】用户输入的 SQL 参数严格使用参数绑定或者 METADATA 字段值限定，防止 SQL 注入，禁止字符串拼接 SQL 访问数据库。
-
【强制】用户请求传入的任何参数必须做有效性验证。
说明：忽略参数校验可能导致：
- page size 过大导致内存溢出
- 恶意
order by导致数据库慢查询 - 任意重定向
- SQL 注入
- 反序列化注入
- 正则输入源串拒绝服务 ReDoS
说明：Java 代码用正则来验证客户端的输入，有些正则写法验证普通用户输入没有问题，但是如果攻击人员使用的是特殊构造的字符串来验证，有可能导致死循环的结果。
-
【强制】禁止向 HTML 页面输出未经安全过滤或未正确转义的用户数据。
-
【强制】表单、AJAX 提交必须执行 CSRF 安全验证。
说明：CSRF(Cross-site request forgery)跨站请求伪造是一类常见编程漏洞。对于存在 CSRF 漏洞的应用/网站，攻击者可以事先构造好 URL，只要受害者用户一访问，后台便在用户不知情的情况下对数据库中用户参数进行相应修改。
-
【强制】在使用平台资源，譬如短信、邮件、电话、下单、支付，必须实现正确的防重放的机制，如数量限制、疲劳度控制、验证码校验，避免被滥刷而导致资损。
说明：如注册时发送验证码到手机，如果没有限制次数和频率，那么可以利用此功能骚扰到其它用户，并造成短信平台资源浪费。
-
【推荐】发贴、评论、发送即时消息等用户生成内容的场景必须实现防刷、文本内容违禁词过滤等风控策略。
-
【强制】表达是与否概念的字段，必须使用 is_xxx 的方式命名，数据类型是 unsigned tinyint（1 表示是，0 表示否）。
说明：任何字段如果为非负数，必须是 unsigned。
注意：POJO 类中的任何布尔类型的变量，都不要加 is 前缀，所以，需要在
<resultMap>设置从 is_xxx 到 Xxx 的映射关系。数据库表示是与否的值，使用tinyint类型，坚持 is_xxx 的命名方式是为了明确其取值含义与取值范围。 -
【强制】表名、字段名必须使用小写字母或数字，禁止出现数字开头，禁止两个下划线中间只出现数字。数据库字段名的修改代价很大，因为无法进行预发布，所以字段名称需要慎重考虑。
说明：MySQL 在 Windows 下不区分大小写，但在 Linux 下默认是区分大小写。因此，数据库名、表名、字段名，都不允许出现任何大写字母，避免节外生枝。
-
【强制】表名不使用复数名词。
说明：表名应该仅仅表示表里面的实体内容，不应该表示实体数量，对应于 DO 类名也是单数形式，符合表达习惯。
-
【强制】禁用保留字，如
desc、range、match、delayed等，请参考 MySQL 官方保留字。 -
【强制】主键索引名为 pk_字段名；唯一索引名为 uk_字段名；普通索引名则为 idx_字段名。
说明：pk_ 即
primary key；uk_ 即unique key；idx_ 即index的简称。 -
【强制】小数类型为
decimal，禁止使用float和double。说明：
float和double在存储的时候，存在精度损失的问题，很可能在值的比较时，得到不正确的结果。如果存储的数据范围超过decimal的范围，建议将数据拆成整数和小数分开存储。 -
【强制】如果存储的字符串长度几乎相等，使用
char定长字符串类型。 -
【强制】
varchar是可变长字符串，不预先分配存储空间，长度不要超过 5000，如果存储长度大于此值，定义字段类型为text，独立出来一张表，用主键来对应，避免影响其它字段索引效率。 -
【强制】表必备三字段：id, create_time, update_time。
说明：其中 id 必为主键，类型为
bigint unsigned、单表时自增、步长为 1。create_time,update_time 的类型均为datetime类型，前者现在时表示主动创建，后者过去分词表示被动更新。 -
【推荐】表的命名最好是加上“业务名称_表的作用”。
-
【推荐】库名与应用名称尽量一致。
-
【推荐】如果修改字段含义或对字段表示的状态追加时，需要及时更新字段注释。
-
【推荐】字段允许适当冗余，以提高查询性能，但必须考虑数据一致。冗余字段应遵循：
1）不是频繁修改的字段。
2）不是varchar超长字段，更不能是text字段。 -
【推荐】单表行数超过 500 万行或者单表容量超过 2GB，才推荐进行分库分表。
说明：如果预计三年后的数据量根本达不到这个级别，请不要在创建表时就分库分表。
-
【参考】合适的字符存储长度，不但节约数据库表空间、节约索引存储，更重要的是提升检索速度。
-
【强制】业务上具有唯一特性的字段，即使是多个字段的组合，也必须建成唯一索引。
说明：不要以为唯一索引影响了 insert 速度，这个速度损耗可以忽略，但提高查找速度是明显的；另外，即使在应用层做了非常完善的校验控制，只要没有唯一索引，根据墨菲定律，必然有脏数据产生。
-
【强制】超过三个表禁止
join。需要join的字段，数据类型必须绝对一致；多表关联查询时，保证被关联的字段需要有索引。说明：即使双表
join也要注意表索引、SQL 性能。 -
【强制】在
varchar字段上建立索引时，必须指定索引长度，没必要对全字段建立索引，根据实际文本区分度决定索引长度即可。说明：索引的长度与区分度是一对矛盾体，一般对字符串类型数据，长度为 20 的索引，区分度会高达 90%以上，可以使用
count(distinct left(列名, 索引长度)) / count(*)的区分度来确定。 -
【强制】页面搜索严禁左模糊或者全模糊，如果需要请走搜索引擎来解决。
说明：索引文件具有 B-Tree 的最左前缀匹配特性，如果左边的值未确定，那么无法使用此索引。
-
【推荐】如果有
order by的场景，请注意利用索引的有序性。order by最后的字段是组合索引的一部分，并且放在索引组合顺序的最后，避免出现 file_sort 的情况，影响查询性能。 -
【推荐】利用覆盖索引来进行查询操作，避免回表。
说明：如果一本书需要知道第 11 章是什么标题，会翻开第 11 章对应的那一页吗？目录浏览一下就好，这个目录就是起到覆盖索引的作用。
-
【推荐】利用延迟关联或者子查询优化超多分页场景。
说明：MySQL 并不是跳过 offset 行，而是取 offset+N 行，然后返回放弃前 offset 行，返回 N 行，那当 offset 特别大的时候，效率就非常的低下，要么控制返回的总页数，要么对超过特定阈值的页数进行 SQL 改写。
-
【推荐】SQL 性能优化的目标：至少要达到 range 级别，要求是 ref 级别，如果可以是 consts 最好。
说明：
1）consts 单表中最多只有一个匹配行（主键或者唯一索引），在优化阶段即可读取到数据。
2）ref 指的是使用普通的索引（normal index）。
3）range 对索引进行范围检索。 -
【推荐】建组合索引的时候，区分度最高的在最左边。
说明：存在非等号和等号混合时，在建索引时，请把等号条件的列前置。如：
where c > ? and d = ?那么即使 c 的区分度更高，也必须把 d 放在索引的最前列，即索引 idx_d_c。 -
【推荐】防止因字段类型不同造成的隐式转换，导致索引失效。
-
【参考】创建索引时避免有如下极端误解：
1）宁滥勿缺。认为一个查询就需要建一个索引。
2）宁缺勿滥。认为索引会消耗空间、严重拖慢更新和新增速度。
3）抵制惟一索引。认为业务的惟一性一律需要在应用层通过“先查后插”方式解决。
-
【强制】不要使用
count(列名)或count(常量)来替代count(*)，count(*)是 SQL92 定义的标准统计行数的语法，跟数据库无关，跟NULL和非NULL无关。说明：
count(*)会统计值为NULL的行，而count(列名)不会统计此列为NULL值的行。 -
【强制】
count(distinct col)计算该列除NULL之外的不重复行数，注意count(distinct col1, col2)如果其中一列全为NULL，那么即使另一列有不同的值，也返回为 0。 -
【强制】当某一列的值全是
NULL时，count(col)的返回结果为 0，但sum(col)的返回结果为NULL，因此使用sum()时需注意 NPE 问题。 -
【强制】使用
ISNULL()来判断是否为NULL值。说明：
NULL与任何值的直接比较都为NULL。
1）NULL <> NULL的返回结果是NULL，而不是false。
2）NULL = NULL的返回结果是NULL，而不是true。
3）NULL <> 1的返回结果是NULL，而不是true。 -
【强制】在代码中写分页查询逻辑时，若 count 为 0 应直接返回，避免执行后面的分页语句。
-
【强制】不得使用外键与级联，一切外键概念必须在应用层解决。
说明：以学生和成绩的关系为例，学生表中的 student_id是主键，那么成绩表中的 student_id 则为外键。如果更新学生表中的 student_id，同时触发成绩表中的 student_id 更新，即为级联更新。外键与级联更新适用于单机低并发，不适合分布式、高并发集群；级联更新是强阻塞，存在数据库更新风暴的风险；外键影响数据库的插入速度。
-
【强制】禁止使用存储过程，存储过程难以调试和扩展，更没有移植性。
-
【强制】数据订正（特别是删除、修改记录操作）时，要先 select，避免出现误删除，确认无误才能执行更新语句。
-
【推荐】in 操作能避免则避免，若实在避免不了，需要仔细评估 in 后边的集合元素数量，控制在 1000 个之内。
-
【参考】如果有国际化需要，所有的字符存储与表示，均以 utf-8 编码，注意字符统计函数的区别。
说明：
SELECT LENGTH("轻松工作")； 返回为 12 SELECT CHARACTER_LENGTH("轻松工作")； 返回为 4
如果需要存储表情，那么选择 utf8mb4 来进行存储，注意它与 utf-8 编码的区别。
-
【参考】
TRUNCATE TABLE比DELETE速度快，且使用的系统和事务日志资源少，但TRUNCATE无事务且不触发 trigger，有可能造成事故，故不建议在开发代码中使用此语句。说明：
TRUNCATE TABLE在功能上与不带WHERE子句的DELETE语句相同。
-
【强制】在表查询中，一律不要使用 * 作为查询的字段列表，需要哪些字段必须明确写明。
说明：
1）增加查询分析器解析成本。
2）增减字段容易与resultMap配置不一致。
3）无用字段增加网络消耗，尤其是text类型的字段。 -
【强制】POJO 类的布尔属性不能加 is，而数据库字段必须加 is_，要求在
resultMap中进行字段与属性之间的映射。说明：参见定义 POJO 类以及数据库字段定义规定，在
<resultMap>中增加映射，是必须的。在 MyBatis Generator 生成的代码中，需要进行对应的修改。 -
【强制】不要用
resultClass当返回参数，即使所有类属性名与数据库字段一一对应，也需要定义；反过来，每一个表也必然有一个 POJO 类与之对应。说明：配置映射关系，使字段与 DO 类解耦，方便维护。
-
【强制】sql.xml 配置参数使用：#{}，#param# 不要使用${} 此种方式容易出现 SQL 注入。
-
【强制】iBATIS 自带的 queryForList(String statementName,int start,int size)不推荐使用。
说明：其实现方式是在数据库取到 statementName 对应的SQL语句的所有记录，再通过 subList 取 start,size 的子集合。
-
【强制】不允许直接拿 HashMap 与 Hashtable 作为查询结果集的输出。
说明：
resultClass = "Hashtable"，会置入字段名和属性值，但是值的类型不可控。 -
【强制】更新数据表记录时，必须同时更新记录对应的 gmt_modified 字段值为当前时间。
-
【推荐】不要写一个大而全的数据更新接口。传入为 POJO 类，不管是不是自己的目标更新字段，都进行
update table set c1=value1,c2=value2,c3=value3;这是不对的。执行 SQL 时，不要更新无改动的字段，一是易出错；二是效率低；三是增加 binlog 存储。 -
【参考】
@Transactional事务不要滥用。事务会影响数据库的 QPS，另外使用事务的地方需要考虑各方面的回滚方案，包括缓存回滚、搜索引擎回滚、消息补偿、统计修正等。 -
【参考】
<isEqual>中的compareValue是与属性值对比的常量，一般是数字，表示相等时带上此条件；<isNotEmpty>表示不为空且不为null时执行；<isNotNull>表示不为null值时执行。
-
【强制】 使用 4 个空格做为一个缩进层级，不允许使用 2 个空格或
tab字符。说明：对于非 HTML 标签之间的缩进，比如
script或style标签内容缩进，与script或style标签的缩进同级。 -
【强制】每行不得超过 120 个字符。
说明：过长的代码不容易阅读与维护。但是考虑到 HTML 的特殊性，不做硬性要求。
- 【强制】
class、id必须单词全字母小写，单词间以-分隔，在避免冲突并描述清楚的前提下尽可能短。同项目必须保持风格一致。 - 【强制】
class必须代表相应模块或部件的内容或功能，不得以样式信息进行命名。 - 【强制】元素
id必须保证页面唯一。说明：同一个页面中，不同的元素包含相同的 id，不符合 id 的属性含义。并且使用 document.getElementById 时可能导致难以追查的问题。
- 【强制】同一页面，应避免使用相同的
name与id。说明：IE 浏览器会混淆元素的
id和name属性，document.getElementById可能获得不期望的元素。所以在对元素的id与name属性的命名需要非常小心。一个比较好的实践是，为id和name使用不同的命名法。 - 【强制】禁止为了
hook脚本，创建无样式信息的class。说明：不允许
class只用于让 JavaScript 选择某些元素，class应该具有明确的语义和样式。否则容易导致 CSS class 泛滥。使用id、属性选择作为hook是更好的方式。
-
【强制】标签名必须使用小写字母，单词间以
-分隔。 -
【强制】对于无需自闭合的标签，不允许自闭合。
说明：常见无需自闭合标签有
input、br、img、hr等。 -
【强制】对 HTML5 中规定允许省略的闭合标签，不允许省略闭合标签。
说明：对代码体积要求非常严苛的场景，可以例外。比如：第三方页面使用的投放系统。
-
【强制】标签使用必须符合标签嵌套规则。
说明：比如
div不得置于p中，tbody必须置于table中。详细的标签嵌套规则参见 HTML DTD 中的Elements定义部分。 -
【推荐】HTML 标签的使用应该遵循标签的语义。
说明： 下面是常见标签语义
- p - 段落
- h1,h2,h3,h4,h5,h6 - 层级标题
- strong,em - 强调
- ins - 插入
- del - 删除
- abbr - 缩写
- code - 代码标识
- cite - 引述来源作品的标题
- q - 引用
- blockquote - 一段或长篇引用
- ul - 无序列表
- ol - 有序列表
- dl,dt,dd - 定义列表
-
【推荐】在 CSS 可以实现相同需求的情况下不得使用表格进行布局。
说明：在兼容性允许的情况下应尽量保持语义正确性。对网格对齐和拉伸性有严格要求的场景允许例外，如多列复杂表单。
-
【推荐】 标签的使用应尽量简洁，减少不必要的标签。
-
属性规约：
1）【强制】属性名必须使用小写字母。
2）【强制】属性值必须用双引号包围。
3）【推荐】布尔类型的属性，建议不添加属性值。
4）【推荐】自定义属性建议以 xxx- 为前缀，推荐使用 data-。说明：使用前缀有助于区分自定义属性和标准定义的属性。
-
【强制】使用 HTML5 的
DOCTYPE来启用标准模式，注意使用大写的DOCTYPE。 -
【强制】启用 IE Edge 模式。
-
【强制】在 html 标签上设置正确的
lang = "zh-CN"属性。说明：有助于提高页面的可访问性，如：让语音合成工具确定其所应该采用的发音，令翻译工具确定其翻译语言等。
-
【强制】页面必须使用精简形式，明确指定字符编码。指定字符编码的
<meta charset="UTF-8">必须是head的第一个直接子元素。 -
【推荐】HTML 文件使用无
BOM的UTF-8编码。说明：
UTF-8编码具有更广泛的适应性。BOM在使用程序或工具处理文件时可能造成不必要的干扰。 -
【强制】引入 CSS 时必须指明
rel="stylesheet"。 -
【推荐】引入 CSS 和 JavaScript 时无须指明
type属性。说明：
text/css和text/javascript是type的默认值。 -
【推荐】展现定义放置于外部 CSS 中，行为定义放置于外部 JavaScript 中。
说明：结构-样式-行为的代码分离，对于提高代码的可阅读性和维护性都有好处。
-
【强制】在
head中引入页面需要的所有 CSS 资源。说明：在页面渲染的过程中，新的 CSS 可能导致元素的样式重新计算和绘制，页面闪烁。
-
【强制】JavaScript 放在页面末尾，或采用异步加载。
说明：将
script放在页面中间将阻断页面的渲染。出于性能方面的考虑，如非必要，请遵守此条规约。 -
【参考】移动环境或只针对现代浏览器设计的 Web 应用，如果引用外部资源的 URL 协议部分与页面相同，建议省略协议前缀。
说明：使用 protocol-relative URL 引入 CSS，在 IE7/8 下，会发两次请求。是否使用 protocol-relative URL 应充分考虑页面针对的环境。
-
head 规约：
1）【强制】页面必须包含title标签声明标题。且title必须作为head的直接子元素，并紧随charset声明之后。说明：
title中如果包含ASCII之外的字符，浏览器需要知道字符编码类型才能进行解码，否则可能导致乱码。2）【强制】保证
favicon可访问。说明：在未指定
favicon时，大多数浏览器会请求 Web Server 根目录下的 favicon.ico 。为了保证favicon可访问，避免 404，必须遵循以下两种方法之一：- 在 Web Server 根目录放置 favicon.ico 文件。
- 使用
link指定favicon。
3）【强制】为了对移动设备友好，需指定页面的
viewport。说明：viewport meta tag 可以设置可视区域的宽度和初始缩放大小，避免在移动设备上出现页面展示不正常。
-
图片规约：
1）【强制】禁止img的src取值为空。延迟加载的图片也要增加默认的src。说明：
src取值为空，会导致部分浏览器重新加载一次当前页面。2）【推荐】避免为
img添加不必要的title属性。说明：多余的
title影响看图体验，并且增加了页面尺寸。3）【推荐】为重要图片添加
alt属性。说明：可以提高图片加载失败时的用户体验。
4）【推荐】添加
width和height属性，以避免页面抖动。
5）【推荐】有下载需求的图片采用img标签实现，无下载需求的图片采用 CSS 背景图实现。说明：
- 产品 logo、用户头像、用户产生的图片等有潜在下载需求的图片，以
img形式实现，能方便用户下载。 - 无下载需求的图片，比如：icon、背景、代码使用的图片等，尽可能采用 CSS 背景图实现。
- 产品 logo、用户头像、用户产生的图片等有潜在下载需求的图片，以
-
表单规约:
1）【强制】有文本标题的控件必须使用label标签将其与其标题相关联。说明： 有两种方式：
- 将控件置于
label内。 label的for属性指向控件的id。 推荐使用第一种，减少不必要的id。如果 DOM 结构不允许直接嵌套，则应使用第二种。
2）【强制】使用
button元素时必须指明type属性值。说明：
button元素的默认type为submit，如果被置于form元素中，点击后将导致表单提交。为显示区分其作用方便理解，必须给出type属性。3）【推荐】尽量不要使用按钮类元素的
name属性。说明：由于浏览器兼容性问题，使用按钮的
name属性会带来许多难以发现的问题。4）【推荐】负责主要功能的按钮在 DOM 中的顺序应靠前。
说明：负责主要功能的按钮应相对靠前，以提高可访问性。如果在 CSS 中指定了
float: right则可能导致视觉上主按钮在前，而 DOM 中主按钮靠后的情况。5）【推荐】当使用 JavaScript 进行表单提交时，如果条件允许，应使原生提交功能正常工作。
说明：当浏览器 JS 运行错误或关闭 JS 时，提交功能将无法工作。如果正确指定了
form元素的action属性和表单控件的name属性时，提交仍可继续进行。6）【推荐】在针对移动设备开发的页面时，根据内容类型指定输入框的
type属性。说明：根据内容类型指定输入框类型，能获得能友好的输入体验。
- 将控件置于
-
多媒体规约：
1）【推荐】当在现代浏览器中使用audio以及video标签来播放音频、视频时，应当注意格式。说明： 音频应尽可能覆盖到如下格式：
- MP3
- WAV
- Ogg 视频应尽可能覆盖到如下格式：
- MP4
- WebM
- Ogg
2）【推荐】在支持 HTML5 的浏览器中优先使用
audio和video标签来定义音视频元素。
3）【推荐】使用退化到插件的方式来对多浏览器进行支持。
4）【推荐】只在必要的时候开启音视频的自动播放。
5）【推荐】在object标签内部提供指示浏览器不支持该标签的说明。
- 【推荐】模板代码的缩进优先保证 HTML 代码的缩进规则。
- 【推荐】模板代码应以保证 HTML 单个标签语法的正确性为基本原则。
- 【推荐】在循环处理模板数据构造表格时，若要求每行输出固定的个数，建议先将数据分组，之后再循环输出。
-
【强制】
CSS文件使用无 BOM 的UTF-8编码。说明：
UTF-8编码具有更广泛的适应性。BOM 在使用程序或工具处理文件时可能造成不必要的干扰。 -
【强制】使用 4 个空格做为一个缩进层级，不允许使用 2 个空格 或
tab字符。 -
【强制】
选择器与{之间必须包含空格。 -
【强制】
属性名与之后的:之间不允许包含空格，:与属性值之间必须包含空格。 -
【强制】
列表型属性值书写在单行时，,后必须跟一个空格。 -
【强制】每行不得超过 120 个字符，除非单行不可分割。
说明：常见不可分割的场景为URL超长。
-
【推荐】对于超长的样式，在样式值的
空格处或,后换行，建议按逻辑分组。 -
【强制】当一个
rule包含多个selector时，每个选择器声明必须独占一行。 -
【强制】
>、+、~选择器的两边各保留一个空格。 -
【强制】属性选择器中的值必须用双引号包围。
说明：不允许使用单引号，不允许不使用引号。
-
【强制】属性定义必须另起一行。
-
【强制】属性定义后必须以分号结尾。
-
【强制】如无必要，不得为 id、class 选择器添加类型选择器进行限定。
说明：在性能和维护性上，都有一定的影响。
-
【推荐】选择器的嵌套层级应不大于 3 级，位置靠后的限定条件应尽可能精确。
-
【推荐】在可以使用缩写的情况下，尽量使用属性缩写。
-
【推荐】使用
border/margin/padding等缩写时，应注意隐含值对实际数值的影响，确实需要设置多个方向的值时才使用缩写。说明：
border/margin/padding等缩写会同时设置多个属性的值，容易覆盖不需要覆盖的设定。如某些方向需要继承其他声明的值，则应该分开设置。 -
【强制】 同一 rule set 下的属性在书写时，应按功能进行分组，并以 Formatting Model（布局方式、位置） > Box Model（尺寸） > Typographic（文本相关） > Visual（视觉效果） 的顺序书写，以提高代码的可读性。
说明：
- Formatting Model 相关属性包括：
position/top/right/bottom/left/float/display/overflow等 - Box Model 相关属性包括：
border/margin/padding/width/height等 - Typographic 相关属性包括：
font/line-height/text-align/word-wrap等 - Visual 相关属性包括：
background/color/transition/list-style等
另外，如果包含
content属性，应放在最前面。 - Formatting Model 相关属性包括：
-
【推荐】当元素需要撑起高度以包含内部的浮动元素时，通过对伪类设置
clear或触发 BFC 的方式进行clearfix。尽量不使用增加空标签的方式。说明：触发 BFC 的方式很多，常见的有：
float非noneposition非staticoverflow非visible
另需注意，对已经触发 BFC 的元素不需要再进行 clearfix。
-
【推荐】尽量不使用
!important声明。当需要强制指定样式且不允许任何场景覆盖时，通过标签内联和!important定义样式。说明：必须注意的是，仅在设计上确实不允许任何其它场景覆盖样式时，才使用内联的
!important样式。通常在第三方环境的应用中使用这种方案。下面的z-index章节是其中一个特殊场景的典型样例。 -
【推荐】 将
z-index进行分层，对文档流外绝对定位元素的视觉层级关系进行管理。说明：同层的多个元素，如多个由用户输入触发的 Dialog，在该层级内使用相同的
z-index或递增z-index。
建议每层包含100个z-index来容纳足够的元素，如果每层元素较多，可以调整这个数值。
-
【强制】文本内容必须用双引号包围。
说明：文本类型的内容可能在选择器、属性值等内容中。
-
【强制】当数值为 0 - 1 之间的小数时，省略整数部分的 0。
-
【强制】
url()函数中的路径不加引号。 -
【推荐】
url()函数中的绝对路径可省去协议名。 -
【强制】长度为 0 时须省略单位。 (也只有长度单位可省)
-
【强制】RGB颜色值必须使用十六进制记号形式 #rrggbb。不允许使用 rgb()。
说明：带有 alpha 的颜色信息可以使用
rgba()。使用rgba()时每个逗号后必须保留一个空格。 -
【强制】颜色值可以缩写时，必须使用缩写形式。
-
【强制】颜色值不允许使用命名色值。
-
【推荐】 颜色值中的英文字符采用小写。如不用小写也需要保证同一项目内保持大小写一致。
-
【强制】2D 位置必须同时给出水平和垂直方向的位置。
说明：2D 位置初始值为
0% 0%，但在只有一个方向的值时，另一个方向的值会被解析为center。为避免理解上的困扰，应同时给出两个方向的值。
-
【强制】
font-family属性中的字体族名称应使用字体的英文 Family Name，其中如有空格，须放置在引号中。说明：所谓英文 Family Name，为字体文件的一个元数据，常见名称如下：
字体 操作系统 Family Name 宋体 (中易宋体) Windows SimSun 黑体 (中易黑体) Windows SimHei 微软雅黑 Windows Microsoft YaHei 微软正黑 Windows Microsoft JhengHei 华文黑体 Mac/iOS STHeiti 冬青黑体 Mac/iOS Hiragino Sans GB 文泉驿正黑 Linux WenQuanYi Zen Hei 文泉驿微米黑 Linux WenQuanYi Micro Hei -
【强制】
font-family按「西文字体在前、中文字体在后」、「效果佳 (质量高/更能满足需求) 的字体在前、效果一般的字体在后」的顺序编写，最后必须指定一个通用字体族(serif/sans-serif)。 -
【强制】
font-family不区分大小写，但在同一个项目中，同样的 Family Name 大小写必须统一。 -
【强制】需要在 Windows 平台显示的中文内容，其字号应不小于
12px。说明：由于 Windows 的字体渲染机制，小于
12px的文字显示效果极差、难以辨认。 -
【推荐】需要在 Windows 平台显示的中文内容，不要使用除
normal外的font-style。其他平台也应慎用。说明：由于中文字体没有
italic风格的实现，所有浏览器下都会 fallback 到obilique实现 (自动拟合为斜体)，小字号下 (特别是 Windows 下会在小字号下使用点阵字体的情况下) 显示效果差，造成阅读困难。 -
【强制】
font-weight属性必须使用数值方式描述。说明：CSS 的字重分 100 – 900 共九档，但目前受字体本身质量和浏览器的限制，实际上支持
400和700两档，分别等价于关键词normal和bold。
浏览器本身使用一系列启发式规则来进行匹配，在< 700时一般匹配字体的 Regular 字重，> = 700时匹配 Bold 字重。
但已有浏览器开始支持= 600时匹配 Semibold 字重，故使用数值描述增加了灵活性，也更简短。 -
【推荐】
line-height在定义文本段落时，应使用数值。说明：将
line-height设置为数值，浏览器会基于当前元素设置的font-size进行再次计算。在不同字号的文本段落组合中，能达到较为舒适的行间间隔效果，避免在每个设置了font-size都需要设置line-height。
当line-height用于控制垂直居中时，还是应该设置成与容器高度一致。
- 【强制】使用
transition时应指定transition-property。 - 【推荐】尽可能在浏览器能高效实现的属性上添加过渡和动画。
说明：在可能的情况下应选择这样四种变换：
- transform: translate(npx, npx);
- transform: scale(n);
- transform: rotate(ndeg);
- opacity: 0..1;
典型的，可以使用 translate 来代替 left 作为动画属性。
- 【强制】
Media Query不得单独编排，必须与相关的规则一起定义。 - 【强制】
Media Query如果有多个逗号分隔的条件时，应将每个条件放在单独一行中。 - 【推荐】尽可能给出在高分辨率设备 (Retina) 下效果更佳的样式。
-
【强制】带私有前缀的属性由长到短排列，按冒号位置对齐。
说明：标准属性放在最后，按冒号对齐方便阅读，也便于在编辑器内进行多行编辑。
-
【推荐】需要添加
hack时应尽可能考虑是否可以采用其他方式解决。说明：如果能通过合理的 HTML 结构或使用其他的 CSS 定义达到理想的样式，则不应该使用
hack手段解决问题。通常hack会导致维护成本的增加。 -
【推荐】尽量使用
选择器 hack处理兼容性，而非属性 hack。如果要使用属性 hack，尽量使用简单的属性 hack。说明：尽量使用符合 CSS 语法的
selector hack，可以避免一些第三方库无法识别hack语法的问题。 -
【强制】禁止使用
Expression。
-
【强制】JavaScript 文件使用无 BOM 的
UTF-8编码。说明：
UTF-8编码具有更广泛的适应性。BOM 在使用程序或工具处理文件时可能造成不必要的干扰。 -
【强制】在文件结尾处，保留一个空行。
-
【强制】使用 4 个空格做为一个缩进层级，不允许使用 2 个空格或
tab字符。 -
【强制】
switch下的case和default必须增加一个缩进层级。 -
【强制】二元运算符两侧必须有一个空格，一元运算符与操作对象之间不允许有空格。
-
【强制】用作代码块起始的左花括号
{前必须有一个空格。 -
【强制】
if/else/for/while/function/switch/do/try/catch/finally关键字后，必须有一个空格。 -
【强制】在对象创建时，属性中的
:之后必须有空格，:之前不允许有空格。 -
【强制】函数声明、具名函数表达式、函数调用中，函数名和
(之间不允许有空格。 -
【强制】
,和;前不允许有空格。如果不位于行尾，,和;后必须跟一个空格。 -
【强制】在函数调用、函数声明、括号表达式、属性访问、
if/for/while/switch/catch等语句中，()和[]内紧贴括号部分不允许有空格。 -
【强制】单行声明的数组与对象，如果包含元素，
{}和[]内紧贴括号部分不允许包含空格。说明：声明包含元素的数组与对象，只有当内部元素的形式较为简单时，才允许写在一行。元素复杂的情况，还是应该换行书写。
-
【强制】行尾不得有多余的空格。
-
【强制】每个独立语句结束后必须换行。
-
【强制】每行不得超过 120 个字符。在语句的行长度超过 120 时，根据逻辑条件合理缩进。
说明：超长的不可分割的代码允许例外，比如复杂的正则表达式。长字符串不在例外之列。
-
【强制】运算符处换行时，运算符必须在新行的行首。
-
【强制】在函数声明、函数表达式、函数调用、对象创建、数组创建、
for语句等场景中，不允许在 , 或;前换行。 -
【推荐】不同行为或逻辑的语句集，使用空行隔开，更易阅读。
-
【推荐】对于
if...else...、try...catch...finally等语句，推荐使用在}号后添加一个换行 的风格，使代码层次结构更清晰，阅读性更好。 -
【强制】不得省略语句结束的分号。
-
【强制】在
if/else/for/do/while语句中，即使只有一行，也不得省略块{...}。 -
【强制】函数定义结束不允许添加分号。
-
【强制】
IIFE必须在函数表达式外添加(，非IIFE不得在函数表达式外添加(。说明：
IIFE = Immediately-Invoked Function Expression
额外的(能够让代码在阅读的一开始就能判断函数是否立即被调用，进而明白接下来代码的用途。而不是一直拖到底部才恍然大悟。
- 【强制】代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。
- 【强制】代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。 说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式 也要避免采用。
- 【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格，必须遵从 驼峰形式。
- 【强制】常量 使用 全部字母大写，单词间下划线分隔 的命名方式。
- 【强制】类 使用 UpperCamelCase 风格。
- 【强制】类 的 方法 / 属性 使用 lowerCamelCase 风格。
- 【强制】枚举变量 使用 UpperCamelCase 风格，枚举的属性 使用 全部字母大写，单词间下划线分隔 的命名方式。
- 【强制】命名空间 使用 lowerCamelCase 风格。
- 【强制】由多个单词组成的缩写词，在命名中，根据当前命名法和出现的位置，所有字母的大小写与首字母的大小写保持一致。
- 【强制】类名 使用 名词。
- 【强制】函数名 使用 动宾短语。
- 【强制】
boolean类型的变量使用 is 或 has 开头。
-
【强制】单行注释，必须独占一行。
//后跟一个空格，缩进与下一行被注释说明的代码一致。 -
【推荐】多行注释，避免使用 /.../ 这样的多行注释。有多行注释内容时，使用多个单行注释。
-
【强制】为了便于代码阅读和自文档化，以下内容必须包含以 /**...*/ 形式的块注释中。
- 文件
- namespace
- 类
- 函数或方法
- 类属性
- 事件
- 全局变量
- 常量
- AMD 模块
-
【强制】文档注释前必须空一行。
-
【强制】自文档化的文档说明 what，而不是 how。
-
【强制】类型定义都是以
{开始, 以}结束。说明：常用类型如：
{string},{number},{boolean},{Object},{Function},{RegExp},{Array},{Date}。
类型不仅局限于内置的类型，也可以是自定义的类型。比如定义了一个类 Developer，就可以使用它来定义一个参数和返回值的类型。 -
【强制】对于基本类型
{string},{number},{boolean}，首字母必须小写。类型定义 语法示例 说明 String {string} -- Number {number} -- Boolean {boolean} -- Object {Object} -- Function {Function} -- RegExp {RegExp} -- Array {Array} -- Date {Date} -- 单一类型集合 {Array.<string>} string 类型的数组 多类型 {(number｜boolean)} 可能是 number 类型, 也可能是 boolean 类型 允许为null {?number} 可能是 number, 也可能是 null 不允许为null {!Object} Object 类型, 但不是 null Function类型 {function(number, boolean)} 函数, 形参类型 Function带返回值 {function(number, boolean):string} 函数, 形参, 返回值类型 Promise Promise.<resolveType, rejectType> Promise，成功返回的数据类型，失败返回的错误类型 参数可选 @param {string=} name 可选参数, =为类型后缀 可变参数 @param {...number} args 变长参数, ...为类型前缀 任意类型 {*} 任意类型 可选任意类型 @param {*=} name 可选参数，类型不限 可变任意类型 @param {...*} args 变长参数，类型不限 -
【强制】文件顶部必须包含文件注释，用
@file标识文件说明。 -
【推荐】文件注释中可以用
@author标识开发者信息。说明：开发者信息能够体现开发人员对文件的贡献，并且能够让遇到问题或希望了解相关信息的人找到维护人。通常情况文件在被创建时标识的是创建者。随着项目的进展，越来越多的人加入，参与这个文件的开发，新的作者应该被加入
@author标识。
@author标识具有多人时，原则是按照 责任 进行排序。通常的说就是如果有问题，就是找第一个人应该比找第二个人有效。比如文件的创建者由于各种原因，模块移交给了其他人或其他团队，后来因为新增需求，其他人在新增代码时，添加@author标识应该把自己的名字添加在创建人的前面。
@author中的名字不允许被删除。任何劳动成果都应该被尊重。
业务项目中，一个文件可能被多人频繁修改，并且每个人的维护时间都可能不会很长，不建议为文件增加@author标识。通过版本控制系统追踪变更，按业务逻辑单元确定模块的维护责任人，通过文档与wiki跟踪和查询，是更好的责任管理方式。
对于业务逻辑无关的技术型基础项目，特别是开源的公共项目，应使用 @author 标识。 -
【推荐】命名空间使用
@namespace标识。 -
【推荐】类使用
@class标记类或构造函数。说明：对于使用对象
constructor属性来定义的构造函数，可以使用@constructor来标记。 -
【推荐】使用
@extends标记类的继承信息 -
【强制】使用包装方式扩展类成员时， 必须通过
@lends进行重新指向。说明：没有
@lends标记将无法为该类生成包含扩展类成员的文档 -
【强制】类的属性或方法等成员信息不是
public的，应使用@protected或@private标识可访问性。说明：生成的文档中将有可访问性的标记，避免用户直接使用非
public的属性或方法。 -
【强制】函数/方法注释必须包含函数说明，有参数和返回值时必须使用注释标识。
说明：当
return关键字仅作退出函数/方法使用时，无须对返回值作注释标识。 -
【强制】参数和返回值注释必须包含类型信息，且不允许省略参数的说明。
-
【推荐】当函数是内部函数，外部不可访问时，可以使用
@inner标识。 -
【强制】对 Object 中各项的描述， 必须使用
@param标识。 -
【推荐】重写父类方法时， 应当添加
@override标识。如果重写的形参个数、类型、顺序和返回值类型均未发生变化，可省略@param、@return，仅用@override标识，否则仍应作完整注释。说明：简而言之，当子类重写的方法能直接套用父类的方法注释时可省略对参数与返回值的注释。
-
【强制】必须使用
@event标识事件，事件参数的标识与方法描述的参数标识相同。 -
【强制】在会广播事件的函数前使用
@fires标识广播的事件，在广播事件代码前使用@event标识事件。 -
【推荐】对于事件对象的注释，使用
@param标识，生成文档时可读性更好。 -
【推荐】常量必须使用
@const标记，并包含说明和类型信息。 -
【推荐】对于类型未定义的复杂结构的注释，可以使用
@typedef标识来定义。 -
【强制】AMD 模块使用
@module或@exports标识。说明：
@exports与@module都可以用来标识模块，区别在于@module可以省略模块名称。而只使用@exports时在namepaths中可以省略module:前缀。 -
【强制】对于已使用
@module标识为 AMD模块 的引用，在namepaths中必须增加module:作前缀。说明：
namepaths没有module:前缀时，生成的文档中将无法正确生成链接。 -
【推荐】对于类定义的模块，可以使用
@alias标识构建函数。 -
【推荐】多模块定义时，可以使用
@exports标识各个模块。 -
【推荐】对于
exports为 Object 的模块，可以使用@namespace标识。说明：使用
@namespace而不是@module或@exports时，对模块的引用可以省略module:前缀。 -
【推荐】对于
exports为类名的模块，使用@class和@exports标识。 -
【推荐】细节注释遵循单行注释的格式。说明必须换行时，每行是一个单行注释的起始。
-
【强制】有时我们会使用一些特殊标记进行说明。特殊标记必须使用单行注释的形式。下面列举了一些常用标记：
- TODO: 有功能待实现。此时需要对将要实现的功能进行简单说明。
- FIXME: 该处代码运行没问题，但可能由于时间赶或者其他原因，需要修正。此时需要对如何修正进行简单说明。
- HACK: 为修正某些问题而写的不太好或者使用了某些诡异手段的代码。此时需要对思路或诡异手段进行描述。
- XXX: 该处存在陷阱。此时需要对陷阱进行描述。
-
【强制】变量、函数在使用前必须先定义。
-
【强制】每个
var只能声明一个变量。说明：一个
var声明多个变量，容易导致较长的行长度，并且在修改时容易造成逗号和分号的混淆。 -
【强制】变量必须 即用即声明，不得在函数或其它形式的代码块起始位置统一声明所有变量。
说明：变量声明与使用的距离越远，出现的跨度越大，代码的阅读与维护成本越高。虽然JavaScript的变量是函数作用域，还是应该根据编程中的意图，缩小变量出现的距离空间。
-
【强制】在 Equality Expression 中使用类型严格的
===。仅当判断null或undefined时，允许使用== null。说明：使用
===可以避免等于判断中隐式的类型转换。 -
【推荐】按执行频率排列分支的顺序。
说明：按执行频率排列分支的顺序好处是：
- 阅读的人容易找到最常见的情况，增加可读性。
- 提高执行效率。
-
【推荐】对于相同变量或表达式的多值条件，用
switch代替if。 -
【推荐】如果函数或全局中的
else块后没有任何语句，可以删除else。 -
【推荐】不要在循环体中包含函数表达式，事先将函数提取到循环体外。
说明：循环体中的函数表达式，运行过程中会生成循环次数个函数对象。
-
【推荐】对循环内多次使用的不变值，在循环外用变量缓存。
-
【推荐】对有序集合进行遍历时，缓存
length。说明：虽然现代浏览器都对数组长度进行了缓存，但对于一些宿主对象和老旧浏览器的数组对象，在每次
length访问时会动态计算元素个数，此时缓存length能有效提高程序性能。 -
【推荐】对有序集合进行顺序无关的遍历时，使用逆序遍历。
说明：逆序遍历可以节省变量，代码比较优化。
-
【推荐】类型检测优先使用
typeof。对象类型检测使用instanceof。null或undefined的检测使用== null。 -
【推荐】转换成
string时，使用+ ''。 -
【推荐】转换成
number时，通常使用+。 -
【推荐】
string转换成number，要转换的字符串结尾包含非数字并期望忽略时，使用parseInt。 -
【强制】使用
parseInt时，必须指定进制。 -
【推荐】转换成
boolean时，使用!!。 -
【推荐】
number去除小数点，使用Math.floor/Math.round/Math.ceil，不使用parseInt。 -
【强制】字符串开头和结束使用单引号
'。- 输入单引号不需要按住 shift，方便输入。
- 实际使用中，字符串经常用来拼接 HTML。为方便 HTML 中包含双引号而不需要转义写法。
-
【推荐】使用
数组或+拼接字符串。- 使用 + 拼接字符串，如果拼接的全部是 StringLiteral，压缩工具可以对其进行自动合并的优化。所以，静态字符串建议使用 + 拼接。
- 在现代浏览器下，使用 + 拼接字符串，性能较数组的方式要高。
- 如需要兼顾老旧浏览器，应尽量使用数组拼接字符串。
-
【推荐】使用字符串拼接的方式生成HTML，需要根据语境进行合理的转义。
说明：在 JavaScript 中拼接，并且最终将输出到页面中的字符串，需要进行合理转义，以防止安全漏洞。下面的示例代码为场景说明，不能直接运行。
-
【推荐】复杂的数据到视图字符串的转换过程，选用一种模板引擎。
说明：使用模板引擎有如下好处：
- 在开发过程中专注于数据，将视图生成的过程由另外一个层级维护，使程序逻辑结构更清晰。
- 优秀的模板引擎，通过模板编译技术和高质量的编译产物，能获得比手工拼接字符串更高的性能。
- 模板引擎能方便的对动态数据进行相应的转义，部分模板引擎默认进行HTML转义，安全性更好。
- artTemplate: 体积较小，在所有环境下性能高，语法灵活。
- dot.js: 体积小，在现代浏览器下性能高，语法灵活。
- etpl: 体积较小，在所有环境下性能高，模板复用性高，语法灵活。
- handlebars: 体积大，在所有环境下性能高，扩展性高。
- hogon: 体积小，在现代浏览器下性能高。
- nunjucks: 体积较大，性能一般，模板复用性高。
-
【强制】使用对象字面量
{}创建新Object。 -
【推荐】对象创建时，如果一个对象的所有 属性 均可以不添加引号，建议所有 属性 不添加引号。
-
【推荐】对象创建时，如果任何一个 属性 需要添加引号，则所有 属性 建议添加
'。 -
【强制】不允许修改和扩展任何原生对象和宿主对象的原型。
-
【推荐】属性访问时，尽量使用
.。说明：属性名符合
Identifier的要求，就可以通过.来访问，否则就只能通过[expr]方式访问。
通常在 JavaScript 中声明的对象，属性命名是使用 lowerCamelCase 风格，用 . 来访问更清晰简洁。部分特殊的属性（比如来自后端的 JSON ），可能采用不寻常的命名方式，可以通过[expr]方式访问。 -
【推荐】
for in遍历对象时, 使用hasOwnProperty过滤掉原型中的属性。 -
【推荐】使用数组字面量
[]创建新数组，除非想要创建的是指定长度的数组。 -
【强制】遍历数组不使用
for in。说明：数组对象可能存在数字以外的属性, 这种情况下
for in不会得到正确结果。 -
【推荐】 不因为性能的原因自己实现数组排序功能，尽量使用数组的
sort方法。说明：自己实现的常规排序算法，在性能上并不优于数组默认的 sort 方法。以下两种场景可以自己实现排序：
- 需要稳定的排序算法，达到严格一致的排序结果。
- 数据特点鲜明，适合使用桶排。
-
【推荐】清空数组使用
.length = 0。 -
【强制】一个函数的长度控制在 50 行以内。
说明：将过多的逻辑单元混在一个大函数中，易导致难以维护。一个清晰易懂的函数应该完成单一的逻辑单元。复杂的操作应进一步抽取，通过函数的调用来体现流程。
特定算法等不可分割的逻辑允许例外。 -
【推荐】一个函数的参数控制在 6 个以内。
说明：除去不定长参数以外，函数具备不同逻辑意义的参数建议控制在 6 个以内，过多参数会导致维护难度增大。 某些情况下，如使用 AMD Loader 的
require加载多个模块时，其callback可能会存在较多参数，因此对函数参数的个数不做强制限制。 -
【推荐】通过 options 参数传递非数据输入型参数。
说明：有些函数的参数并不是作为算法的输入，而是对算法的某些分支条件判断之用，此类参数建议通过一个 options 参数传递。
如下函数：/** * 移除某个元素 * * @param {Node} element 需要移除的元素 * @param {boolean} removeEventListeners 是否同时将所有注册在元素上的事件移除 */ function removeElement(element, removeEventListeners) { element.parent.removeChild(element); if (removeEventListeners) { element.clearEventListeners(); } }
可以转换为下面的签名：
/** * 移除某个元素 * * @param {Node} element 需要移除的元素 * @param {Object} options 相关的逻辑配置 * @param {boolean} options.removeEventListeners 是否同时将所有注册在元素上的事件移除 */ function removeElement(element, options) { element.parent.removeChild(element); if (options.removeEventListeners) { element.clearEventListeners(); } }
这种模式有几个显著的优势：
- boolean 型的配置项具备名称，从调用的代码上更易理解其表达的逻辑意义。
- 当配置项有增长时，无需无休止地增加参数个数，不会出现 removeElement(element, true, false, false, 3) 这样难以理解的调用代码。
- 当部分配置参数可选时，多个参数的形式非常难处理重载逻辑，而使用一个 options 对象只需判断属性是否存在，实现得以简化。
-
【推荐】在适当的时候将闭包内大对象置为
null。说明：在 JavaScript 中，无需特别的关键词就可以使用闭包，一个函数可以任意访问在其定义的作用域外的变量。需要注意的是，函数的作用域是静态的，即在定义时决定，与调用的时机和方式没有任何关系。
闭包会阻止一些变量的垃圾回收，对于较老旧的 JavaScript 引擎，可能导致外部所有变量均无法回收。
首先一个较为明确的结论是，以下内容会影响到闭包内变量的回收：- 嵌套的函数中是否有使用该变量。
- 嵌套的函数中是否有 直接调用
eval。 - 是否使用了
with表达式。 Chakra、V8 和 SpiderMonkey 将受以上因素的影响，表现出不尽相同又较为相似的回收策略，而 JScript.dll 和 Carakan 则完全没有这方面的优化，会完整保留整个 LexicalEnvironment 中的所有变量绑定，造成一定的内存消耗。
由于对闭包内变量有回收优化策略的 Chakra、V8 和 SpiderMonkey 引擎的行为较为相似，因此可以总结如下，当返回一个函数fn时： - 如果 fn 的 [[Scope]] 是 ObjectEnvironment（with 表达式生成 ObjectEnvironment，函数和 catch 表达式生成 DeclarativeEnvironment），则：
i. 如果是 V8 引擎，则退出全过程。
ii. 如果是 SpiderMonkey，则处理该 ObjectEnvironment 的外层 LexicalEnvironment。- 获取当前 LexicalEnvironment 下的所有类型为 Function 的对象，对于每一个 Function 对象，分析其 FunctionBody：
i. 如果 FunctionBody 中含有 直接调用 eval，则退出全过程。
ii. 否则得到所有的 Identifier。
iii. 对于每一个 Identifier，设其为 name，根据查找变量引用的规则，从 LexicalEnvironment 中找出名称为 name 的绑定 binding。
iv. 对 binding 添加 notSwap 属性，其值为 true。- 检查当前 LexicalEnvironment 中的每一个变量绑定，如果该绑定有 notSwap 属性且值为 true，则：
i. 如果是 V8 引擎，删除该绑定。
ii. 如果是 SpiderMonkey，将该绑定的值设为 undefined，将删除 notSwap 属性。对于 Chakra 引擎，暂无法得知是按 V8 的模式还是按 SpiderMonkey 的模式进行。
如果有 非常庞大 的对象，且预计会在 老旧的引擎 中执行，则使用闭包时，注意将闭包不需要的对象置为空引用。 -
【推荐】使用
IIFE避免Lift效应。说明：在引用函数外部变量时，函数执行时外部变量的值由运行时决定而非定义时，最典型的场景如下：
var tasks = []; for (var i = 0; i < 5; i++) { tasks[tasks.length] = function () { console.log('Current cursor is at ' + i); }; } var len = tasks.length; while (len--) { tasks[len](); }
以上代码对 tasks 中的函数的执行均会输出 Current cursor is at 5，往往不符合预期。
此现象称为 Lift 效应 。解决的方式是通过额外加上一层闭包函数，将需要的外部变量作为参数传递来解除变量的绑定关系：var tasks = []; for (var i = 0; i < 5; i++) { // 注意有一层额外的闭包 tasks[tasks.length] = (function (i) { return function () { console.log('Current cursor is at ' + i); }; })(i); } var len = tasks.length; while (len--) { tasks[len](); }
-
【推荐】空函数不使用
new Function()的形式。 -
【推荐】对于性能有高要求的场合，建议存在一个空函数的常量，供多处使用共享。
-
【强制】类的继承方案，实现时需要修正
constructor。说明：通常使用其他 library 的类继承方案都会进行
constructor修正。如果是自己实现的类继承方案，需要进行constructor修正。 -
【推荐】声明类时，保证
constructor的正确性。 -
【推荐】属性在构造函数中声明，方法在原型中声明。
说明：原型对象的成员被所有实例共享，能节约内存占用。所以编码时我们应该遵守这样的原则：原型对象包含程序不会修改的成员，如方法函数或配置项。
-
【强制】自定义事件的 事件名 必须全小写。
说明：在 JavaScript 广泛应用的浏览器环境，绝大多数 DOM 事件名称都是全小写的。为了遵循大多数 JavaScript 开发者的习惯，在设计自定义事件时，事件名也应该全小写。
-
【强制】自定义事件只能有一个
event参数。如果事件需要传递较多信息，应仔细设计事件对象。说明：一个事件对象的好处有：
- 顺序无关，避免事件监听者需要记忆参数顺序。
- 每个事件信息都可以根据需要提供或者不提供，更自由。
- 扩展方便，未来添加事件信息时，无需考虑会破坏监听器参数形式而无法向后兼容。
-
【推荐】设计自定义事件时，应考虑禁止默认行为。
说明：常见禁止默认行为的方式有两种：
- 事件监听函数中 return false。
- 事件对象中包含禁止默认行为的方法，如 preventDefault。
-
【强制】避免使用直接
eval函数。说明：直接 eval，指的是以函数方式调用 eval 的调用方法。直接 eval 调用执行代码的作用域为本地作用域，应当避免。
如果有特殊情况需要使用直接 eval，需在代码中用详细的注释说明为何必须使用直接 eval，不能使用其它动态执行代码的方式，同时需要其他资深工程师进行 Code Review。 -
【推荐】尽量避免使用
eval函数。 -
【推荐】使用
new Function执行动态代码。说明：通过
new Function生成的函数作用域是全局使用域，不会影响当当前的本地作用域。如果有动态代码执行的需求，建议使用new Function。 -
【推荐】尽量不要使用
with。说明：使用
with可能会增加代码的复杂度，不利于阅读和管理；也会对性能有影响。大多数使用with的场景都能使用其他方式较好的替代。所以，尽量不要使用with。 -
【推荐】减少
delete的使用。说明：如果没有特别的需求，减少或避免使用
delete。delete的使用会破坏部分 JavaScript 引擎的性能优化。 -
【推荐】处理
delete可能产生的异常。说明：对于有被遍历需求，且值
null被认为具有业务逻辑意义的值的对象，移除某个属性必须使用delete操作。
在严格模式或 IE 下使用delete时，不能被删除的属性会抛出异常，因此在不确定属性是否可以删除的情况下，建议添加try-catch块。 -
【推荐】避免修改外部传入的对象。
说明：JavaScript 因其脚本语言的动态特性，当一个对象未被
seal或freeze时，可以任意添加、删除、修改属性值。
但是随意地对 非自身控制的对象 进行修改，很容易造成代码在不可预知的情况下出现问题。因此，设计良好的组件、函数应该避免对外部传入的对象的修改。
下面代码的selectNode方法修改了由外部传入的datasource对象。如果datasource用在其它场合（如另一个Tree实例）下，会造成状态的混乱。function Tree(datasource) { this.datasource = datasource; } Tree.prototype.selectNode = function (id) { // 从datasource中找出节点对象 var node = this.findNode(id); if (node) { node.selected = true; this.flushView(); } };
对于此类场景，需要使用额外的对象来维护，使用由自身控制，不与外部产生任何交互的
selectedNodeIndex对象来维护节点的选中状态，不对datasource作任何修改。function Tree(datasource) { this.datasource = datasource; this.selectedNodeIndex = {}; } Tree.prototype.selectNode = function (id) { // 从datasource中找出节点对象 var node = this.findNode(id); if (node) { this.selectedNodeIndex[id] = true; this.flushView(); } };
除此之外，也可以通过 · 等手段将自身维护的对象与外部传入的分离，保证不会相互影响。
-
【推荐】具备强类型的设计。
- 如果一个属性被设计为
boolean类型，则不要使用1或0作为其值。对于标识性的属性，如对代码体积有严格要求，可以从一开始就设计为number类型且将0作为否定值。 - 从 DOM 中取出的值通常为
string类型，如果有对象或函数的接收类型为number类型，提前作好转换，而不是期望对象、函数可以处理多类型的值。
- 如果一个属性被设计为
-
【强制】使用 AMD 作为模块定义。
说明：AMD 作为由社区认可的模块定义形式，提供多种重载提供灵活的使用方式，并且绝大多数优秀的 Library 都支持 AMD，适合作为规范。
-
【强制】模块
id必须符合标准。说明：模块
id必须符合以下约束条件：- 类型为
string，并且是由/分割的一系列terms来组成。例如：this/is/a/module。 term应该符合[a-zA-Z0-9_-]+规则。- 不应该有 .js 后缀。
- 跟文件的路径保持一致。
- 类型为
-
【推荐】定义模块时不要指明
id和dependencies。说明：在 AMD 的设计思想里，模块名称是和所在路径相关的，匿名的模块更利于封包和迁移。模块依赖应在模块定义内部通过
local require引用。
所以，推荐使用define(factory)的形式进行模块定义。 -
【推荐】使用
return来返回模块定义。说明：使用
return可以减少factory接收的参数（不需要接收exports和module），在没有 AMD Loader 的场景下也更容易进行简单的处理来伪造一个 Loader。 -
【强制】全局运行环境中，
require必须以async require形式调用。说明：模块的加载过程是异步的，同步调用并无法保证得到正确的结果。
-
【强制】模块定义中只允许使用
local require，不允许使用global require。- 在模块定义中使用
global require，对封装性是一种破坏。 - 在 AMD 里，
global require是可以被重命名的。并且 Loader 甚至没有全局的require变量，而是用 Loader 名称做为global require。模块定义不应该依赖使用的 Loader。
- 在模块定义中使用
-
【强制】 Package 在实现时，内部模块的
require必须使用relative id。说明：对于任何可能通过 发布-引入 的形式复用的第三方库、框架、包，开发者所定义的名称不代表使用者使用的名称。因此不要基于任何名称的假设。在实现源码中，
require自身的其它模块时使用relative id。 -
【推荐】不会被调用的依赖模块，在
factory开始处统一require。说明：有些模块是依赖的模块，但不会在模块实现中被直接调用，最为典型的是
css/js/tpl等 Plugin 所引入的外部内容。此类内容建议放在模块定义最开始处统一引用。 -
【推荐】对于单个元素，尽可能使用
document.getElementById获取，避免使用document.all。 -
【推荐】对于多个元素的集合，尽可能使用
context.getElementsByTagName获取。其中context可以为document或其他元素。指定tagName参数为*可以获得所有子元素。 -
【推荐】遍历元素集合时，尽量缓存集合长度。如需多次操作同一集合，则应将集合转为数组。
说明：原生获取元素集合的结果并不直接引用 DOM 元素，而是对索引进行读取，所以 DOM 结构的改变会实时反映到结果中。
-
【推荐】获取元素的直接子元素时使用
children。避免使用childNodes，除非预期是需要包含文本、注释和属性类型的节点。 -
【推荐】获取元素实际样式信息时，应使用
getComputedStyle或currentStyle。说明：通过
style只能获得内联定义或通过 JavaScript 直接设置的样式。通过 CSS class 设置的元素样式无法直接通过style获取。 -
【推荐】尽可能通过为元素添加预定义的
className来改变元素样式，避免直接操作style设置。 -
【强制】通过
style对象设置元素样式时，对于带单位非0值的属性，不允许省略单位。说明：除了 IE，标准浏览器会忽略不规范的属性值，导致兼容性问题。
-
【推荐】操作 DOM 时，尽量减少页面
reflow。说明：页面
reflow是非常耗时的行为，非常容易导致性能瓶颈。下面一些场景会触发浏览器的reflow：- DOM元素的添加、修改（内容）、删除。
- 应用新的样式或者修改任何影响元素布局的属性。
- Resize 浏览器窗口、滚动页面。
- 读取元素的某些属性（
offsetLeft、offsetTop、offsetHeight、offsetWidth、scrollTop/Left/Width/Height、clientTop/Left/Width/Height、getComputedStyle()、currentStyle(in IE)) 。
-
【推荐】尽量减少 DOM 操作。
说明：DOM 操作也是非常耗时的一种操作，减少 DOM 操作有助于提高性能。举一个简单的例子，构建一个列表。我们可以用两种方式：
- 在循环体中
createElement并append到父元素中。 - 在循环体中拼接 HTML 字符串，循环结束后写父元素的
innerHTML。
第一种方法看起来比较标准，但是每次循环都会对 DOM 进行操作，性能极低。在这里推荐使用第二种方法。
- 在循环体中
-
【推荐】 优先使用
addEventListener/attachEvent绑定事件，避免直接在 HTML 属性中或 DOM 的expando属性绑定事件处理。说明：
expando属性绑定事件容易导致互相覆盖。 -
【推荐】使用
addEventListener时第三个参数使用false。说明：标准浏览器中的
addEventListener可以通过第三个参数指定两种时间触发模型：冒泡和捕获。而 IE 的attachEvent仅支持冒泡的事件触发。所以为了保持一致性，通常addEventListener的第三个参数都为false。 -
【推荐】在没有事件自动管理的框架支持下，应持有监听器函数的引用，在适当时候（元素释放、页面卸载等）移除添加的监听器。
-
【推荐】图中默认上层依赖于下层，箭头关系表示可直接依赖，如：开放接口层可以依赖于 Controller 层，也可以直接依赖于 Service 层，依此类推：
-
开放接口层：可直接封装 Service 方法暴露成 RPC 接口；通过 Web 封装成 http 接口；进行网关安全控制、流量控制等。
-
Controller 层：主要是对访问控制进行转发，各类基本参数校验，或者不复用的业务简单处理等。
-
Service 层：相对具体的业务逻辑服务层。
-
Manager 层：通用业务处理层，它有如下特征：
1） 对第三方平台封装的层，预处理返回结果及转化异常信息； 2） 对 Service 层通用能力的下沉，如缓存方案、中间件通用处理； 3） 与 Mapper 层交互，对多个 Mapper 的组合复用。 -
Mapper 层：数据访问层，与底层 MySQL、Oracle、Hbase 等进行数据交互。
-
外部接口或第三方平台：包括其它部门 RPC 开放接口，基础平台，其它公司的 HTTP 接口。
-
-
【参考】 （分层异常处理规约）在 Mapper 层，产生的异常类型有很多，无法用细粒度的异常进行 catch，使用 catch(Exception e)方式，并 throw new DAOException(e)，不需要打印日志，因为日志在 Manager / Service 层一定需要捕获并打印到日志文件中去，如果同台服务器再打日志，浪费性能和存储。在 Service 层出现异常时，必须记录出错日志到磁盘，尽可能带上参数信息，相当于保护案发现场。如果 Manager 层与 Service 同机部署，日志方式与 Mapper 层处理一致，如果是单独部署，则采用与 Service 一致的处理方式。Controller 层绝不应该继续往上抛异常，因为已经处于顶层，如果意识到这个异常将导致页面无法正常渲染，那么就应该直接跳转到友好错误页面，加上用户容易理解的错误提示信息。开放接口层要将异常处理成错误码和错误信息方式返回。
-
【参考】分层领域模型规约：
- 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 类来传输。
-
【强制】定义 GAV 遵从以下规则：
1） GroupID 格式：com.{公司/BU }.业务线 [.子业务线]，最多 4 级。说明：{公司/BU} 例如：alibaba/taobao/tmall/aliexpress 等 BU 一级；子业务线可选。
2） ArtifactID 格式：产品线名-模块名。语义不重复不遗漏，先到中央仓库去查证一下。
3） Version：详细规定参考下方。 -
【强制】二方库版本号命名方式：主版本号.次版本号.修订号
1） 主版本号：产品方向改变，或者大规模 API 不兼容，或者架构不兼容升级。
2） 次版本号：保持相对兼容性，增加主要功能特性，影响范围极小的 API 不兼容修改。
3） 修订号：保持完全兼容性，修复 BUG、新增次要功能特性等。说明：注意起始版本号必须为：1.0.0，而不是 0.0.1 正式发布的类库必须先去中央仓库进行查证，使版本号有延续性，正式版本号不允许覆盖升级。如当前版本：1.3.3，那么下一个合理的版本号：1.3.4 或 1.4.0 或 2.0.0
-
【强制】线上应用不要依赖 SNAPSHOT 版本（安全包除外）。
说明：不依赖 SNAPSHOT 版本是保证应用发布的幂等性。另外，也可以加快编译时的打包构建。
-
【强制】二方库的新增或升级，保持除功能点之外的其它 jar 包仲裁结果不变。如果有改变，必须明确评估和验证，建议进行 dependency:resolve 前后信息比对，如果仲裁结果完全不一致，那么通过 dependency:tree 命令，找出差异点，进行
<excludes>排除 jar 包。 -
【强制】二方库里可以定义枚举类型，参数可以使用枚举类型，但是接口返回值不允许使用枚举类型或者包含枚举类型的 POJO 对象。
-
【强制】依赖于一个二方库群时，必须定义一个统一的版本变量，避免版本号不一致。
说明：依赖 springframework-core,-context,-beans，它们都是同一个版本，可以定义一个变量来保存版本：${spring.version}，定义依赖的时候，引用该版本。
-
【强制】禁止在子项目的 pom 依赖中出现相同的 GroupId，相同的 ArtifactId，但是不同的 Version。
说明：在本地调试时会使用各子项目指定的版本号，但是合并成一个 war，只能有一个版本号出现在最后的 lib 目录中。可能出现线下调试是正确的，发布到线上却出故障的问题。
-
【推荐】所有 pom 文件中的依赖声明放在
<dependencies>语句块中，所有版本仲裁放在<dependencyManagement>语句块中。说明：
<dependencyManagement>里只是声明版本，并不实现引入，因此子项目需要显式的声明依赖，version 和 scope 都读取自父 pom。而<dependencies>所有声明在主 pom 的<dependencies>里的依赖都会自动引入，并默认被所有的子项目继承。 -
【推荐】二方库不要有配置项，最低限度不要再增加配置项。
-
【参考】为避免应用二方库的依赖冲突问题，二方库发布者应当遵循以下原则：
1）精简可控原则。移除一切不必要的 API 和依赖，只包含 Service API、必要的领域模型对象、Utils 类、常量、枚举等。如果依赖其它二方库，尽量是 provided 引入，让二方库使用者去依赖具体版本号；无 log 具体实现，只依赖日志框架。
2）稳定可追溯原则。每个版本的变化应该被记录，二方库由谁维护，源码在哪里，都需要能方便查到。除非用户主动升级版本，否则公共二方库的行为不应该发生变化。
-
【推荐】高并发服务器建议调小 TCP 协议的 time_wait 超时时间。
说明：操作系统默认 240 秒后，才会关闭处于 time_wait 状态的连接，在高并发访问下，服务器端会因为处于 time_wait 的连接数太多，可能无法建立新的连接，所以需要在服务器上调小此等待值。
-
【推荐】调大服务器所支持的最大文件句柄数（File Descriptor，简写为 fd）。
说明：主流操作系统的设计是将 TCP/UDP 连接采用与文件一样的方式去管理，即一个连接对应于一个 fd。主流的 linux 服务器默认所支持最大 fd 数量为 1024，当并发连接数很大时很容易因为 fd 不足而出现“open too many files”错误，导致新的连接无法建立。 建议将 linux 服务器所支持的最大句柄数调高数倍（与服务器的内存数量相关）。
-
【推荐】给 JVM 环境参数设置
-XX:+HeapDumpOnOutOfMemoryError参数，让 JVM 碰到 OOM 场景时输出 dump 信息。说明：OOM 的发生是有概率的，甚至相隔数月才出现一例，出错时的堆内信息对解决问题非常有帮助。
-
【推荐】在线上生产环境，JVM 的 Xms 和 Xmx 设置一样大小的内存容量，避免在 GC 后调整堆大小带来的压力。
-
【参考】服务器内部重定向使用 forward；外部重定向地址使用 URL 拼装工具类来生成，否则会带来 URL 维护不一致的问题和潜在的安全风险。