006 - Java编约规范

_name / __name / $name / name_ / name$ / name__

更不允许直接使用中文的方式。

纯拼音命名方式更要避免采用

renminbi / alibaba / taobao / youku / hangzhou 等国际通用的名称，可视同英文。

DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3

日本人 / 印度人 / blockList / allowList / secondary

RIBENGUIZI / Asan / blackList / whiteList / slave

以下情形例外：DO / BO / DTO / VO / AO / PO / UID等。

（UpperCamelCase）

类名使用 UpperCamelCase 风格

JavaServerlessPlatform / UserDO / XmlService / TcpUdpDeal / TaPromotion

javaserverlessplatform / UserDo / XMLService / TCPUDPDeal / TAPromotion

统一使用 lowerCamelCase 风格

（LowerCamelCase）

包括方法名、参数名、成员变量、局部变量

localValue / getHttpMessage() / inputUserId

做到语义表达完整清楚，不要嫌名字长。

MAX_STOCK_COUNT / CACHE_EXPIRED_TIME

MAX_COUNT / EXPIRED_TIME

使用Abstract或Base开头

使用Exception结尾

以它要测试的类的名称开始，以Test结尾。

定义整形数组int[] arrayDemo;

public static void main(String[] args) {

在main参数中，使用String args[]来定义。

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

MySQL规约中的建表约定：表达是与否的值采用is_xxx的命名方式

需要在<resultMap>设置从is_xxx到xxx的映射关系。

定义为基本数据类型Boolean isDeleted的属性，它的方法也是isDeleted()

RPC框架（如Dubbo）反向解析时，“误以为”对应的属性名称是deleted，导致属性获取不到，进而抛出异常。

包名统一使用小写

点分隔符之间有且仅有一个自然语义的英语单词

包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。

（此规则参考spring的框架结构）

应用工具类包名为com.alibaba.ai.util

、类名为MessageUtils

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

避免1：

避免2：

避免3：

参见案例代码

避免望文不知义

随意缩写严重降低了代码的可阅读性

AbstractClass“缩写”命名成AbsClass；

condition“缩写”命名成 condi

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

在JDK中，表达原子更新的类名为：AtomicReferenceFieldUpdater。

int a的随意命名方式。

在常量与变量的命名时，表示类型的名词放在词尾，以提升辨识度。

startTime / workQueue / nameList / TERMINATED_THREAD_COUNT

startedAt / QueueOfWork / listName / COUNT_TERMINATED_THREAD

如果模块、接口、类、方法使用了设计模式，在命名时需体现出具体模式。

将设计模式体现在名字中，有利于阅读者快速理解架构设计理念。

public class OrderFactory;

public class LoginProxy;

public class ResourceObserver;

接口类中的方法和属性不要加任何修饰符号（public 也不要加），

保持代码的简洁性，并加上有效的Javadoc注释。

尽量不要在接口里定义变量，如果一定要定义变量，肯定是与接口方法相关，并且是整个应用的基础常量。

DK8中接口允许有默认实现，那么这个default方法，是对所有实现类都有价值的默认实现。

接口方法签名

接口基础常量

接口方法定义 public abstract void f();

说明

正例

说明

正例

枚举类名带上Enum后缀，枚举成员名称需要全大写，单词间用下划线隔开。

枚举其实就是特殊的类，域成员均为常量，且构造方法被默认强制是私有。

枚举名字为ProcessStatusEnum的成员名称：SUCCESS / UNKNOWN_REASON。

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

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

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

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

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

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

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

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

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

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

魔法值（即未经预先定义的常量）

String key = "Id#taobao_" + tradeId; 
cache.put(key, value);

缓存get时，由于在代码复制时，漏掉下划线，导致缓存击穿，而出现问题

在long或者Long赋值时，数值后使用大写的L，不能是小写的l

小写容易跟数字1混淆，造成误解。

Long a = 2l; 写的是数字的21，还是Long型的2。

不要使用一个常量类维护所有常量，要按常量功能进行归类，分开维护。

大而全的常量类，杂乱无章，使用查找功能才能定位到修改的常量，不利于理解和维护。

缓存相关常量放在类CacheConsts下；

系统配置相关常量放在类ConfigConsts下。

放置在二方库中

通常是client.jar中的constant目录下。

放置在一方库中

通常是子模块中的constant目录下

反例

即在当前子工程的constant目录下。

即在当前包下单独的constant目录下。

直接在类内部private static final定义。

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

如果存在名称之外的延伸属性，应使用enum类型

下面正例中的数字就是延伸信息，表示一年中的第几个季节。

1） 左大括号前不换行

2） 左大括号后换行 

左大括号前加空格且不换行；左大括号后换行

3） 右大括号前换行

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

右大括号前换行，右大括号后有else，不用换行

在右大括号后直接结束，则必须换行

左小括号和字符之间不出现空格

右小括号和字符之间也不出现空格

左大括号前需要空格

右大括号前换行，右大括号后有else，不用换行

if (flag == 0) {

括号内的f与左括号，0与右括号不需要空格

if (空格a == b空格)

关键词if与括号之间必须有一个空格

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

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

如果使用tab缩进，必须设置1个tab为4个空格。

IDEA中，设置tab为4个空格时，请勿勾选Use tab character

Eclipse中，设置tab为4个空格时，必须勾选insert spaces for tabs。

// 这是示例注释，请注意在双斜线之后有一个空格
String param = new String();

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

long first = 1000000000000L; 

int second = (int)first + 2;

1）第二行相对第一行缩进4个空格，从第三行开始，不再继续缩进，参考示例。 

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

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

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

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

StringBuilder sb = new StringBuilder();
// 超过120个字符的情况下，换行缩进4个空格，点号和方法名称一起换行
sb.append("Jack").append("Ma")...
    .append("alibaba")...
    .append("alibaba")...
    .append("alibaba");

StringBuilder sb = new StringBuilder();
// 超过120个字符的情况下，不要在括号前换行
sb.append("Jack").append("Ma")...append
("alibaba");

// 参数很多的方法调用可能超过120个字符，不要在逗号前换行
method(args1, args2, args3, ...
, argsX);

下例中实参的args1，后边必须要有一个空格。
method(args1, args2, args3);

使用Unix格式，不要使用Windows格式。

设置为UTF-8

除注释之外的方法签名、左右大括号、方法内代码、空行、回车及任何不可见字符的总行数不超过80行。

代码逻辑分清红花和绿叶，个性和共性，绿叶逻辑单独出来成为额外方法，使主干代码更加清晰

共性逻辑抽取成为共性方法，便于复用和维护。

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

增加sb这个变量，如果需要对齐，则给one、two、three都要增加几个空格

在变量比较多的情况下，是非常累赘的事情

int one = 1;
long two = 2L;
float three = 3F;
StringBuilder sb = new StringBuilder();

任何情形，没有必要插入多个空行进行隔开。

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

避免通过一个类的对象引用访问此类的静态变量或静态方法

无谓增加编译器解析成本，直接用类名来访问即可。

getObject()与get0bject()的问题。一个是字母的O，一个是数字的0，加@Override可以准确判断是否覆盖成功。

另外，如果在抽象类中对方法签名进行修改，其实现类会马上编译报错。

相同参数类型，相同业务含义，才可以使用Java的可变参数，避免使用Object。

可变参数必须放置在参数列表的最后。

（提倡同学们尽量不用可变参数编程）

public List<User> listUsers(String type, Long... ids) {...}

外部正在调用或者二方库依赖的接口，不允许修改方法签名，避免对接口调用方产生影响。

接口过时必须加@Deprecated注解，并清晰地说明采用的新接口或者新服务是什么。

java.net.URLDecoder 中的方法decode(String encodeStr) 这个方法已经过时，应该使用双参数decode(String source, String encode)。

接口提供方既然明确是过时接口，那么有义务同时提供新的接口

作为调用方来说，有义务去考证过时方法的新实现是什么

推荐使用java.util.Objects#equals（JDK7引入的工具类）。

Object的equals方法容易抛空指针异常

应使用常量或确定有值的对象来调用equals。

"test".equals(object);

object.equals("test");

对于Integer var = ? 在-128至127范围内的赋值

Integer对象是在 IntegerCache.cache产生，会复用已有对象

这个区间内的Integer值可以直接使用==进行判断

但是这个区间之外的所有数据，都会在堆上产生，并不会复用已有对象

这是一个大坑，推荐使用equals方法进行判断。

包装类对象比较（==和equals）

浮点数之间的等值判断，基本数据类型不能用==来比较

包装数据类型不能用equals来判断

(1) 指定一个误差范围，两个浮点数的差值在此范围之内，则认为是相等的。

(2) 使用BigDecimal来定义值，再进行浮点数的运算操作。

float a = 1.0F - 0.9F;
float b = 0.9F - 0.8F;
if (a == b) {
// 预期进入此代码块，执行其它业务逻辑
// 但事实上a==b的结果为false
}
Float x = Float.valueOf(a);
Float y = Float.valueOf(b);
if (x.equals(y)) {
// 预期进入此代码块，执行其它业务逻辑
// 但事实上equals的结果为false
}

数据库字段的bigint必须与类属性的Long类型相对应。

某个案例的数据库表id字段定义类型bigint unsigned，实际类对象属性为Integer

随着id越来越大，超过Integer的表示范围而溢出成为负数。

定义数据对象DO类时，属性类型要与数据库字段类型相匹配。

为了防止精度损失，禁止使用构造方法BigDecimal(double)的方式把double值转化为BigDecimal对象。

构造方法的方式BigDecimal(double)存在精度损失风险

在精确计算或值比较的场景中，可能会导致业务逻辑异常。

如：BigDecimal g = new BigDecimal(0.1f); 实际的存储值为：0.10000000149

优先推荐入参为String的构造方法，或使用BigDecimal的valueOf方法

方法内部其实执行了Double的toString，而Double的toString按double的实际能表达的精度对尾数进行了截断。

BigDecimal recommend1 = new BigDecimal("0.1"); 
BigDecimal recommend2 = BigDecimal.valueOf(0.1);

POJO类属性没有初值，是提醒使用者在需要使用时，必须自己显式地进行赋值

任何NPE问题，或者入库检查，都由使用者来保证。

数据库的查询结果可能是null

因为自动拆箱，用基本数据类型接收有NPE风险（空指针）。

比如显示成交总额涨跌情况，即正负x%，x为基本数据类型

调用的RPC服务，调用不成功时，返回的是默认值，页面显示为0%，这是不合理的，应该显示成中划线。

所以包装数据类型的null值，能够表示额外的信息，如：远程调用失败，异常退出。

序列化类，新增属性时，请不要修改serialVersionUID字段，避免反序列失败；

如果完全不兼容升级，避免反序列化混乱，请修改serialVersionUID值。

serialVersionUID不一致，会抛出序列化运行时异常。

POJO类包括DO/DTO/VO等

POJO类的createTime默认值为new Date()

但是这个属性在数据提取时，并没有置入具体值

在更新其它字段时又附带更新了此字段，导致创建时间被修改成当前时间。

框架在调用属性xxx的提取方法时，并不能确定哪个方法一定是被优先调用到。

在方法执行抛出异常时，可以直接调用POJO的toString()方法打印其属性值，便于排查问题。

使用IDE中的工具：source> generate toString时

如果继承了另一个POJO类，注意在前面加一下super.toString。

public Integer getData() {
  if (condition) {
    return this.data + 100;
  } else {
    return this.data - 100;
  }
}

setter方法中，参数名称与类成员变量名称一致，this.成员名 = 参数名。

在getter/setter方法中，不要增加业务逻辑，增加排查问题的难度。

使用索引访问用String的split方法得到的数组时，需做最后一个分隔符后有无内容的检查

否则会有抛IndexOutOfBoundsException的风险。

String str = "a,b,c,,";
String[] ary = str.split(",");
// 预期大于3，结果是3
System.out.println(ary.length);

当一个类有多个构造方法，或者多个同名方法，这些方法应该按顺序放置在一起

便于阅读

此条规则优先于下一条。

公有方法是类的调用者和维护者最关心的方法，首屏展示最好；

保护方法虽然只是子类关心，也可能是“模板设计模式”下的核心方法；

而私有方法外部一般不需要特别关心，是一个黑盒实现；

因为承载的信息价值较低，所有Service和DAO的getter/setter方法放在类体最后。

循环体内，字符串的连接方式，使用StringBuilder的append方法进行扩展。

下例中，反编译出的字节码文件显示每次循环都会new出一个StringBuilder对象，然后进行append操作

最后通过toString方法返回String对象，造成内存资源浪费。

String str = "start";
for (int i = 0; i < 100; i++) {
     str = str + "hello";
}

1） 不允许被继承的类，如：String类。

2） 不允许修改引用的域对象。 

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

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

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

对象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成员方法或成员变量，删除一下，不得手心冒点汗吗？

变量像自己的小孩，尽量在自己的视线内，变量作用域太大，无限制的到处跑，那么你会担心的。

日期格式化时

yyyy 表示当天所在的年

而大写的 YYYY 代表是 week in which year（ JDK7 之后引入的概念）

意思是当天所在的周属于的年份，一周从周日开始，周六结束，只要本周跨年，返回的 YYYY就是下一年。

表示日期和时间的格式如下所示：

new SimpleDateFormat("yyyy-MM-dd HH:mm:ss")

日期格式中的这两对字母表意如下：

大写的 M 和小写的 m，大写的 H 和小写的 h

1） 表示月份是大写的 M；
2） 表示分钟则是小写的 m；
3） 24 小时制的是大写的 H；
4） 12 小时制的则是小写的 h。

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

如果想获取更加精确的纳秒级时间值，使用 System.nanoTime 的方式。

在 JDK8 中，针对统计时间等场景，推荐使用 Instant 类。

不记录时间， getHours()抛出异常

不记录日期， getYear()抛出异常

在构造方法 super((time/1000)*1000)， 在 Timestamp 属性 fastTime 和 nanos 分别存储秒和纳秒信息。

 java.util.Date.after(Date)进行时间比较时，

当入参是 java.sql.Timestamp 时，会触发 JDKBUG(JDK9 已修复)，可能导致比较时的意外结果。

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

// 第一种情况：在闰年 366 天时，出现数组越界异常
int[] dayArray = new int[365];
// 第二种情况：一年有效期的会员制，今年 1 月 26 日注册，硬编码 365 返回的却是 1 月 25 日
Calendar calendar = Calendar.getInstance();
calendar.set(2020, 1, 26);
calendar.add(Calendar.DATE, 365);

参考 JDK 原生注释， Month value is 0-based. e.g., 0 for January.

Calendar.JANUARY， Calendar.FEBRUARY， Calendar.MARCH 等来指代相应月份来进行传参或比较

String已覆写hashCode和equals方法，所以可以使用String对象作为key来使用。

在某些集合中，前者的时间复杂度为 O(1)，而且可读性更好。

Map<String, Object> map = new HashMap<>(16);
if(map.isEmpty()) {
         System.out.println("no element in this map.");
}

参数mergeFunction的作用是当出现key重复时，自定义对value的处理策略。

List<Pair<String, Double>> pairArrayList = new ArrayList<>(3);
pairArrayList.add(new Pair<>("version", 12.10));
pairArrayList.add(new Pair<>("version", 12.19));
pairArrayList.add(new Pair<>("version", 6.28));
Map<String, Double> map = pairArrayList.stream().collect(
// 生成的map集合中只有一个键值对：{version=6.28}
Collectors.toMap(Pair::getKey, Pair::getValue, (v1, v2) -> v2));

String[] departments = new String[] {"iERP", "iERP", "EIBU"};
// 抛出IllegalStateException异常
Map<Integer, String> map = Arrays.stream(departments)
.collect(Collectors.toMap(String::hashCode, str -> str));

在java.util.HashMap的merge方法里会进行如下的判断：

if (value == null || remappingFunction == null)
throw new NullPointerException();

List<Pair<String, Double>> pairArrayList = new ArrayList<>(2);
pairArrayList.add(new Pair<>("version1", 8.3));
pairArrayList.add(new Pair<>("version2", null));
Map<String, Double> map = pairArrayList.stream().collect(
// 抛出NullPointerException异常
Collectors.toMap(Pair::getKey, Pair::getValue, (v1, v2) -> v2));

ArrayList的subList结果不可强转成ArrayList，否则会抛出 ClassCastException异常

ClassCastException异常，即java.util.RandomAccessSubList cannot be cast to java.util.ArrayList。

subList 返回的是ArrayList的内部类SubList，并不是 ArrayList而是ArrayList 的一个视图，对于SubList子列表的所有操作最终会反映到原列表上。

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

如果查询无结果，返回Collections.emptyList()空集合对象，调用方一旦进行了添加元素的操作，就会触发UnsupportedOperationException异常。

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

传入的是类型完全一致、长度为0的空数组。

使用集合转数组的方法，必须使用集合的toArray(T[] array)

使用toArray带参方法，数组空间大小的length：

List<String> list = new ArrayList<>(2);
list.add("guan");
list.add("bao");
String[] array = list.toArray(new String[0]);

直接使用toArray无参方法存在问题，此方法返回值只能是Object[]类

若强转其它类型数组将出现ClassCastException错误。

在ArrayList#addAll方法的第一行代码即Object[] a = c.toArray(); 

其中c为输入集合参数，如果为null，则直接抛出异常。

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

使用工具类Arrays.asList()把数组转换成集合时，不能使用其修改集合相关的方法（add/remove/clear方法）

会抛出UnsupportedOperationException异常。

asList的返回对象是一个Arrays内部类，并没有实现集合的修改方法。

Arrays.asList体现的是适配器模式，只是转换接口，后台的数据仍是数组。

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

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

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

扩展说一下PECS原则

在无泛型限制定义的集合赋值给泛型限制的集合时，在使用集合元素时，需要进行instanceof判断

毕竟泛型是在JDK5后才出现，考虑到向前兼容，编译器是允许非泛型集合与泛型集合互相赋值。

避免抛出ClassCastException异常。

List<String> generics = null; 
List notGenerics = new ArrayList(10); 
notGenerics.add(new Object()); 
notGenerics.add(new Integer(1));

generics = notGenerics; // 此处抛出ClassCastException异常
 String string = generics.get(0);

不要在foreach循环里进行元素的remove/add操作

remove元素，请使用Iterator方式

如果并发操作，需要对Iterator对象加锁。

以上代码的执行结果肯定会出乎大家的意料，那么试一下把“1”换成“2”，会是同样的结果吗？

List<String> list = new ArrayList<>();
list.add("1");
list.add("2");
Iterator<String> iterator = list.iterator();
while (iterator.hasNext()) {
  String item = iterator.next();
  if (删除元素的条件) {
       iterator.remove();
   }
}

for (String item : list) {
  if ("1".equals(item)) {
    list.remove(item);
  }
}

在JDK7版本及以上，Comparator实现类要满足如下三个条件

不然Arrays.sort，Collections.sort会抛IllegalArgumentException异常

三个条件如下

下例中没有处理相等的情况，交换两个对象判断结果并不互反，不符合第一个条件，在实际使用中 可能会出现异常。

new Comparator<Student>() {
@Override
public int compare(Student o1, Student o2) {
return o1.getId() > o2.getId() ? 1 : -1;
}
};

菱形泛型，即diamond，直接使用<>来指代前边已经指定的类型。

集合泛型定义时，在JDK7及以上，使用diamond语法或全省略。

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

HashMap使用HashMap(int initialCapacity) 初始化。

initialCapacity = (需要存储的元素个数 / 负载因子) + 1。

负载因子（即loader factor）默认为0.75

如果暂时无法确定初始值大小，请设置为16（即默认值）。

HashMap需要放置1024个元素，由于没有设置容量初始大小

随着元素不断增加，容量7次被迫扩大，resize需要重建hash表，严重影响性能。

【JDK8】使用Map.forEach方法遍历

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

keySet：其实是遍历了2次

entrySet：只遍历了一次就把key和value都放到了entry中，效率更高。

values()返回的是V值集合，是一个list集合对象；keySet()返回的是K值集合，是一个Set集合对象；entrySet()返回的是K-V值组合集合。

详细看Java集合中的解析

Map类集合K/V能不能存储null值的情况

由于HashMap的干扰，很多人认为ConcurrentHashMap是可以置入null值

而事实上，存储null值时会抛出NPE异常。

避免集合的无序性(unsort)和不稳定性(unorder)带来的负面影响。

ArrayList是order/unsort；

HashMap是unorder/unsort；

TreeSet是order/sort。

有序性是指遍历的结果是按某种比较规则依次排列的。

稳定性指集合每次遍历的元素次序是一定的。

避免使用List的contains方法进行遍历、对比、去重操作。

利用Set元素唯一的特性，可以快速对一个集合进行去重操作

资源驱动类、工具类、单例工厂类都需要注意。

自定义线程工厂，并且根据外部特征进行分组

来自同一机房的调用，把机房编号赋值给whatFeatureOfGroup

定义线程组名称，在jstack问题排查时，非常有帮助

定义好线程的名称，方便出错时回溯。

创建线程或线程池时，请指定有意义的线程名称

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

线程池的好处

如果不使用线程池

线程池不允许使用Executors去创建，而是通过ThreadPoolExecutor的方式

这样的处理方式让写的同学，更加明确线程池的运行规则，规避资源耗尽的风险

Executors返回的线程池对象的弊端如下：

SimpleDateFormat 是线程不安全的类，一般不要定义为static变量

【JDK8】JDK8的应用，可使用

如果定义为static，必须加锁，或者使用DateUtils工具类。

注意线程安全，使用DateUtils。亦推荐如下处理

private static final ThreadLocal<DateFormat> df = new ThreadLocal<DateFormat>() {
         @Override
          protected DateFormat initialValue() {
                     return new SimpleDateFormat("yyyy-MM-dd");
           }
};

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

必须回收自定义的ThreadLocal变量，尤其在线程池场景下，线程经常会被复用

如果不清理自定义的 ThreadLocal变量，可能会影响后续业务逻辑和造成内存泄露等问题

尽量在代理中使用try-finally块进行回收。

尽可能使加锁的代码块工作量尽可能的小

避免在锁代码块中调用RPC方法

高并发时，同步调用应该去考量锁的性能损耗

能用无锁数据结构，就不要用锁

能锁区块，就不要锁整个方法体

能用对象锁，就不要用类锁

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

线程一需要对表A、B、C依次全部加锁后，才可以进行更新操作

那么线程二的加锁顺序也必须是A、B、C，否则可能出现死锁。

在使用阻塞等待获取锁的方式中，必须在try代码块之外，并且在加锁方法与try代码块之间没有任何可能抛出异常的方法调用

避免加锁成功后，在finally中无法解锁。

1、如果在lock方法与try代码块之间的方法调用抛出异常，那么无法解锁，造成其它线程无法成功获取锁。

2、如果lock方法在try代码块之内，可能由于其它方法抛出异常，导致在finally代码块中，unlock对未加锁的对象解锁，它会调用AQS的tryRelease方法（取决于具体实现类），抛出IllegalMonitorStateException异常。

3、在Lock对象的lock方法实现中可能抛出unchecked异常，产生的后果与说明二相同。

Lock lock = new XxxLock();
// ...
lock.lock();
try {
     doSomething();
     doOthers();
} finally {
     lock.unlock();
}

Lock lock = new XxxLock();
// ...
try {
     // 如果此处抛出异常，则直接执行finally代码块
      doSomething();
     // 无论加锁是否成功，finally代码块都会执行
     lock.lock();
     doOthers();
} finally {
      lock.unlock();
}

在使用尝试机制来获取锁的方式中，进入业务代码块之前，必须先判断当前线程是否持有锁。

锁的释放规则与锁的阻塞等待方式相同。

Lock对象的unlock方法在执行时，它会调用AQS的tryRelease方法（取决于具体实现类）

如果当前线程不持有锁，则抛出IllegalMonitorStateException异常。

    Lock lock = new XxxLock();
     // ...
      boolean isLocked = lock.tryLock();
      if (isLocked) {
      try {
             doSomething();
             doOthers();
      } finally {
             lock.unlock();
      }
}

如果每次访问冲突概率小于20%，推荐使用乐观锁，否则使用悲观锁。

乐观锁的重试次数不得小于3次。

并发修改同一记录时，避免更新丢失，需要加锁。

要么在应用层加锁，要么在缓存加锁，要么在数据库层使用乐观锁，使用version作为更新依据。

乐观锁在获得锁的同时，已经完成了更新操作，校验逻辑容易出现漏洞

乐观锁对冲突的解决策略，有较复杂的要求，处理不当，容易造成系统压力或数据异常

故：资金相关的金融敏感信息不建议使用乐观锁更新。

悲观锁遵循一锁、二判、三更新、四释放的原则。

使用CountDownLatch进行异步转同步操作，每个线程退出前必须调用countDown方法

线程执行代码注意catch异常，确保countDown方法被执行到

避免主线程无法执行至await方法，直到超时才返回结果。

注意，子线程抛出异常堆栈，不能在主线程try-catch到。

Random实例包括java.util.Random 的实例或者 Math.random()的方式。

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

在JDK7之后，可以直接使用API ThreadLocalRandom，而在 JDK7之前，需要编码保证每个线程持有一个实例。

在并发场景下，通过双重检查锁（double-checked locking）实现延迟初始化的优化问题隐患

(可参考 The "Double-Checked Locking is Broken" Declaration)

推荐解决方案中较为简单一种（适用于JDK5及以上版本），将目标属性声明为 volatile型。

比如将helper的属性声明修改为`private volatile Helper helper = null;`。

public class LazyInitDemo {
private volatile Helper helper = null;
public Helper getHelper() {
if (helper == null) {
   synchronized (this) {
     if (helper == null) { helper = new Helper(); }
        }
   }
    return helper;
}
    // other methods and fields...
}

public class LazyInitDemo {
   private Helper helper = null;
   public Helper getHelper() {
     if (helper == null) 
             synchronized(this) {
                     if (helper == null)
                            helper = new Helper();
                     }
             return helper;
      }
  // other methods and fields...
}

volatile解决多线程内存不可见问题。

对于一写多读，是可以解决变量同步问题

但是如果多写，同样无法解决线程安全问题。

如果是count++操作，使用AtomicInteger类实现：

如果是JDK8，推荐使用LongAdder对象，比AtomicLong性能更好（减少乐观锁的重试次数）

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

这个变量是针对一个线程内所有操作共享的，所以设置为静态变量，所有此类实例共享此静态变量

也就是说，在类第一次被使用时装载，只分配一块存储空间，所有此类的对象(只要是这个线程内定义的)都可以操控这个变量。

在一个switch块内，每个case

在一个switch块内，都必须包含一个default语句，并且放在最后，即使它什么代码也没有。 

注意break是退出switch语句块，而return是退出方法体。

public class SwitchString {
public static void main(String[] args) {
method(null);
}
public static void method(String param) {
switch (param) {
// 肯定不是进入这里
case "sth":
System.out.println("it's sth");
break;
// 也不是进入这里
case "null":
System.out.println("it's null");
break;
// 也不是进入这里
default:
System.out.println("default");
}
}
}

即使只有一行代码，避免采用单行的编码方式

if (condition) statements;

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

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

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

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

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

如果并发控制没有处理好，容易产生等值判断被“击穿”的情况

使用大于或小于的区间判断条件来代替。

判断剩余奖品数量等于0时，终止发放奖品

但因为并发处理错误，导致奖品数量瞬间变成了负数，这样的话，活动无法终止。

这样做逻辑清晰，有利于代码阅读时重点关注。

这种方式可以改写成：
if (condition) {
     ...
      return obj;
}
// 接着写else的业务逻辑代码;

如果非使用if()...else if()...else...方式表达逻辑，避免后续代码维护困难

超过3层的 if-else 的逻辑判断代码可以使用卫语句、策略模式、状态模式等来实现

什么是卫语句？

示例如下

除常用方法（如getXxx/isXxx）等外，不要在条件判断中执行其它复杂的语句

将复杂逻辑判断的结果赋值给一个有意义的布尔变量名，以提高可读性。

很多 if 语句内的逻辑表达式相当复杂，与、或、取反混合运算，甚至各种方法纵深调用，理解成本非常高。

如果赋值一个非常好理解的布尔变量名字，则是件令人爽心悦目的事情。

// 伪代码如下
final boolean existed = (file.open(fileName, "w") != null) && (...) || (...);
if (existed) {
         ...
}

public final void acquire(long arg) {
      if (!tryAcquire(arg) &&  acquireQueued(addWaiter(Node.EXCLUSIVE), arg)) {
           selfInterrupt();
      }
}

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

赋值点类似于人体的穴位，对于代码的理解至关重要

赋值语句需要清晰地单独成为一行

public Lock getLock(boolean fair) {
        // 算术表达式中出现赋值操作，容易忽略count值已经被改变
        threshold = (count = Integer.MAX_VALUE) - 1;
        // 条件表达式中出现赋值操作，容易误认为是sync==fair
        return (sync = fair) ? new FairSync() : new NonfairSync();
}

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

进行不必要的try-catch操作（这个try-catch是否可以移至循环体外）。

取反逻辑不利于快速理解，并且取反逻辑写法必然存在对应的正向逻辑写法。

使用if (x < 628) 来表达 x 小于628。

使用if (!(x >= 628)) 来表达 x 小于628。

接口入参保护，“保护”的是服务端应用，即接口提供方，

最常见做法

批量操作，因为批量操作非常耗时耗资源（服务端），批量操作的批量数应该有上限，而不是无限的。

对应批量操作，实际应用中还会配置批量操作白名单！

某业务系统，提供一个用户批量查询的接口，API文档上有说最多查多少个，但接口实现上没做任何保护，

导致调用方传了一个1000的用户id数组过来后，查询信息后，内存爆了。

像纯净水过滤的最后一道，参数错误不太可能到底层才会暴露问题。

一般DAO层与Service层都在同一个应用中，部署在同一台服务器中，所以DAO的参数校验，可以省略。

类、类属性、类方法的注释必须使用Javadoc规范

使用/**内容*/格式，不得使用// xxx方式。

在IDE编辑窗口中，Javadoc方式会提示相关注释，生成Javadoc可以正确输出相应注释；

在IDE中，工程调用方法时，不进入方法即可悬浮提示方法、参数、返回值的意义，提高阅读效率。

除了返回值、参数、异常说明外，还必须指出该方法做什么事情，实现什么功能。

对子类的实现要求，或者调用注意事项，请一并说明。

在设置模板时，注意IDEA的@author为`${USER}`，而eclipse的@author为`${user}`，大小写有区别，而日期的设置统一为yyyy/MM/dd的格式。

/**
* @author yangguanbao
* @date 2016/10/31
*/

与其“半吊子”英文来注释，不如用中文注释把问题说清楚。

“TCP连接超时”解释成“传输控制协议连接超时”，理解反而费脑筋。

代码与注释更新不同步

就像路网与导航软件更新不同步一样，如果导航软件严重滞后，就失去了导航的意义。

代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻辑等的修改。

在上方详细说明，而不是简单地注释掉。

如果无用，则删除。

谨慎注释掉代码。

为什么代码被注释掉？

完全没有注释的大段代码对于阅读者形同天书

注释是给自己看的，即使隔很长时间，也能清晰理解当时的思路

注释也是给继任者看的，使其能够快速接替自己的工作

对注释的两点要求

// put elephant into fridge
put(elephant, fridge);
方法名put，加上两个有意义的变量名elephant和fridge，已经说明了这是在干什么，语义清晰的代码不需要额外的注释。

好的命名、代码结构是自解释的，注释力求精简准确、表达到位。

避免出现注释的一个极端：过多过滥的注释，代码的逻辑一旦修改，修改注释是相当大的负担。

特殊注释标记，请注明标记人与标记时间。

注意及时处理这些标记，通过标记扫描，经常清理此类标记。

线上故障有时候就是来源于这些标记处的代码。

（标记人，标记时间，[预计处理时间]）

表示需要实现，但目前还未实现的功能。

这实际上是一个Javadoc的标签，目前的Javadoc还没有实现，但已经被广泛使用。

只能应用于类，接口和方法（因为它是一个Javadoc标签）。

（标记人，标记时间，[预计处理时间]） 

在注释中用FIXME标记某代码是错误的，而且不能工作，需要及时纠正的情况。

1） 协议

2） 路径

3） 请求方法

4） 请求内容

5） 响应体

此条约定有利于数据层面上的协作更加高效，减少前端很多琐碎的null判断。

HTTP状态码

errorCode

errorMessage

用户提示信息

其中输出给用户的提示信息要求：简短清晰、提示友好，引导用户进行下一步操作或解释错误原因，提示信息可以包括错误原因、上下文环境、推荐操作等。

常见的HTTP状态码如下

errorCode / errorMessage / assetStatus / menuList / orderList / configFlag

ERRORCODE / ERROR_CODE / error_message / error-message / errormessage / ErrorMessage / msg

通常在订单号或交易号大于等于16位，大概率会出现前后端单据不一致的情况，

比如，"orderId": 362909601374617692，前端拿到的值却是: 362909601374617660。

不同浏览器对于URL的最大长度限制略有不同，并且对超出最大长度的处理逻辑也有差异，2048字节是取所有浏览器的最小值。

某业务将退货的商品id列表放在URL中作为参数传递，当一次退货商品数量过多时，URL参数超长，传递到后端的参数被截断，导致部分商品未能正确退货。

缓存有利于减少交互次数，减少交互的平均延迟。

http 1.1中，s-maxage告诉服务器进行缓存，时间单位为秒，

用法如下， response.setHeader("Cache-Control", "s-maxage=" + cacheSeconds);

尽管HTTP支持使用不同的输出格式，例如纯文本，JSON，CSV，XML，RSS甚至HTML。

如果我们使用的面向用户的服务，应该选择JSON作为通信中使用的标准数据交换格式，包括请求和响应。

此外，application/JSON是一种通用的MIME类型，具有实用、精简、易读的特点。

当用户在低版本与高版本之间反复切换工作时，会导致迁移复杂度升高，存在数据错乱风险。

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

不要在方法体内定义：Pattern pattern = Pattern.compile(“规则”);

Apache BeanUtils性能较差

可以使用其他方案比如Spring BeanUtils, Cglib BeanCopier，注意均是浅拷贝。

注意如果是Boolean包装类对象，优先调用getXxx()的方法。

velocity调用POJO类的属性时，直接使用属性名取值即可，模板引擎会自动按规范调用POJO的getXxx()，

如果是boolean基本数据类型变量（boolean命名不需要加is前缀），会自动调用isXxx()方法。

注意：如果是Boolean包装类对象，优先调用getXxx()的方法。

注意 Math.random() 这个方法返回是double类型，

注意取值的范围 0≤x<1（能够取到零值，注意除零异常）

如果想获取整数类型的随机数，不要将x放大10的若干倍然后取整

直接使用Random对象的nextInt或者nextLong方法。

根据MVC理论，视图的职责是展示，不要抢模型和控制器的活。

避免数据结构无限增长吃光内存

对于垃圾代码或过时配置，坚决清理干净，避免程序过度臃肿，代码冗余。

对于暂时被注释掉，后续可能恢复使用的代码片断，在注释代码上方，统一规定使用三个斜杠(///)来说明注释掉代码的理由。

错误码想得过于完美和复杂，就像康熙字典中的生僻字一样，用词似乎精准，但是字典不容易随身携带并且简单易懂。

错误码回答的问题是谁的错？错在哪？

1）错误码必须能够快速知晓错误来源，可快速判断是谁的问题。

2）错误码必须能够进行清晰地比对（代码中容易equals）。

3）错误码有利于团队快速对错误原因达到一致认知。

错误码以不断追加的方式进行兼容。

错误等级由日志和错误码本身的释义来决定。

错误产生来源分为A/B/C，

四位数字编号从0001到9999，大类之间的步长间距预留100，参考文末附表3。

尽可能在原有错误码附表中找到语义相同或者相近的错误码在代码中使用即可。

堆栈（stack_trace）

错误信息(error_message)

错误码（error_code）

提示信息（user_tip）

在无法更加具体确定的错误场景中，可以直接使用一级宏观错误码 

一级宏观错误码，分别是

调用第三方服务出错是一级，中间件错误是二级，消息服务出错是三级。

英文单词形式的错误码，不利于非英语母语国家之间的开发者互相协作

非英语母语国家（如阿拉伯语、希伯来语、俄罗斯语等）

数字是一个整体，每位数字的地位和含义是相同的。

一个五位数字12345，第1位是错误等级，第2位是错误来源，345是编号，

人的大脑不会主动地拆开并分辨每位数字的不同含义。

Java 类库中定义的可以通过预检查方式规避的RuntimeException异常，不应该通过catch 的方式来处理

比如：NullPointerException，IndexOutOfBoundsException等等

无法通过预检查的异常除外，

比如，在解析字符串形式的数字时，可能存在数字格式错误，不得不通过catch NumberFormatException来实现。

if (obj != null) {...}

try { 
      obj.method();
 } catch (NullPointerException e) {
       …
}

异常设计的初衷是解决程序运行中的各种意外情况

异常的处理效率比条件判断方式要低很多

catch时请分清稳定代码和非稳定代码，稳定代码指的是无论如何不会出错的代码。

对于非稳定代码的catch尽可能进行区分异常类型，再做对应的异常处理。

对大段代码进行try-catch

用户注册的场景中，如果用户输入非法字符，或用户名称已存在，或用户输入密码过于简单，在程序上作出分门别类的判断，并提示给用户。

捕获异常是为了处理它，不要捕获了却什么都不处理而抛弃之，

如果不想处理它，请将该异常抛给它的调用者。

最外层的业务使用者，必须处理异常，将其转化为用户可以理解的内容。

finally块必须对资源对象、流对象进行关闭，有异常也要做try-catch。

如果JDK7及以上，可以使用try-with-resources方式。

try块中的return语句执行成功后，并不马上返回，而是继续执行finally块中的语句，

如果finally块中存在return语句，则在finally块中直接返回，无情丢弃掉try块中的返回点

private int x = 0;
public int checkReturn() {
      try {
          // x等于1，此处不返回
          return ++x;
       } finally {
           // 返回的结果是2
            return ++x;
       }
}

如果预期对方抛的是绣球，实际接到的是铅球，就会产生意外情况。

通过反射机制来调用方法，如果找不到方法，抛出NoSuchMethodException。

什么情况会抛出NoSuchMethodError呢？

二方包在类冲突时，仲裁机制可能导致引入非预期的版本使类的方法签名不匹配

或者在字节码修改框架（ASM）动态创建或修改类时，修改了相应的方法签名。

这些情况，即使代码编译期是正确的，但在代码运行期时，会抛出NoSuchMethodError。

方法的返回值可以为null，不强制返回空集合，或者空对象等，必须添加注释充分说明什么情况下会返回null值。

本手册明确防止NPE是调用者的责任，即使被调用方法返回空集合或者空对象

对调用者来说，也并非高枕无忧，必须考虑到返回null的情况。

具体如以下场景

1） 返回类型为基本数据类型，return包装数据类型的对象时，自动拆箱有可能产生NPE。

2） 数据库的查询结果可能为null。

3） 集合里的元素即使isNotEmpty，取出的数据元素也可能为null。

4） 远程调用返回对象时，一律要求进行空指针判断，防止NPE。

5） 对于Session中获取的数据，建议进行NPE检查，避免空指针。

6） 级联调用obj.getA().getB().getC()；一连串调用，易产生NPE。

使用JDK8的Optional类来防止NPE问题。

定义时区分unchecked / checked 异常

避免直接抛出new RuntimeException()

更不允许抛出Exception或者Throwable

应使用有业务含义的自定义异常。推荐业界已定义过的自定义异常

如：DAOException / ServiceException等。

随意复制和粘贴代码，必然会导致代码的重复，在以后需要修改时，需要修改所有的副本，容易遗漏。

必要时抽取共性方法，或者抽象公共类，甚至是组件化。

DRY

一个类中有多个public方法，都需要进行数行相同的参数校验操作，这个时候请抽取：

private boolean checkParam(DTO dto) {...}

对于公司外的http/api开放接口必须使用“错误码”；而应用内部推荐异常抛出；

跨应用间RPC调用优先考虑使用Result方式，封装isSuccess()方法、“错误码”、“错误简短信息”。

关于RPC方法返回方式使用Result方式的理由： 

应用中不可直接使用日志系统（Log4j、Logback）中的API

应依赖使用日志框架 SLF4J中的API，使用门面模式的日志框架。

有利于维护和各个类的日志处理方式统一

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
private static final Logger logger = LoggerFactory.getLogger(Test.class);

因为有些异常具备以“周”为频次发生的特点。

网络运行状态、安全相关信息、系统监测、管理后台操作、用户敏感操作需要留存相关的网络日志不少于6个月。

扩展日志包括，如打点、临时监控、访问日志等

logType:日志类型，如stats/monitor/access等；

logName:日志描述。

命名好处：

force-web应用中单独监控时区转换异常

如：force_web_timeZoneConvert.log

因为String字符串的拼接会使用StringBuilder的append()方式，有一定的性能损耗。

使用占位符仅是替换动作，可以有效提升性能

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

虽然在debug(参数)的方法体内第一行代码isDisabled(Level.DEBUG_INT)为真时，就直接return

（Slf4j的常见实现Log4j和Logback）

但是参数可能会进行字符串拼接运算。

此外，如果debug(getName())这种参数内有getName()方法调用，无谓浪费方法调用的开销。

// 如果判断为真，那么可以输出trace和debug级别的日志

if (logger.isDebugEnabled()) { 
           logger.debug("Current ID is: {} and name is: {}", id, getName()); 
}

避免重复打印日志，浪费磁盘空间，

<logger name="com.taobao.dubbo.config" additivity="false">

标准日志输出与标准错误输出文件，每次Jboss重启时，才滚动

如果大量输出送往这两个文件，容易造成文件大小超过操作系统大小限制。

异常信息应该包括两类信息

logger.error(各类参数或者对象toString() + "_" + e.getMessage(), e);

如果对象里某些get方法被覆写，存在抛出异常的情况，则可能会因为打印日志而影响正常业务流程的执行。

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

生产环境禁止输出debug日志

有选择地输出info日志

如果使用warn来记录刚上线时的业务行为信息，一定要注意日志输出量的问题

避免把服务器磁盘撑爆，并记得及时删除这些观察日志

大量地输出无效日志，不利于系统性能提升，也不利于快速定位错误点。

记录日志时请思考

可以使用warn日志级别来记录用户输入参数错误的情况

避免用户投诉时，无所适从。

如非必要，请不要在此场景打出error级别，避免频繁报警。 

注意日志输出的级别，error级别只记录系统逻辑出错、异常或者重要的错误信息。

如果日志中的错误信息，用英文描述不清楚的话

使用中文描述即可，否则容易产生歧义。

由于字符集问题

⚫ A：Automatic（自动化）

⚫ I：Independent（独立性）

⚫ R：Repeatable（可重复）

决不能互相调用

不能依赖执行的先后次序

DAO层

Manager层

可重用度高的Service

⚫ B：Border，边界值测试，包括循环边界、特殊取值、特殊时间点、数据顺序等。

⚫ C：Correct，正确的输入，并得到预期的结果。 

⚫ D：Design，与设计文档相结合，来编写单元测试。 

⚫ E：Error，强制错误信息输入（如：非法数据、异常流程、业务允许外等），并得到预期的结果。

多层条件语句建议使用卫语句、策略模式、状态模式等方式重构。

⚫ page size过大，导致内存溢出

⚫ 恶意order by，导致数据库慢查询

⚫ 任意重定向

⚫ SQL注入

⚫ 反序列化注入

⚫ 正则输入源串拒绝服务ReDoS 

(Cross-site request forgery)跨站请求伪造是一类常见编程漏洞。

对于存在CSRF漏洞的应用/网站，攻击者可以事先构造好URL

只要受害者用户一访问，后台便在用户不知情的情况下对数据库中用户参数进行相应修改。

如果没有限制次数和频率

那么可以利用此功能骚扰到其它用户，并造成短信平台资源浪费。

避免被滥刷而导致资损

譬如短信、邮件、电话、下单、支付，

如数量限制、疲劳度控制、验证码校验

发贴

评论

发送即时消息

防刷

文本内容违禁词过滤 

任何字段如果为非负数，必须是unsigned。

数据类型是unsigned tinyint（1表示是，0表示否）。

POJO类中的任何布尔类型的变量，都不要加is前缀，所以，需要在<resultMap>设置从is_xxx到Xxx的映射关系。

数据库表示是与否的值，使用tinyint类型，坚持is_xxx的命名方式是为了明确其取值含义与取值范围。

表达逻辑删除的字段名is_deleted，1表示删除，0表示未删除。

禁止出现数字开头

禁止两个下划线中间只出现数字。

数据库字段名的修改代价很大，因为无法进行预发布，所以字段名称需要慎重考虑。

说明：MySQL在Windows下不区分大小写，但在Linux下默认是区分大小写。

因此，数据库名、表名、字段名，都不允许出现任何大写字母，避免节外生枝。 

AliyunAdmin，rdcConfig，level_3_name

aliyun_admin，rdc_config，level3_name

 表名应该仅仅表示表里面的实体内容，不应该表示实体数量

对应于DO类名也是单数形式，符合表达习惯。

如desc、range、match、delayed等，

请参考MySQL官方保留字。

主键索引名为pk_字段名

唯一索引名为uk_字段名

普通索引名则为idx_字段名

禁止使用float和double。

存储时，float 和 double 都存在精度损失的问题

很可能在比较值时，得到不正确的结果。

如果存储的数据范围超过 decimal 的范围，建议将数据拆成整数和小数并分开存储。

如果存储的字符串长度几乎相等，使用char定长字符串类型。

varchar是可变长字符串，不预先分配存储空间

长度不要超过5000，如果存储长度大于此值，定义字段类型为text

独立出来一张表，用主键来对应，避免影响其它字段索引效率。

id必为主键，类型为bigint unsigned、单表时自增、步长为1。

create_time, update_time的类型均为datetime类型。

alipay_task / force_project / trade_config

如果修改字段含义或对字段表示的状态追加时，需要及时更新字段注释。

字段允许适当冗余，以提高查询性能，但必须考虑数据一致。

冗余字段应遵循：

商品类目名称使用频率高，字段长度短，名称基本一不变，可在相关联的表中冗余存储类目名 称，避免关联查询。

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

如果预计三年后的数据量根本达不到这个级别，请不要在创建表时就分库分表。

正例：如下表，其中无符号值可以避免误存负数，且扩大了表示范围。

节约数据库表空间、节约索引存储，

更重要的是提升检索速度。

业务上具有唯一特性的字段，即使是多个字段的组合，也必须建成唯一索引。

不要以为唯一索引影响了insert速度，这个速度损耗可以忽略

但提高查找速度是明显的；

即使在应用层做了非常完善的校验控制，只要没有唯一索引，根据墨菲定律，必然有脏数据产生。

需要join的字段，数据类型必须绝对一致

多表关联查询时，保证被关联的字段需要有索引

即使双表join，也要注意表索引、SQL性能。

在varchar字段上，建立索引时，必须指定索引长度

没必要对全字段建立索引，根据实际文本区分度决定索引长度即可。

索引的长度与区分度是一对矛盾体

一般对字符串类型数据，长度为20的索引，区分度会高达90%以上，可以使用count(distinct left(列名, 索引长度))/count(*)的区分度来确定。

页面搜索严禁左模糊或者全模糊，如果需要请走搜索引擎来解决。 

索引文件，具有B-Tree的最左前缀匹配特性

如果左边的值未确定，那么无法使用此索引。

如果有order by的场景，请注意利用索引的有序性。

order by 最后的字段是组合索引的一部分，并且放在索引组合顺序的最后

避免出现file_sort的情况，影响查询性能。

where a=? and b=? order by c; 索引：a_b_c 

索引如果存在范围查询，那么索引有序性无法利用

如：WHERE a>10 ORDER BY b; 索引a_b无法排序。

利用覆盖索引来进行查询操作，避免回表。 

如果一本书需要知道第11章是什么标题，会翻开第11章对应的那一页吗？

目录浏览一下就好，这个目录就是起到覆盖索引的作用。

能够建立索引的种类分为主键索引、唯一索引、普通索引三种

覆盖索引只是一种查询的一种效果，用explain的结果，extra列会出现：using index。

MySQL并不是跳过offset行，而是取offset+N行，然后返回放弃前offset行，返回N行，

那当offset特别大的时候，效率就非常的低下，要么控制返回的总页数，要么对超过特定阈值的页数进行SQL改写。

先快速定位需要获取的id段，然后再关联：

SELECT t1.* FROM 表1 as t1, (select id from 表1 where 条件 LIMIT 100000,20 ) as t2 where t1.id=t2.id

SQL性能优化的目标：至少要达到 range 级别，要求是ref级别，如果可以是consts最好。

1） consts 单表中最多只有一个匹配行（主键或者唯一索引），在优化阶段即可读取到数据。 

2） ref 指的是使用普通的索引（normal index）。 

3） range 对索引进行范围检索。

explain表的结果，type=index，索引物理文件全扫描，速度非常慢

这个index级别比较range还低，与全表扫描是小巫见大巫。

如果where a=? and b=? ，如果a列的几乎接近于唯一值，那么只需要单建idx_a索引即可。 

存在非等号和等号混合时，在建索引时，请把等号条件的列前置。

where c>? and d=? 那么即使c的区分度更高，也必须把d放在索引的最前列，即索引idx_d_c。

不要使用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问题。

使用如下方式来避免sum的NPE问题：SELECT IFNULL(SUM(column), 0) FROM table;

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

避免出现误删除，确认无误才能执行更新语句。

对于数据库中表记录的查询和变更，只要涉及多个表，都需要在列名前加表的别名（或表名）进行限定。

对多表进行查询记录、更新记录、删除记录时，如果对操作列没有限定表的别名（或表名），并且操作列在多个表中存在时，就会抛异常。

select t1.name from table_first as t1 , table_second as t2 where t1.id=t2.id;

在某业务中，由于多表关联查询语句没有加表的别名（或表名）的限制，

正常运行两年后，最近在某个表中增加一个同名字段，在预发布环境做数据库变更后，

线上查询语句出现出1052异常：Column 'name' in field list is ambiguous。

1）别名可以是表的简称，或者是依照表在SQL语句中出现的顺序，以t1、t2、t3的方式命名。

2）别名前加as使别名更容易识别。

select t1.name from table_first as t1, table_second as t2 where t1.id=t2.id;

in操作能避免则避免

若实在避免不了，需要仔细评估in后边的集合元素数量，控制在1000个之内。

如果有国际化需要，所有的字符存储与表示，均以utf-8编码，注意字符统计函数的区别。

如果需要存储表情，那么选择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的子集合。

Map<String, Object> map = new HashMap<>();
map.put("start", start);
map.put("size", size);

resultClass=”Hashtable”，会置入字段名和属性值，但是值的类型不可控。

更新数据表记录时，必须同时更新记录对应的gmt_modified字段值为当前时间。

不要写一个大而全的数据更新接口。

传入为POJO类，不管是不是自己的目标更新字段，都进行update table set c1=value1,c2=value2,c3=value3; 这是不对的。

执行SQL时，不要更新无改动的字段

缓存回滚

搜索引擎回滚

消息补偿

统计修正

<isEqual>中的compareValue是与属性值对比的常量，一般是数字，表示相等时带上此条件；

<isNotEmpty>表示不为空且不为null时执行；]

<isNotNull>表示不为null值时执行。

说明

正例

说明

正例

详细规定参考下方。

产品方向改变

大规模API不兼容

架构不兼容升级。

保持相对兼容性

增加主要功能特性

影响范围极小的API不兼容修改

保持完全兼容性

修复BUG

新增次要功能特性

起始版本号必须为：1.0.0，而不是0.0.1

正式发布的类库必须先去中央仓库进行查证，使版本号有延续性，

正式版本号不允许覆盖升级。

如当前版本：1.3.3，那么下一个合理的版本号：1.3.4 或 1.4.0 或 2.0.0

保证应用发布的幂等性

加快编译时的打包构建

二方库的新增或升级，保持除功能点之外的其它jar包，仲裁结果不变。

如果有改变，必须明确评估和验证。

在升级时，进行dependency:resolve前后信息比对

如果仲裁结果完全不一致，那么通过dependency:tree命令，找出差异点，进行<exclude>排除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）精简可控原则

 2）稳定可追溯原则

高并发服务器建议调小TCP协议的time_wait超时时间。 

操作系统默认240秒后，才会关闭处于time_wait状态的连接

在高并发访问下，服务器端会因为处于time_wait的连接数太多，可能无法建立新的连接，所以需要在服务器上调小此等待值。

：在linux服务器上请通过变更/etc/sysctl.conf文件去修改该缺省值（秒）： net.ipv4.tcp_fin_timeout = 30

调大服务器所支持的最大文件句柄数

最大文件句柄数（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维护不一致的问题和潜在的安全风险。

容易导致系统风险上升

可扩展性下降

重构成本也会因历史数据迁移和系统平滑过渡而陡然增加

存储介质选型

表结构设计能否满足技术方案

存取性能和存储空间能否满足业务发展

表或字段之间的辩证关系

字段名称

字段类型

索引

首先、明确对象有多少种状态

然后、明确两两状态之间是否存在直接转换关系

再、明确触发状态转换的条件是什么