前言
手册以 Java 开发者为中心视角
手册的愿景是码出高效
编程规约
命名风格
【 】 ， 。 1
// 反例
： 【 】 ， 。 ： ， 。 ， 。 1
2
3// 正例
： ， 。
// 反例： 【 】 。 1
2
3// 正例
：
// 反例： 【 】 UpperCamelCase风格， ： 。 1
2
3// 正例
：
// 反例： 【 】 、 、 、 lowerCamelCase风格。 1
// 正例
： 【 】 ， ， ， 。 1
2
3// 正例
：
// 反例： 【 】 ； ； ， 。 【 】 。 1
2
3// 正例
： 。
// 反例： ， 。 【 】 ， ， 。 1
2
3
4
5// 说明
： ， ，
// 所以， 。
// 反例： ， ，
// 框架在反向解析的时候， ， ， 。 【 】 ， 。 ， ， 。 1
// 正例
： 、 （ ） 【 】 、 ， 。 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26// 说明
： 、 ， ，
// 另外， ， 。
// 对于非 setter/getter 的参数名称也要避免与成员变量名称相同。
// 反例：
public class ConfusingName {
public int stock;
// 非 setter/getter 的参数名称，
public void get(String alibaba) {
if (condition) {
final int money = 666;
// ...
}
for (int i = 0; i < 10; i++) {
// 在同一方法体中，
final int money = 15978; // ...
}
}
}
class Son extends ConfusingName {
// 不允许与父类的成员变量名称相同
public int stock;
}【 】 ， 。 1
// 反例
： ； ； ， 。 【 】 ， ， 。 1
2
3// 正例
： 。
// 反例： 。 【 】 ， ， 。 1
2
3// 正例
：
// 反例： 【 】 、 、 、 ， 。 1
2
3
4
5
6// 说明
： ， 。
// 正例：
public class OrderFactory;
public class LoginProxy;
public class ResourceObserver;【 】 （ ） ， ， 。 ， ， ， 。 1
2
3
4
5
6
7
8
9
10
11// 说明
： ， ， 。
// 正例：
// 接口方法签名
void commit();
// 接口基础常量
String COMPANY = "alibaba";
// 反例：
// 接口方法定义
public abstract void f();- 接口和实现类的命名有两套规则
：
【 】 ， ， ， 。 1
// 正例
： 。 【 】 ， （ ） 。 1
// 正例
： 。
【 】 ， ， 。 1
2
3// 说明
： ， 。
// 正例： ： 。 【 】 ：
- Service/DAO 层方法命名规约
- 获取单个对象的方法用 get 做前缀
。 - 获取多个对象的方法用 list 做前缀
， ， ： 。 - 获取统计值的方法用 count 做前缀
。 - 插入的方法用 save/insert 做前缀
。 - 删除的方法用 remove/delete 做前缀
。 - 修改的方法用 update 做前缀
。
- 获取单个对象的方法用 get 做前缀
- 领域模型命名规约
- 数据对象
： ， 。 - 数据传输对象
： ， 。 - 展示对象
： ， 。 - POJO 是 DO/DTO/BO/VO 的统称
， 。
- 数据对象
常量定义
【 】 （ ） 。 1
2
3// 反例
： ， ， ，
String key = "Id#taobao_" + tradeId;
cache.put(key, value);【 】 ， ， ， ， 。 1
// 说明
： ， ？ 【 】 ， ， 。 1
2
3// 说明
： ， ， ， ， 。
// 正例： ； 。 【 】 ： - 跨应用共享常量
： ， 。 - 应用内共享常量
： ， 。 - 子工程内部共享常量
： 。 - 包内共享常量
： 。 - 类内共享常量
： 。
1
2
3
4
5
6
7// 反例
：
// 两位工程师在两个类中分别定义了“ ” ：
// 类 A 中：
public static final String YES = "yes";
// 类 B 中：
public static final String YES = "y";
// A.YES.equals(B.YES) 预期是 true， ， 。 - 跨应用共享常量
【 】 。 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16// 说明
： ， ， 。
// 正例：
public enum SeasonEnum {
SPRING(1), SUMMER(2), AUTUMN(3), WINTER(4);
private int seq;
SeasonEnum(int seq) {
this.seq = seq;
}
public int getSeq() {
return seq;
}
}
代码格式
【 】 ， ， ； ： - 左大括号前不换行
。 - 左大括号后换行
。 - 右大括号前换行
。 - 右大括号后还有 else 等代码则不换行
； 。
1
2
3
4
5
6
7
8
9// 正例
：
// 左大括号前加空格且不换行；
if (flag == 1) {
System.out.println("world");
// 右大括号前换行， ，
} else {
System.out.println("ok");
// 在右大括号后直接结束，
}- 左大括号前不换行
【 】 ； ； 。 1
2// 反例
：
if ( a == b )【 】 if / for / while / switch / do等保留字与括号之间都必须加空格。 1
2
3
4
5// 正例
：
// 关键词 if 与括号之间必须有一个空格， ，
if (flag == 0) {
System.out.println(say);
}【 】 、 。 1
2
3
4
5// 说明
： 、 、 。
// 正例：
// 运算符的左右必须有一个空格
int flag = 0;【 】 ， 。 1
2
3
4
5
6
7
8
9// 说明
： ， 。
// IDEA 设置 Tab 为 4 个空格时，
// Eclipse 中，
// 正例：
public static void main(String[] args) {
// 缩进 4 个空格
String say = "hello";
}【 】 。 1
2
3// 正例
：
// 这是示例注释，
String commentString = new String();【 】 ， 。 1
2
3// 正例
：
double first = 3.2d;
int second = (int)first + 2;【 】 120个， ， ： - 第二行相对第一行缩进 4 个空格
， ， ， 。 - 运算符与下文一起换行
。 - 方法调用的点符号与下文一起换行
。 - 方法调用中的多个参数需要换行时
， 。 - 在括号前不要换行
， 。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16// 正例
：
StringBuilder sb = new StringBuilder();
// 超过 120 个字符的情况下， ，
sb.append("yang").append("hao")
.append("chen")
.append("chen")
.append("chen");
// 反例：
StringBuilder sb = new StringBuilder();
// 超过 120 个字符的情况下，
sb.append("you").append("are").append
("lucky");
// 参数很多的方法调用可能超过 120 个字符，
method(args1, args2, args3, ...
, argsX);- 第二行相对第一行缩进 4 个空格
【 】 ， 。 1
2// 正例
： ， 。
method(args1, args2, args3);【 】 text file encoding设置为 UTF-8; IDE 中文件的换行符使用 Unix 格式， 。 【 】 。 1
2
3// 说明
： 、 、 、 、 。
// 正例： ， ， ， ； ， 。 【 】 。 1
2
3
4
5
6
7// 说明
： ， ， 、 、 ， ， 。
// 正例：
int one = 1;
long two = 2L;
float three = 3F;
StringBuilder sb = new StringBuilder();【 】 、 、 。 1
// 说明
： ， 。
OOP 规约
【 】 ， ， 。 【 】 ， 。 1
2
3// 说明
： 。
// 一个是字母的 O， ， 。
// 另外， ， 。 【 】 ， ， ， 。 1
2
3
4// 说明
： 。 （ ）
// 正例：
public List<User> listUsers(String type, Long... ids) {...}【 】 ， ， 。 ， 。 【 】 。 1
2
3// 说明
： ，
// 应该使用双参数 decode(String source, String encode)。
// 接口提供方既然明确是过时接口， ； ， 。 【 】 ， 。 1
2
3
4
5
6
7// 说明
：
// 正例：
"test".equals(object);
// 反例：
object.equals("test");【 】 ， 。 1
2
3// 说明
： ， ， ，
// 这个区间内的 Integer 值可以直接使用 == 进行判断，
// 但是这个区间之外的所有数据， ， ， ， 。 【 】 ， 。 【 】 ， ==来比较， equals来判断。 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36// 说明
： “ ” ， “ ” 。
// 二进制无法精确表示大部分的十进制小数， 《 》 。
// 反例：
// 1. 基本数据类型
float a = 1.0F - 0.9F;
float b = 0.9F - 0.8F;
if (a == b) {
// 预期进入此代码块，
// 但事实上 a == b 的结果为 false
}
// 2. 包装数据类型
Float x = Float.valueOf(a);
Float y = Float.valueOf(b);
if (x.equals(y)) {
// 预期进入此代码块，
// 但事实上 equals 的结果为 false
}
// 正例：
// 1. 指定一个误差范围， ， 。
float a = 1.0F 0.9F;
float b = 0.9F 0.8F;
float diff = 1e-6F;
if (Math.abs(a - b) < diff) {
System.out.println("true");
}
//2. 使用 BigDecimal 来定义值， 。
BigDecimal a = new BigDecimal("1.0");
BigDecimal b = new BigDecimal("0.9");
BigDecimal c = new BigDecimal("0.8");
BigDecimal x = a.subtract(b);
BigDecimal y = b.subtract(c);
if (x.compareTo(y) == 0) {
System.out.println("true");
}【 】 compareTo()方法， equals()方法。 1
// 说明
： （ ） ， 。 【 】 ， 。 1
2
3
4// 正例
： 。
// 反例： ， ，
// 但是随着 id 越来越大， 。 【 】 BigDecimal(double)的方式把 double 值转化为 BigDecimal 对象。 1
2
3
4
5
6
7
8// 说明
： ， 。
BigDecimal g = new BigDecimal(0.1F); // 实际的存储值为：
// 正例：
// 优先推荐入参为 String 的构造方法， ，
// 此方法内部其实执行了Double 的 toString， 。
BigDecimal recommend1 = new BigDecimal("0.1");
BigDecimal recommend2 = BigDecimal.valueOf(0.1);- 关于基本数据类型与包装数据类型的使用标准如下
：
【 】 。 【 】 。 【 】 。 1
2
3
4
5
6
7
8// 说明
： ， ， ， ， 。
// 正例： ， ， 。
// 反例： ，
// 即正负 x%， ， ，
// 调用不成功时， ， ， ， 。
// 所以包装数据类型的 null 值， ， ： ， 。
【 】 DO / DTO / VO等 POJO 类时， 。 1
2// 反例
： ，
// 但是这个属性在数据提取时并没有置入具体值， ， 。 【 】 ， serialVersionUID字段， ； ， ， serialVersionUID值。 1
// 说明
： 。 【 】 ， ， 。 【 】 toString()方法。 ： source> generate toString时， ， super.toString。 1
// 说明
： ， ， 。 【 】 ， isXxx()和getXxx()方法。 1
// 说明
： ， 。 【 】 ， ， IndexOutOfBoundsException的风险。 1
2
3
4
5// 说明
：
String str = "a,b,c,,";
String[] ary = str.split(",");
// 预期大于 3，
System.out.println(ary.length);【 】 ， ， ， ， 。 【 】 ： 。 1
2
3
4
5// 说明
：
// 公有方法是类的调用者和维护者最关心的方法， ；
// 保护方法虽然只是子类关心， “ ” ；
// 私有方法外部一般不需要特别关心， ； ，
// 所有 Service 和 DAO 的 getter/setter 方法放在类体最后。 【 】 ， ， this.成员名 = 参数名。 ， ， 。 1
2
3
4
5
6
7
8// 反例
：
public Integer getData () {
if (condition) {
return this.data + 100;
} else {
return this.data - 100;
}
}【 】 ， ， 。 1
2
3
4
5
6
7
8
9// 说明
：
// 下例中， ， ，
// 最后通过 toString 方法返回 String 对象， 。
// 反例：
String str = "start";
for (int i = 0; i < 100; i++) {
str = str + "hello";
}【 】 、 、 、 ， ： - 不允许被继承的类
， ： 。 - 不允许修改引用的域对象
， ： 。 - 不允许被覆写的方法
， ： 。 - 不允许运行过程中重新赋值的局部变量
。 - 避免上下文重复使用一个变量
， ， 。
- 不允许被继承的类
【 】 。 1
// 说明
： ， ， 。 【 】 ： - 如果不允许外部直接通过 new 来创建对象
， 。 - 工具类不允许有 public 或 default 构造方法
。 - 类非 static 成员变量并且与子类共享
， 。 - 类非 static 成员变量并且仅在本类使用
， 。 - 类 static 成员变量如果仅在本类使用
， 。 - 若是 static 成员变量
， 。 - 类成员方法只供类内部调用
， 。 - 类成员方法只对继承类公开
， 。
1
2
3
4// 说明
： 、 、 、 ， 。 ， 。
// 思考： ， ， ， ， ？
// 变量像自己的小孩， ， ， ， 。 - 如果不允许外部直接通过 new 来创建对象
日期时间
【 】 ， 。 1
2
3
4
5
6// 说明
： ， ，
// 而大写的 YYYY 代表是 week in which year（ ） ，
// 意思是当天所在的周属于的年份， ， ， ， 。
// 正例： ：
new SimpleDateFormat("yyyy MM dd HH:mm:ss")【 】 ， 。 1
2
3
4
5// 说明
： ：
// 1. 表示月份是大写的 M；
// 2. 表示分钟则是小写的 m；
// 3. 24 小时制的是大写的 H；
// 4. 12 小时制的则是小写的 h。 【 】 ： System.currentTimeMillis(); 而不是new Date().getTime()。 1
// 说明
： ， 。 ， ， 。 【 】 ： 1
2
3
4
5
6
7
8
9
10
11
12// 1. java.sql.Date
。
// 2. java.sql.Time。
// 3. java.sql.Timestamp。
// 说明：
// 第 1 个不记录时间， ；
// 第 2 个不记录日期， ；
// 第 3 个在构造方法 super((time/1000)*1000)， 。
// 反例：
// java.util.Date.after(Date) 进行时间比较时，
// 当入参是 java.sql.Timestamp 时， ， 。 【 】 ， 。 1
2
3
4
5
6
7
8
9
10
11
12
13// 正例
：
// 获取今年的天数
int daysOfThisYear = LocalDate.now().lengthOfYear();
// 获取指定某年的天数
LocalDate.of(2011, 1, 1).lengthOfYear();
// 反例：
// 第一种情况： ，
int[] dayArray = new int[365];
// 第二种情况： ， ，
Calendar calendar = Calendar.getInstance();
calendar.set(2020, 1, 26);
calendar.add(Calendar.DATE, 365);【 】 。 ， 。 【 】 。 ， ， 。 1
2
3// 说明
： ，
// 正例： ， ， 。
集合处理
【 】 ， ： 1
2
3
4
5// 1. 只要覆写 equals
， 。
// 2. 因为 Set 存储的是不重复的对象， ， 。
// 3. 如果自定义对象作为 Map 的键， 。
// 说明： ， 。 【 】 ， isEmpty()方法， size() == 0的方式。 1
2
3
4
5
6
7// 说明
： ， ， 。
// 正例：
Map<String, Object> map = new HashMap<>(16);
if(map.isEmpty()) {
System.out.println("no element in this map.");
}【 】 java.util.stream.Collectors类的 toMap() 方法转为 Map 集合时， ， ， IllegalStateException异常。 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17// 说明
： ， 。
// 正例：
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 集合中只有一个键值对：
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.stream.Collectors类的 toMap() 方法转为 Map 集合时， 。 1
2
3
4
5
6
7
8
9
10
11
12// 说明
： ：
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)
);【 】 ， ClassCastException异常： java.util.RandomAccessSubList cannot be cast to java.util.ArrayList。 1
2// 说明
： ， ，
// 而是 ArrayList 的一个视图， 。 【 】 keySet() / values() / entrySet()返回集合对象时， ， UnsupportedOperationException异常。 【 】 ， ： emptyList() / singletonList()等都是 immutable list， 。 1
2// 反例
： ， ，
// 调用方一旦进行了添加元素的操作， 。 【 】 ， ， 、 、 ConcurrentModificationException异常。 【 】 ， toArray(T[] array)， 、 。 1
2
3
4
5
6
7
8
9
10
11
12
13
14// 说明
： ， ：
// 1. 等于 0， ， 。
// 2. 大于 0 但小于 size， ， 。
// 3. 等于 size， ， ， ， 。
// 4. 大于 size， ， ， 。
// 正例：
List<String> list = new ArrayList<>(2);
list.add("guan");
list.add("bao");
String[] array = list.toArray(new String[0]);
// 反例： ， ，
// 若强转其它类型数组将出现ClassCastException 错误。 【 】 ， 。 1
2// 说明
：
// 其中 c 为输入集合参数， ， 。 【 】 Arrays.asList()把数组转换成集合时， ， add / remove / clear方法会抛出UnsupportedOperationException异常。 1
2
3
4
5
6
7
8// 说明
： ， 。
// Arrays.asList 体现的是适配器模式， ， 。
String[] str = new String[] { "chen", "yang", "hao" };
List list = Arrays.asList(str);
// 第一种情况： 。
list.add("yangguanbao");
// 第二种情况：
str[0] = "change"; // list 也会随之修改， 。 【 】 <? extends T>来接收返回的数据， ， <? super T>不能使用 get 方法， 。 1
2
3// 说明
： ：
// 1. 频繁往外读取内容的，
// 2. 经常往里插入的， 【 】 ， ， ， ClassCastException异常。 1
2
3
4
5
6
7
8
9
10// 说明
： ， ， 。
// 反例：
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);【 】 remove / add操作。 ， ， 。 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18// 正例
：
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);
}
}【 】 ， ， Arrays.sort， Collections.sort会抛IllegalArgumentException异常。 1
2
3
4
5
6
7
8
9
10
11
12// 说明
：
// 1. x， ， 。
// 2. x > y， ， 。
// 3. x = y， ， ， 。
//反例： ， ， ， 。
new Comparator<Student>() {
public int compare(Student o1, Student o2) {
return o1.getId() > o2.getId() ? 1 : -1;
}
};【 】 ， ， 。 1
2
3
4
5
6
7// 说明
： ， ， 。
// 正例：
// diamond 方式，
HashMap<String, String> userCache = new HashMap<>(16);
// 全省略方式
ArrayList<User> users = new ArrayList(10);【 】 ， 。 1
2
3
4
5
6
7// 说明
： ， ， （ ） 。
// 正例： 。
// 注意负载因子（ ） ， ， （ ） 。
// 反例： ， ， ，
// resize() 方法总共会调用 8 次， 。 。 【 】 ， 。 1
2
3
4
5
6
7// 说明
： ， ， 。
// 而 entrySet 只是遍历了一次就把 key 和 value 都放到了 entry 中， 。 ， 。
// 正例：
// values() 返回的是 V 值集合， ；
// keySet() 返回的是 K 值集合， ；
// entrySet() 返回的是 K-V 值组合集合。 【 】 ， ： 集合类 Key Value Super 说明 Hashtable 不允许为 null 不允许为 null Dictionary 线程安全 ConcurrentHashMap 不允许为 null 不允许为 null AbstractMap 锁分段技术 （ ） TreeMap 不允许为 null 允许为 null AbstractMap 线程不安全 HashMap 允许为 null 允许为 null AbstractMap 线程不安全 1
// 反例
： ， ， ， 。 【 】 ， 。 1
2// 说明
： 。 。
// 如： ； ； 。 【 】 ， ， 。
并发处理
【 】 ， 。 1
// 说明
： 、 、 。 【 】 ， 。 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19// 正例
： ， ，
// 比如， ，
public class UserThreadFactory implements ThreadFactory {
private final String namePrefix;
private final AtomicInteger nextId = new AtomicInteger(1);
// 定义线程组名称， ，
UserThreadFactory(String whatFeatureOfGroup) {
namePrefix = "From UserThreadFactory's " + whatFeatureOfGroup + "-Worker-";
}
public Thread newThread(Runnable task) {
String name = namePrefix + nextId.getAndIncrement();
Thread thread = new Thread(null, task, name, 0, false);
System.out.println(thread.getName());
return thread;
}
}【 】 ， 。 1
2// 说明
： ， 。
// 如果不使用线程池， “ ” 。 【 】 ， ， ， 。 1
2
3// 说明
： ：
// 1. FixedThreadPool 和 SingleThreadPool： ， ， 。
// 2. CachedThreadPool： ， ， 。 【 】 ， ， ， ， 。 1
2
3
4
5
6
7
8
9
10// 说明
： ， ， ，
// DateTimeFormatter 代替 SimpleDateFormat， ： 。
// 正例： ， 。 ：
private static final ThreadLocal<DateFormat> df = new ThreadLocal<DateFormat>() {
protected DateFormat initialValue() {
return new SimpleDateFormat("yyyy-MM-dd");
}
};【 】 ， ， ， ， 。 。 1
2
3
4
5
6
7// 正例
：
objectThreadLocal.set(userInfo);
try {
// ...
} finally {
objectThreadLocal.remove();
}【 】 ， 。 ， ； ， ； ， 。 1
// 说明
： ， 。 【 】 、 、 ， ， 。 1
2
3// 说明
：
// 线程一需要对表 A、 、 ，
// 那么线程二的加锁顺序也必须是 A、 、 ， 。 【 】 ， ， ， ， 。 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27// 说明
// 1. 如果在 lock 方法与 try 代码块之间的方法调用抛出异常， ， 。
// 2. 如果 lock 方法在 try 代码块之内， ， ， ，
// 它会调用 AQS 的 tryRelease 方法（ ） ， 。
// 3. 在 Lock 对象的 lock 方法实现中可能抛出 unchecked 异常， 。
// 正例：
Lock lock = new XxxLock();
lock.lock();
try {
doSomething();
doOthers();
} finally {
lock.unlock();
}
// 反例：
Lock lock = new XxxLock();
try {
// 如果此处抛出异常，
doSomething();
// 无论加锁是否成功，
lock.lock();
doOthers();
} finally {
lock.unlock();
}【 】 ， ， 。 。 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15// 说明
： ， （ ） ，
// 如果当前线程不持有锁， 。
// 正例：
Lock lock = new XxxLock();
// ...
boolean isLocked = lock.tryLock();
if (isLocked) {
try {
doSomething();
doOthers();
} finally {
lock.unlock();
}
}【 】 ， ， 。 ， ， ， 。 1
// 说明
： ， ， 。 。 【 】 ， ， ， ， 。 【 】 ， 。 1
2
3
4
5// 说明
： ， ，
// 另外， ， ，
// 所以资金相关的金融敏感信息不建议使用乐观锁更新。
// 正例： 、 、 、 。 【 】 ， ， ， ， ， 。 1
// 说明
： ， ， 。 【 】 ， ， 。 1
2
3
4// 说明
： 。
// 正例： ， ，
// 而在 JDK7 之前， 。 【 】 （ ） （ ） （ ） ， （ ） ， ， private volatile Helper helper = null;。 1
2
3
4
5
6
7
8
9
10
11
12
13// 正例
：
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...
}【 】 。 ， ， ， 。 1
2
3
4// 说明
： ， ：
AtomicInteger count = new AtomicInteger();
count.addAndGet(1);
// 如果是 JDK8， ， （ ） 。 【 】 ， ， 。 【 】 ， 。 1
2// 说明
： ， ， ，
// 也就是说在类第一次被使用时装载， ， 。
控制语句
【 】 ， continue / break / return等来终止， ； ， ， 。 1
// 说明
： ， 。 【 】 ， 。 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22// 反例
： ？
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 / else / for / while / do语句中必须使用大括号。 1
// 说明
： ， ： 【 】 condition ? 表达式 1 : 表达式 2中， ， 。 1
2
3
4
5
6
7
8
9
10
11// 说明
： ：
// 1. 表达式 1 或表达式 2 的值只要有一个是原始类型。
// 2. 表达式 1 或表达式 2 的值的类型不一致， 。
// 反例：
Integer a = 1;
Integer b = 2;
Integer c = null;
Boolean flag = false;
// a * b 的结果是 int 类型， ，
Integer result = (flag ? a * b : c);【 】 ， “ ” 。 1
2
3
4// 说明
： ， “ ” ， 。
// 反例： ， ，
// 但因为并发处理错误导致奖品数量瞬间变成了负数， ， 。 【 】 ， 。 1
// 说明
： ， 。 【 】 ， ， ： 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24if (condition) {
...
return obj;
}
// 接着写 else 的业务逻辑代码;
// 说明： ， ， 。
// 正例： 、 、 ， ：
public void findBoyfriend (Man man) {
if (man.isUgly()) {
System.out.println("本姑娘是外貌协会的资深会员");
return;
}
if (man.isPoor()) {
System.out.println("贫贱夫妻百事哀");
return;
}
if (man.isBadTemper()) {
System.out.println("银河有多远，
return;
}
System.out.println("可以先交往一段时间看看");
}【 】 （ ） ， ， ， 。 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15// 说明
： ， 、 、 ， ， 。
// 如果赋值一个非常好理解的布尔变量名字， 。
// 正例：
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();
}
}【 】 （ ） ， 。 1
2
3
4
5
6
7
8
9// 说明
： ， ， 。
// 反例：
public Lock getLock(boolean fair) {
// 算术表达式中出现赋值操作，
threshold = (count = Integer.MAX_VALUE) - 1;
// 条件表达式中出现赋值操作，
return (sync = fair) ? new FairSync() : new NonfairSync();
}【 】 ， ， 、 、 ， （ ） 。 【 】 。 1
2
3
4
5// 说明
： ， 。
// 正例： 。
// 反例： 。 【 】 ， 。 1
2
3// 反例
： ， ，
// API 文档上有说最多查多少个， ，
// 导致调用方传了一个 1000 的用户 id 数组过来后， ， 。 【 】 ， ： - 调用频次低的方法
。 - 执行时间开销很大的方法
。 - 需要极高稳定性和可用性的方法
。 - 对外提供的开放接口
， 。 - 敏感权限入口
。
- 调用频次低的方法
【 】 ， ： - 极有可能被循环调用的方法
。 。 - 底层调用频度比较高的方法
。 ， 。 ， ， ， 。 - 被声明成 private 只会被自己代码所调用的方法
， ， 。
- 极有可能被循环调用的方法
注释规约
【 】 、 、 ， /** 内容 */格式， // xxx方式。 1
2// 说明
： ， ， ；
// 在 IDE 中， ， 、 、 ， 。 【 】 （ ） 、 、 、 ， ， 。 1
// 说明
： ， ， 。 【 】 。 1
2
3
4
5
6
7
8
9
10// 说明
： ，
// 注意 IDEA 的 @author 为 `${USER}`，
// 而 eclipse 的 @author 为 `${user}`，
// 大小写有区别， 。
// 正例：
/**
* @author yangguanbao
* @date 2016/10/31
*/【 】 ， ， //注释。 /* */注释， 。 【 】 ， 。 【 】 “ ” ， 。 。 1
// 反例
： “ ” “ ” ， 。 【 】 ， ， 、 、 、 。 1
// 说明
： ， ， ， 。 【 】 、 、 ； 。 【 】 。 ， 。 ， 。 1
2
3
4// 说明
： ：
// 1. 后续会恢复此段代码逻辑。
// 2. 永久不用。 ， 。
// 后者建议直接删掉即可， ， 。 【 】 ： 、 ； 、 ， 。 ， ， ， ； ， 。 【 】 、 ， 、 。 ： ， ， 。 1
2
3// 反例
： ， ， ， 。
// put elephant into fridge
put(elephant, fridge);【 】 ， 。 ， ， 。 。 1
2
3
4
5// 说明
：
// 1. 待办事宜（ ） （ ， ， ） ， 。
// 这实际上是一个 Javadoc 的标签， ， 。
// 只能应用于类， （ ） 。
// 2. 错误， （ ） （ ， ， ） ， ， 。
前后端规约
【 】 ， 、 、 、 、 、 、 。 1
2
3
4
5
6
7
8
9
10
11
12
13// 说明
：
// 1. 协议： 。
// 2. 路径： ， ：
// - 代表一种资源， ， ， ， 。
// - URL 路径不能使用大写， ， 。
// - 路径禁止携带表示请求内容类型的后缀， ， 。
// 3. 请求方法： ， ：
// - GET： 。
// - POST： 。
// - PUT： 。
// - DELETE： 。
// 4. 请求内容： ； 。
// 5. 响应体： ， 。 【 】 ， ， 。 1
// 说明
： ， 。 【 】 ， ， 、 、 。 1
2
3
4
5
6
7
8
9
10
11
12// 说明
： 、 、 、 。
// 其中输出给用户的提示信息要求： 、 ， ，
// 提示信息可以包括错误原因、 、 。
// errorCode： 。
// errorMessage： ， ， 。
// 正例：
// 1. 200 OK: 表明该请求被成功地完成， 。
// 2. 401 Unauthorized: 请求要求身份验证， 。
// 3. 403 Forbidden： ， 。
// 4. 404 Not Found: 服务器无法取得所请求的网页， 。
// 5. 500 Internal Server Error: 服务器内部错误。 【 】 ， lowerCamelCase风格， ， 。 1
2// 正例
：
// 反例： 【 】 ， type = "hidden"文字类控件中， ， 。 【 】 ， ， 。 1
2
3
4
5
6
7
8
9
10// 说明
： ，
//（ ： ， ） 。
// Long 类型能表示的最大值是 2 的 63 次方-1， ，
// 超过 2 的 53 次方 (9007199254740992)的数值转化为 JS 的 Number 时， 。
// 扩展说明： ， ， 。
// 若浮点数尾数位与指数位空间不限， ， ， 。
// 反例： ， ，
// 比如， ， 。 【 】 ， 2048字节。 1
2
3
4// 说明
： ， ， 。
// 反例： ，
// 当一次退货商品数量过多时， ， ， 。 【 】 ， ， ， 。 1
2// 说明
： ， ，
// 当确实有业务需要传较大内容时， 。 【 】 ， ， ； ， 。 【 】 ； ， “ ” ， 。 【 】 ， ， 。 1
2
3
4// 说明
： ， 。
// 正例： ， ， ， ，
response.setHeader("Cache-Control", "s-maxage=" + cacheSeconds);【 】 ， 。 1
2
3// 说明
： ， ， ， ， ， 。
// 如果我们使用的面向用户的服务， ， 。
// 此外， ， 、 、 。 【 】 yyyy-MM-dd HH:mm:ss， GMT。 【 】 ， ， 。 1
// 说明
： ， ， 。
其他
【 】 ， ， 。 1
// 说明
： ： “ ” 【 】 。 1
// 说明
： ， ， 。 【 】 ， ， ， （ ） ， 。 1
// 说明
： ， 。 【 】 $!{var}中间的感叹号。 1
// 说明
： ， 。 【 】 Math.random()这个方法返回是double类型， 0 ≤ x < 1（ ， ） ， ， ， 。 【 】 。 1
// 说明
： ， ， 。 【 】 ， ， 。 【 】 。 1
2
3
4
5
6
7
8
9
10// 说明
： ， ， ， 。
// 正例： ， ，
// 在注释代码上方， 。
public static void hello() {
/// 业务方通知活动暂停
// Business business = new Business();
// business.active();
System.out.println("it's finished");
}
异常日志
错误码
【 】 ： 、 。 1
2
3
4
5
6// 说明
： ， ， ， 。
// 正例： ？ ？
// 1. 错误码必须能够快速知晓错误来源， 。
// 2. 错误码必须能够进行清晰地比对（ ） 。
// 3. 错误码有利于团队快速对错误原因达到一致认知。 【 】 。 1
// 说明
： 。 。 【 】 ， ： 。 【 】 ， ， ： 。 1
2
3
4
5// 说明
：
// - A 表示错误来源于用户， ， ， ；
// - B 表示错误来源于当前系统， ， ；
// - C 表示错误来源于第三方服务， ， ；
// 四位数字编号从 0001 到 9999， ， 。 【 】 ， ， ， ， 。 【 】 。 1
// 说明
： 。 【 】 。 1
2// 说明
： （ ） 、 、 （ ） 、 （ ）
// 这是一个有效关联并互相转义的和谐整体， 。 【 】 ， 。 【 】 ， ， ， 。 【 】 、 、 。 1
2
3
4// 说明
： ， ，
// 分别是： （ ） （ ） 、 （ ） 。
// 正例： ， ， 。 【 】 。 【 】 。 1
// 说明
： （ 、 、 ） 。 【 】 ， ， 。 1
2
3
4
5
6
7// 说明
： ， 。
// 反例： ，
// 第 1 位是错误等级，
// 第 2 位是错误来源，
// 第 345 是编号，
// 人的大脑不会主动地拆开并分辨每位数字的不同含义。
异常处理
【 】 RuntimeException异常不应该通过 catch 的方式来处理， ： NullPointerException， IndexOutOfBoundsException等等。 1
2
3
4
5
6
7
8
9
10
11
12
13
14// 说明
： ， ：
// 在解析字符串形式的数字时， ， 。
// 正例：
if (obj != null) {
obj.method();
}
// 反例：
try {
obj.method();
} catch (NullPointerException e) {
...
}【 】 ， 。 1
// 说明
： ， 。 【 】 ， 。 ， 。 1
2// 说明
： ， ， ， 。
// 正例： ， ， ， ， ， 。 【 】 ， ， ， 。 ， ， 。 【 】 ， ， ， 。 【 】 、 ， 。 1
// 说明
： ， 。 【 】 。 1
2
3
4
5
6
7
8
9
10
11
12
13
14// 说明
： ， ， ，
// 如果此处存在 return 语句， ， 。
// 反例：
private int x = 0;
public int checkReturn() {
try {
// x 等于 1，
return ++x;
} finally {
// 返回的结果是 2
return ++x;
}
}【 】 ， ， 。 1
// 说明
： ， ， 。 【 】 、 、 ， 。 1
2
3
4
5// 说明
： ， ， 。
// 什么情况会抛出 NoSuchMethodError 呢？
// 二方包在类冲突时， ，
// 或者在字节码修改框架（ ： ） ， 。
// 这些情况， ， ， 。 【 】 ， ， ， 。 1
2// 说明
： 。 ，
// 对调用者来说， ， 、 、 。 【 】 ， ， ： - 返回类型为基本数据类型
， ， 。 - 数据库的查询结果可能为 null
。 - 集合里的元素即使 isNotEmpty
， 。 - 远程调用返回对象时
， ， 。 - 对于 Session 中获取的数据
， ， 。 - 级联调用 obj.getA().getB().getC()
； ， 。
1
2
3
4
5
6// 正例
： 。
//反例： ， 。
public int f() {
return Integer 对象
}- 返回类型为基本数据类型
【 】 unchecked / checked异常， ， ， 。 ， ： DAOException / ServiceException等。 【 】 ； ； ， 、 、 ； 。 1
2
3
4// 说明
： ：
// 1. 使用抛异常返回方式， 。
// 2. 如果不加栈信息， ， ， 。
// 如果加了栈信息， ， 。
日志规约
【 】 Log4j / Logback中的 API， SLF4J / JCL--Jakarta Commons Logging中的 API， ， 。 1
2
3
4
5
6
7
8
9
10// 说明
： （ 、 ） （ ）
// 使用 SLF4J：
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
private static final Logger logger = LoggerFactory.getLogger(Test.class);
// 使用 JCL：
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
private static final Log log = LogFactory.getLog(Test.class);【 】 ， “ ” 。 ， “ ” ， ， {logname}.log.{保存日期}， ： yyyy-MM-dd1
// 正例
： ， ， 【 】 ， 、 、 ， ， 。 【 】 （ 、 、 ） ： 。 ， ； 。 ： ， ， ， 。 1
2
3// 说明
： ， ， ， 。
// 正例： ， ： 【 】 ， 。 1
2
3
4// 说明
： ， 。
// 使用占位符仅是替换动作， 。
// 正例： 【 】 trace / debug / info级别的日志输出， 。 1
2
3
4
5
6
7
8// 说明
： （ ） ， ，
// 但是参数可能会进行字符串拼接运算。 ， ， 。
// 正例：
// 如果判断为真，
if (logger.isDebugEnabled()) {
logger.debug("Current ID is: {} and name is: {}", id, getName());
}【 】 ， ， additivity=false。 1
// 正例
： 【 】 System.out或System.err输出日志或使用 e.printStackTrace() 打印异常堆栈。 1
2// 说明
： ，
// 如果大量输出送往这两个文件， 。 【 】 ： 。 ， 。 1
// 正例
： 【 】 。 1
2
3// 说明
： ， ， 。
// 正例： 。 【 】 。 ； ； ， ， ， 。 1
2// 说明
： ， ， 。
// 记录日志时请思考： ？ ？ ？ 【 】 ， ， 。 ， ， 。 1
// 说明
： ， 、 。 【 】 ， ， 。 1
// 说明
： ， 。
单元测试
【 】 。 AIR 原则:
- A
： （ ） - I
： （ ） - R
： （ ）
1
2// 说明
： ， （ ） ， ， 。
// 好的单元测试宏观上来说， 、 、 。 - A
【 】 ， 。 ， 。 。 ， 。 【 】 。 ， ， 。 1
// 反例
： ， 。 【 】 ， 。 1
2
3
4
5// 说明
： ， 。
// 如果单测对外部环境（ 、 、 ） ， 。
// 正例： ， ，
// 在测试时用 spring 这样的 DI 框架注入一个本地（ ） 。 【 】 ， ， 。 ， 。 1
2// 说明
： 。
// 单测不负责检查跨类或者跨系统的交互逻辑， 。 【 】 、 、 。 1
// 说明
： ， ， 。 【 】 ： ， 。 1
// 说明
： ， 。 【 】 ： ； 。 1
// 说明
： ， ， ， 。 【 】 ， 。 BCDE 原则
： - B
： ， ， 、 、 、 。 - C
： ， ， 。 - D
： ， ， 。 - E
： ， （ ： 、 、 ） ， 。
- B
【 】 ， ， ， ， ， 。 1
2// 反例
： ， ， ，
// 但是这一行新增数据并不符合业务插入规则， 。 【 】 ， ， 。 。 1
2// 正例
： ：
// 使用 ENTERPRISE_INTELLIGENCE _UNIT_TEST_的前缀来标识单元测试相关代码。 【 】 ， ， 。 【 】 ， ， （ ） 。 【 】 ， ， 。 【 】 ， ： - 构造方法中做的事情过多
。 - 存在过多的全局变量和静态方法
。 - 存在过多的外部依赖
。 - 存在过多的条件语句
。
1
// 说明
： 、 、 。 - 构造方法中做的事情过多
【 】 ： - 那是测试同学干的事情
。 ， 。 - 单元测试代码是多余的
。 。 - 单元测试代码不需要维护
。 ， 。 - 单元测试与线上故障没有辩证关系
。 。
- 那是测试同学干的事情
安全规约
【 】 。 1
// 说明
： 、 、 ， 。 【 】 ， 。 1
// 说明
： ： ， ， 。 【 】 ， ， 。 1
// 反例
： ， ， ， ， 。 【 】 。 1
2
3
4
5
6
7
8
9
10// 说明
： ：
// 1. page size 过大导致内存溢出
// 2. 恶意 order by 导致数据库慢查询
// 3. 缓存击穿
// 4. SSRF
// 5. 任意重定向
// 6. SQL 注入， ，
// 7. 正则输入源串拒绝服务 ReDoS
// Java 代码用正则来验证客户端的输入， ，
// 但是如果攻击人员使用的是特殊构造的字符串来验证， 。 【 】 。 【 】 、 。 1
2
3// 说明
： 。
// 对于存在 CSRF 漏洞的应用/网站， ， ，
// 后台便在用户不知情的情况下对数据库中用户参数进行相应修改。 【 】 。 【 】 ， 、 、 、 、 ， ， 、 、 ， 。 1
// 说明
： ， ， ， 。 【 】 、 、 、 。
数据库
建表规约
【 】 ， ， （ ， ） 。 1
2
3
4
5
6
7// 说明
： ， 。
// 注意： ， ，
// 所以， 。
// 数据库表示是与否的值， ， 。
// 正例： ： ， 。 【 】 、 ， ， 。 ， ， 。 1
2
3
4
5
6// 说明
： ， 。
// 因此， 、 、 ， ， 。
// 正例： ， ，
// 反例： ， ， 【 】 。 1
// 说明
： ， ， ， 。 【 】 ， 、 、 、 ， 。 【 】 ； ； 。 1
// 说明
： ； ； 。 【 】 ， 。 1
2// 说明
： ， ， ， 。
// 如果存储的数据范围超过 decimal 的范围， 。 【 】 ， 。 【 】 ， ， ， ， ， ， ， 。 【 】 ： 。 1
2// 说明
： ， 、 、 。
// create_time, update_time 的类型均为 datetime 类型， ， 。 【 】 “ ” 。 1
// 正例
： 【 】 。 【 】 ， 。 【 】 ， ， 。 ： - 不是频繁修改的字段
。 - 不是唯一索引的字段
。 - 不是 varchar 超长字段
， 。
1
// 正例
： ， 。 - 不是频繁修改的字段
【 】 ， 。 1
// 说明
： ， 。 【 】 ， 、 ， 。 1
// 正例
： ， 。 对象 年龄区间 类型 字节 表示范围 人 150 岁之内 tinyint unsigned 1 无符号值 ： 龟 数百岁 smallint unsigned 2 无符号值 ： 恐龙化石 数千万年 int unsigned 4 无符号值 ： 太阳 约 50 亿年 bigint unsigned 8 无符号值 ：
索引规约
【 】 ， ， 。 1
2// 说明
： ， ， ；
// 另外， ， ， ， 。 【 】 。 ， ； ， 。 1
// 说明
： 、 。 【 】 ， ， ， 。 1
2// 说明
： ， ， ， ，
// 可以使用 count(distinct left(列名, 索引长度))/count(*) 的区分度来确定。 【 】 ， 。 1
// 说明
： ， ， 。 【 】 ， 。 ， ， ， 。 1
2
3// 正例
： ：
// 反例： ， ， ： 。 【 】 ， 。 1
2
3
4
5// 说明
： ， ？
// 目录浏览一下就好， 。
// 正例： 、 、 。
// 而覆盖索引只是一种查询的一种效果， ， ： 。 【 】 。 1
2
3
4
5// 说明
： ， ， ， ，
// 那当 offset 特别大的时候， ， ， 。
// 正例： ， ：
// SELECT t1.* FROM 表 1 as t1, (select id from 表 1 where 条件 LIMIT 100000,20 ) as t2 where t1.id=t2.id【 】 ： ， ， 。 1
2
3
4
5
6
7// 说明
：
// 1. consts 单表中最多只有一个匹配行（ ） ， 。
// 2. ref 指的是使用普通的索引（ ） 。
// 3. range 对索引进行范围检索。
// 反例： ， ， ，
// 速度非常慢， ， 。 【 】 ， 。 1
2
3
4// 说明
： ， ， 。
// 如： ， ， 。
// 正例： ， ， 。 【 】 ， 。 【 】 ： - 索引宁滥勿缺
。 。 - 吝啬索引的创建
。 、 。 - 抵制唯一索引
。 “ ” 。
- 索引宁滥勿缺
SQL 语句
【 】 ， ， ， 。 1
// 说明
： ， 。 【 】 ， ， ， 。 【 】 ， ， ， 。 1
// 正例
： ： 【 】 。 1
2
3
4
5
6
7
8// 说明
： 。
// 1. NULL<>NULL 的返回结果是 NULL， 。
// 2. NULL=NULL 的返回结果是 NULL， 。
// 3. NULL<>1 的返回结果是 NULL， 。
// 反例： ， ， 。
// select * from table where column1 is null and column3 is not null;
// 而 `ISNULL(column)` 是一个整体， 。 ， 。 【 】 ， ， 。 【 】 ， 。 1
2
3
4// 说明
： （ ） ， 。
// 如果更新学生表中的 student_id， ， 。
// 外键与级联更新适用于单机低并发， 、 ；
// 级联更新是强阻塞， ； 。 【 】 ， ， 。 【 】 （ ） ， ， ， 。 【 】 ， ， （ ） 。 1
2
3
4
5
6
7
8// 说明
： 、 、 ，
// 如果对操作列没有限定表的别名（ ） ， ， 。
// 正例：
// 反例： ， （ ） ，
// 正常运行两年后， ， ，
// 线上查询语句出现出 1052 异常： 。 【 】 ， 、 、 、 。 1
2
3
4
5// 说明
：
// 1. 别名可以是表的简称， ， 、 、 。
// 2. 别名前加 as 使别名更容易识别。
// 正例： 【 】 ， ， ， 。 【 】 ， ， ， 。 1
2
3
4// 说明
：
// SELECT LENGTH("轻松工作")；
// SELECT CHARACTER_LENGTH("轻松工作")；
// 如果需要存储表情， ， 。 【 】 ， ， ， ， 。 1
// 说明
： 。
ORM 映射
【 】 ， ， 。 1
2
3
4// 说明
：
// 1. 增加查询分析器解析成本。
// 2. 增减字段容易与 resultMap 配置不一致。
// 3. 无用字段增加网络消耗， 。 【 】 ， ， 。 1
// 说明
： ， ， 。 【 】 ， ， <resultMap>； ， <resultMap>与之对应。 1
// 说明
： ， ， 。 【 】 ： ， 。 【 】 。 1
2
3
4
5
6// 说明
： ， 。
// 正例：
Map<String, Object> map = new HashMap<>(16);
map.put("start", start);
map.put("size", size);【 】 。 1
2// 反例
： ， ，
// 结果出现异常是把 bigint 转成 Long 值， ， ， 。 【 】 ， 。 【 】 。 ， ， 。 ， ， ； ； 。 【 】 。 ， ， 、 、 、 。 【 】 <isEqual>中的 compareValue 是与属性值对比的常量， ， ； <isNotEmpty>表示不为空且不为 null 时执行； <isNotNull>表示不为 null 值时执行。
工程结构
应用分层
【 】 ， ， ： - 默认上层依赖于下层
， ， ： ， ， 。 - 开放 API 层
： ； ； 。 - 终端显示层
： 。 ， ， ， 。 - Web 层
： ， ， 。 - Service 层
： 。 - Manager 层
： ， ： - 对第三方平台封装的层
， ， 。 - 对 Service 层通用能力的下沉
， 、 。 - 与 DAO 层交互
， 。
- 对第三方平台封装的层
- DAO 层
： ， 、 、 、 。 - 第三方服务
： ， ， ， 、 、 。 - 外部数据接口
： （ ） ， 。
block-beta columns 3 终端显示层 开放API层:2 请求处理层/Web层:2 开放API层1<[" "]>(down) 请求处理层<[" "]>(down):2 开放API层2<[" "]>(down) 业务逻辑层/Service层:3 业务逻辑层Id1<[" "]>(down) 通用逻辑层/Manager层:2 业务逻辑层Id2<[" "]>(down) 通用逻辑层<[" "]>(down):2 数据持久层/Dao层:2 第三方服务 id1[("数据储存系统")] 外部数据接口:2- 默认上层依赖于下层
【 】 （ ） ， ， ， ， ， ， ， ， 。 ， ， ， 。 ， ， ， 。 ， ， ， ， 。 。 【 】 ： - DO
（ ） ： ， 。 - DTO
（ ） ： ， 。 - BO
（ ） ： ， 。 - Query
： ， 。 ， 。 - VO
（ ） ： ， 。
- DO
二方库依赖
【 】 ： 1
2
3
4
5
6
7
8// 1. GroupID 格式
： ， 。
// 说明： ： ； 。
// 正例：
// 2. ArtifactID 格式： 。 ， 。
// 正例：
// 3. Version： 。 【 】 ： - 主版本号
： ， ， 。 - 次版本号
： ， ， 。 - 修订号
： ， 、 。
1
2
3// 说明
： ： ， 。
// 反例： ， “ ” ， 。 - 主版本号
【 】 （ ） ； ， ， 。 1
// 说明
： 。 ， 。 【 】 ， 。 ， 。 1
2// 说明
： ， ， ，
// 那么通过 dependency:tree 命令， ， 。 【 】 ， ， 。 【 】 ， ， 。 1
2// 说明
： ， ，
// 可以定义一个变量来保存版本： ， ， 。 【 】 ， ， 。 1
2// 说明
： ， ，
// 只能有一个版本号出现在最后的lib 目录中。 ， 。 【 】 、 、 。 【 】 <dependencies>语句块中， <dependencyManagement>语句块中。 1
2// 说明
： ， ， ， 。
// 而 <dependencies> 所有声明在主 pom 的 <dependencies> 里的依赖都会自动引入， 。 【 】 ， 。 【 】 。 1
// 说明
： ， ， ， ， 。 【 】 ， ： - 精简可控原则
。 ， 、 、 、 、 。 ， ， ； ， 。 - 稳定可追溯原则
。 ， ， ， 。 ， 。
- 精简可控原则
服务器
【 】 。 1
2
3
4
5
6// 说明
： ， ，
// 在高并发访问下， ， ，
// 所以需要在服务器上调小此等待值。
// 正例： （ ） ：
// net.ipv4.tcp_fin_timeout = 30【 】 （ ， ） 。 1
2
3// 说明
： ， 。
// 主流的linux服务器默认所支持最大fd数量为1024， “ ” ， 。
// 建议将 linux 服务器所支持的最大句柄数调高数倍（ ） 。 【 】 ， 。 1
// 说明
： ， ， 。 【 】 ， ， 。 【 】 ； ， “ “ 。 ， 。
设计规约
【 】 ， 。 1
2
3
4
5
6
7
8
9// 说明
： ， ， ，
// 所以， ， ， 。
// 正例：
// 评审内容包括存储介质选型；
// 表结构设计能否满足技术方案；
// 存取性能和存储空间能否满足业务发展；
// 表或字段之间的辩证关系、 、 、 ；
// 数据结构变更（ ） 。 【 】 ， ， 。 【 】 ， 。 1
2
3
4
5
6
7// 说明
： ，
// 首先明确对象有多少种状态，
// 然后明确两两状态之间是否存在直接转换关系，
// 再明确触发状态转换的条件是什么。
// 正例： 、 、 、 、 、 。
// 比如已下单与已收货这两种状态之间是不可能有直接转换关系的。 【 】 ， 。 1
// 说明
： ， 。 【 】 ， ， 。 1
// 说明
： ， ， ， ， 。 【 】 ， ， 。 1
// 说明
： ， ， 。 【 】 ： - 确定系统边界
。 。 - 确定系统内模块之间的关系
。 。 - 确定指导后续设计与演化的原则
。 。 - 确定非功能性需求
。 、 、 。
- 确定系统边界
【 】 ， 。 1
2// 反例
： ， ， ，
// 但是支付宝入款时由于断网演练产生异常， ， 。 【 】 。 1
// 说明
： ， ， ， 。 【 】 ， 。 1
2// 说明
： ， ， ，
// 比如， “ ” ， 、 、 。 【 】 ， ， ， 。 1
// 说明
： ， 。 【 】 ， ， 。 1
// 说明
： ， ， ， 。 【 】 ， 、 、 、 ， ， （ ） 。 1
2
3
4
5// 说明
： ， 。 ， ，
// 在维护代码时， ， 。 ， ， 。
// 正例： ， ，
// 这个时候请抽取： 【 】 ： 。 1
2
3
4
5
6// 说明
： ， ， ，
// 但核心关键点上的必要设计和文档沉淀是需要的。
// 反例： ， ，
// 系统中均是勉强能运行但像面条一样的代码， ，
// 一年之后， ， 。 【 】 、 、 ， 。 1
// 说明
： ， ， 。 【 】 ， 。 1
2
3// 说明
： 。
// 正例： ， ， 。 【 】 。 1
2
3
4
5
6// 说明
： ， ， ，
// 但是大家在设计评审中经常出现语焉不详， 。 ：
// - 表达规则和表达工具的熟练性。
// - 抽象思维和总结能力的局限性。
// - 基础知识体系的完备性。
// - 深入浅出的生动表达力。 【 】 ， ， 。 1
// 说明
： ， ， ， 。 【 】 ， ： - 所有可交互的控件元素必须能被 tab 键聚焦
， 。 - 用于登录校验和请求拦截的验证码均需提供图形验证以外的其它方式
。 - 自定义的控件类型需明确交互方式
。
1
2
3// 正例
： ， ， ，
//“ ， ， ， ” ， 。
// 如果有自定义标签实现的控件设置控件类型可使用 role 属性。 - 所有可交互的控件元素必须能被 tab 键聚焦
名词解释
| 名词 | 解释 |
|---|---|
| POJO |
在本规约中 |
| DO |
阿里巴巴专指数据库表一一对应的 POJO 类 |
| DTO |
数据传输对象 |
| BO |
业务对象 |
| Query |
数据查询对象 |
| VO |
显示层对象 |
| AO |
阿里巴巴专指 Application Object |
| CAS |
解决多线程并行情况下使用锁造成性能损耗的一种机制 |
| GAV |
Maven 坐标 |
| OOP |
本文泛指类 |
| AQS |
利用先进先出队列实现的底层同步工具类 |
| ORM |
对象关系映射 |
| NPE |
空指针异常 |
| OOM |
源于 java.lang.OutOfMemoryError |
| 一方库 |
本工程内部子项目模块依赖的库 |
| 二方库 |
公司内部发布到中央仓库 |
| 三方库 |
公司之外的开源库 |
错误码列表
| 错误码 | 中文描述 | 说明 |
|---|---|---|
| 00000 | 一切 ok | 正确执行后的返回 |
| A 系列 | ||
| A0001 | 用户端错误 | 一级宏观错误码 |
| A0100 | 用户注册错误 | 二级宏观错误码 |
| A0101 | 用户未同意隐私协议 | |
| A0102 | 注册国家或地区受限 | |
| A0110 | 用户名校验失败 | |
| A0111 | 用户名已存在 | |
| A0112 | 用户名包含敏感词 | |
| A0113 | 用户名包含特殊字符 | |
| A0120 | 密码校验失败 | |
| A0121 | 密码长度不够 | |
| A0122 | 密码强度不够 | |
| A0130 | 校验码输入错误 | |
| A0131 | 短信校验码输入错误 | |
| A0132 | 邮件校验码输入错误 | |
| A0133 | 语音校验码输入错误 | |
| A0140 | 用户证件异常 | |
| A0141 | 用户证件类型未选择 | |
| A0142 | 大陆身份证编号校验非法 | |
| A0143 | 护照编号校验非法 | |
| A0144 | 军官证编号校验非法 | |
| A0150 | 用户基本信息校验失败 | |
| A0151 | 手机格式校验失败 | |
| A0152 | 地址格式校验失败 | |
| A0153 | 邮箱格式校验失败 | |
| A0200 | 用户登录异常 | 二级宏观错误码 |
| A0201 | 用户账户不存在 | |
| A0202 | 用户账户被冻结 | |
| A0203 | 用户账户已作废 | |
| A0210 | 用户密码错误 | |
| A0211 | 用户输入密码错误次数超限 | |
| A0220 | 用户身份校验失败 | |
| A0221 | 用户指纹识别失败 | |
| A0222 | 用户面容识别失败 | |
| A0223 | 用户未获得第三方登录授权 | |
| A0230 | 用户登录已过期 | |
| A0240 | 用户验证码错误 | |
| A0241 | 用户验证码尝试次数超限 | |
| A0300 | 访问权限异常 | 二级宏观错误码 |
| A0301 | 访问未授权 | |
| A0302 | 正在授权中 | |
| A0303 | 用户授权申请被拒绝 | |
| A0310 | 因访问对象隐私设置被拦截 | |
| A0311 | 授权已过期 | |
| A0312 | 无权限使用 API | |
| A0320 | 用户访问被拦截 | |
| A0321 | 黑名单用户 | |
| A0322 | 账号被冻结 | |
| A0323 | 非法 IP 地址 | |
| A0324 | 网关访问受限 | |
| A0325 | 地域黑名单 | |
| A0330 | 服务已欠费 | |
| A0340 | 用户签名异常 | |
| A0341 | RSA 签名错误 | |
| A0400 | 用户请求参数错误 | 二级宏观错误码 |
| A0401 | 包含非法恶意跳转链接 | |
| A0402 | 无效的用户输入 | |
| A0410 | 请求必填参数为空 | |
| A0411 | 用户订单号为空 | |
| A0412 | 订购数量为空 | |
| A0413 | 缺少时间戳参数 | |
| A0414 | 非法的时间戳参数 | |
| A0420 | 请求参数值超出允许的范围 | |
| A0421 | 参数格式不匹配 | |
| A0422 | 地址不在服务范围 | |
| A0423 | 时间不在服务范围 | |
| A0424 | 金额超出限制 | |
| A0425 | 数量超出限制 | |
| A0426 | 请求批量处理总个数超出限制 | |
| A0427 | 请求 JSON 解析失败 | |
| A0430 | 用户输入内容非法 | |
| A0431 | 包含违禁敏感词 | |
| A0432 | 图片包含违禁信息 | |
| A0433 | 文件侵犯版权 | |
| A0440 | 用户操作异常 | |
| A0441 | 用户支付超时 | |
| A0442 | 确认订单超时 | |
| A0443 | 订单已关闭 | |
| A0500 | 用户请求服务异常 | 二级宏观错误码 |
| A0501 | 请求次数超出限制 | |
| A0502 | 请求并发数超出限制 | |
| A0503 | 用户操作请等待 | |
| A0504 | WebSocket 连接异常 | |
| A0505 | WebSocket 连接断开 | |
| A0506 | 用户重复请求 | |
| A0600 | 用户资源异常 | 二级宏观错误码 |
| A0601 | 账户余额不足 | |
| A0602 | 用户磁盘空间不足 | |
| A0603 | 用户内存空间不足 | |
| A0604 | 用户 OSS 容量不足 | |
| A0605 | 用户配额已用光 | 蚂蚁森林浇水数或每天抽奖数 |
| A0700 | 用户上传文件异常 | 二级宏观错误码 |
| A0701 | 用户上传文件类型不匹配 | |
| A0702 | 用户上传文件太大 | |
| A0703 | 用户上传图片太大 | |
| A0704 | 用户上传视频太大 | |
| A0705 | 用户上传压缩文件太大 | |
| A0800 | 用户当前版本异常 | 二级宏观错误码 |
| A0801 | 用户安装版本与系统不匹配 | |
| A0802 | 用户安装版本过低 | |
| A0803 | 用户安装版本过高 | |
| A0804 | 用户安装版本已过期 | |
| A0805 | 用户 API 请求版本不匹配 | |
| A0806 | 用户 API 请求版本过高 | |
| A0807 | 用户 API 请求版本过低 | |
| A0900 | 用户隐私未授权 | 二级宏观错误码 |
| A0901 | 用户隐私未签署 | |
| A0902 | 用户摄像头未授权 | |
| A0903 | 用户相机未授权 | |
| A0904 | 用户图片库未授权 | |
| A0905 | 用户文件未授权 | |
| A0906 | 用户位置信息未授权 | |
| A0907 | 用户通讯录未授权 | |
| A1000 | 用户设备异常 | 二级宏观错误码 |
| A1001 | 用户相机异常 | |
| A1002 | 用户麦克风异常 | |
| A1003 | 用户听筒异常 | |
| A1004 | 用户扬声器异常 | |
| A1005 | 用户 GPS 定位异常 | |
| B 系列 | ||
| B0001 | 系统执行出错 | 一级宏观错误码 |
| B0100 | 系统执行超时 | 二级宏观错误码 |
| B0101 | 系统订单处理超时 | |
| B0200 | 系统容灾功能被触发 | 二级宏观错误码 |
| B0210 | 系统限流 | |
| B0220 | 系统功能降级 | |
| B0300 | 系统资源异常 | 二级宏观错误码 |
| B0310 | 系统资源耗尽 | |
| B0311 | 系统磁盘空间耗尽 | |
| B0312 | 系统内存耗尽 | |
| B0313 | 文件句柄耗尽 | |
| B0314 | 系统连接池耗尽 | |
| B0315 | 系统线程池耗尽 | |
| B0320 | 系统资源访问异常 | |
| B0321 | 系统读取磁盘文件失败 | |
| C 系列 | ||
| C0001 | 调用第三方服务出错 | 一级宏观错误码 |
| C0100 | 中间件服务出错 | 二级宏观错误码 |
| C0110 | RPC 服务出错 | |
| C0111 | RPC 服务未找到 | |
| C0112 | RPC 服务未注册 | |
| C0113 | 接口不存在 | |
| C0120 | 消息服务出错 | |
| C0121 | 消息投递出错 | |
| C0122 | 消息消费出错 | |
| C0123 | 消息订阅出错 | |
| C0124 | 消息分组未查到 | |
| C0130 | 缓存服务出错 | |
| C0131 | key 长度超过限制 | |
| C0132 | value 长度超过限制 | |
| C0133 | 存储容量已满 | |
| C0134 | 不支持的数据格式 | |
| C0140 | 配置服务出错 | |
| C0150 | 网络资源服务出错 | |
| C0151 | VPN 服务出错 | |
| C0152 | CDN 服务出错 | |
| C0153 | 域名解析服务出错 | |
| C0154 | 网关服务出错 | |
| C0200 | 第三方系统执行超时 | 二级宏观错误码 |
| C0210 | RPC 执行超时 | |
| C0220 | 消息投递超时 | |
| C0230 | 缓存服务超时 | |
| C0240 | 配置服务超时 | |
| C0250 | 数据库服务超时 | |
| C0300 | 数据库服务出错 | 二级宏观错误码 |
| C0311 | 表不存在 | |
| C0312 | 列不存在 | |
| C0321 | 多表关联中存在多个相同名称的列 | |
| C0331 | 数据库死锁 | |
| C0341 | 主键冲突 | |
| C0400 | 第三方容灾系统被触发 | 二级宏观错误码 |
| C0401 | 第三方系统限流 | |
| C0402 | 第三方功能降级 | |
| C0500 | 通知服务出错 | 二级宏观错误码 |
| C0501 | 短信提醒服务失败 | |
| C0502 | 语音提醒服务失败 | |
| C0503 | 邮件提醒服务失败 | |
学习资源
- 书籍
- Java开发手册
（ ）
- Java开发手册
- 视频
- 华山版
《 》 ： 【 【 】 】
- 华山版
- 文档
- Google Java Style Guide
：
- Google Java Style Guide