阿里Java开发手册[泰山版] 关键速记 ?

骑猪看日落 2023-03-14 05:29 13阅读 0赞

>    
> 
> 刚刚过了一下阿里Java开发手册,发现很多内容都满重要.这里挑了比较重要,或者容易踩的坑进行了记录.
> 
> 看到条数不要害怕,其实很多都是常识,为了加深一下印象而已.
> 
>

**Table of Contents**

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

2.Object 的 equals 方法容易抛空指针异常，应使用常量或确定有值的对象来调用equals。

3.所有整型包装类对象之间值的比较，全部使用 equals 方法比较。

4.浮点数之间的等值判断，基本数据类型不能用==来比较，包装数据类型不能用 equals 来判断。

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

6.禁止使用构造方法 BigDecimal(double)的方式把 double 值转化为 BigDecimal 对象。

7.慎改serialVersionUID 字段

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

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

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

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

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

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

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

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

16. 线程池不允许使用 Executors 去创建

17. SimpleDateFormat 是线程不安全的类

18. 必须回收自定义的 ThreadLocal 变量

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

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

21.Timer 异常情况注意

22. CountDownLatch 异常情况注意

23.避免 Random 实例被多线程使用

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

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

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

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

29.获取当前毫秒数

30.日期格式化时，传入 pattern 中表示年份统一使用小写的 y。

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

33.防止 NPE，注意 NPE 产生的场景：

34.日志存储规约

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

36.避免重复打印日志，浪费磁盘空间，务必在 log4j.xml 中设置 additivity=false。

37.生产环境禁止输出 debug 日志

38.单元测试中不准使用 System.out 来进行人肉验证，必须使用 assert 来验证。

39.小数类型为 decimal，禁止使用 float 和 double。

40.varchar优化

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

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

43.超过三个表禁止 join。

44.在 varchar 字段上建立索引时，必须指定索引长度，没必要对全字段建立索引，根据实际文本区分度决定索引长度即可。

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

46.利用延迟关联或者子查询优化超多分页场景。

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

48.不要使用 count(列名)或 count(常量)来替代 count(\*).

49.count(distinct col) 计算该列除 NULL 之外的不重复行数

50.当某一列的值全是 NULL 时，count(col)的返回结果为 0，但 sum(col)的返回结果为 NULL，因此使用 sum()时需注意 NPE 问题。

51.使用 ISNULL()来判断是否为 NULL 值。

52. 不得使用外键与级联，一切外键概念必须在应用层解决。

53.禁止使用存储过程，存储过程难以调试和扩展，更没有移植性

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

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

56.TRUNCATE 不建议在开发代码中使用。

57.在表查询中，一律不要使用 \* 作为查询的字段列表

58.POJO 类的布尔属性不能加 is，而数据库字段必须加 is\_，要求在 resultMap 中进行字段与属性之间的映射。

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

60.@Transactional 事务不要滥用。

--------------------

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

说明：在本文 MySQL 规约中的建表约定第一条，表达是与否的值采用 is\_xxx 的命名方式，所以，需要在<resultMap>设置从 is\_xxx 到 xxx 的映射关系。

反例：定义为基本数据类型 Boolean isDeleted 的属性，它的方法也是 isDeleted()，RPC 框架在反向解析的时候，“误以为”对应的属性名称是 deleted，导致属性获取不到，进而抛出异常。

### 2.Object 的 equals 方法容易抛空指针异常，应使用常量或确定有值的对象来调用equals。 ###

正例："test".equals(object);

反例：object.equals("test");

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

### 3.所有整型包装类对象之间值的比较，全部使用 equals 方法比较。 ###

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

### 4.浮点数之间的等值判断，基本数据类型不能用==来比较，包装数据类型不能用 equals 来判断。 ###

说明：浮点数采用“尾数+阶码”的编码方式，类似于科学计数法的“有效数字+指数”的表示方式。二进制无法精确表示大部分的十进制小数

反例：

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
    }

正例：

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.equals(y)) { 
            System.out.println("true"); 
        }

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

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

反例：某个案例的数据库表 id 字段定义类型 bigint unsigned，实际类对象属性为 Integer，随着 id 越来越大，超过 Integer 的表示范围而溢出成为负数。

### 6.禁止使用构造方法 BigDecimal(double)的方式把 double 值转化为 BigDecimal 对象。 ###

说明：BigDecimal(double)存在精度损失风险，在精确计算或值比较的场景中可能会导致业务逻辑异常。

正例：优先推荐入参为 String 的构造方法，或使用 BigDecimal 的 valueOf 方法，此方法内部其实执行了 Double 的 toString，而 Double 的 toString 按 double 的实际能表达的精度对尾数进行了截断。

代码示例如下:

BigDecimal g = new BigDecimal(0.1f);
            BigDecimal recommend1 = new BigDecimal("0.1");
            BigDecimal recommend2 = BigDecimal.valueOf(0.1);
            System.out.println(g);
            System.out.println(recommend1);
            System.out.println(recommend2);
    
    ------------- 输出结果 --------------------------------------------
    
            0.100000001490116119384765625
            0.1
            0.1

### 7.慎改serialVersionUID 字段 ###

序列化类新增属性时，请不要修改 serialVersionUID 字段，避免反序列失败；如果完全不兼容升级，避免反序列化混乱，那么请修改 serialVersionUID 值。

说明：注意 serialVersionUID 不一致会抛出序列化运行时异常。

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

1.只要覆写 equals，就必须覆写 hashCode。

2.因为 Set 存储的是不重复的对象，依据 hashCode 和 equals 进行判断，所以 Set 存储的对象必须覆写这两个方法。

3.如果自定义对象作为 Map 的键，那么必须覆写 hashCode 和 equals。说明：String 已覆写 hashCode 和 equals 方法，所以我们可以愉快地使用 String 对象作为 key 来使用。

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

反例：直接使用 toArray 无参方法存在问题，此方法返回值只能是 Object\[\]类，若强转其它类型数组将出

现 ClassCastException 错误。

正例：

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

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

> 1.等于 0，动态创建与 size 相同的数组，性能最好。
> 
> 2.大于 0 但小于 size，重新创建大小等于 size 的数组，增加 GC 负担。
> 
> 3.等于 size，在高并发情况下，数组创建完成之后，size 正在变大的情况下，负面影响与上相同。
> 
> 4.大于 size，空间浪费，且在 size 处插入 null 值，存在 NPE 隐患。

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

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

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

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

String[] str = new String[] { "yang", "hao" };
            List list = Arrays.asList(str);
    
            //报错 Exception java.lang.UnsupportedOperationException
            list.add("yangguanbao");
    
            // 会更改 list中的结果
            str[0] = "changed";
    
            System.out.println(list.get(0));

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

remove 元素请使用 Iterator 方式，如果并发操作，需要对 Iterator 对象加锁。

正例：

List<String> list = new ArrayList<>();
 list.add("1");
 list.add("2");
 
 
 Iterator<String> iterator = list.iterator();
 while (iterator.hasNext()) {
 String item = iterator.next();
 
 if ("1".equalsIgnoreCase(item)) {
 iterator.remove();
 }
 }

反例：

List<String> list = new ArrayList<>();
 list.add("1");
 list.add("2");
 
 for (String item : list) {
 if ("1".equals(item)) {
 list.remove(item);
 }
 }

说明：以上代码的执行结果, 移除"1," 不会报错 . 移除"2", 抛出:  java.util.ConcurrentModificationException

### 13. 集合初始化时，指定集合初始值大小 ###

说明：HashMap 使用 HashMap(int initialCapacity) 初始化。

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

反例：HashMap 需要放置 1024 个元素，由于没有设置容量初始大小，随着元素不断增加，容量 7 次被迫扩大，resize 需要重建 hash 表，严重影响性能。

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

说明：keySet 其实是**遍历了 2 次**，一次是转为 Iterator 对象，另一次是从 hashMap 中取出 key 所对应的 value。

而 entrySet 只是遍历了一次就把 key 和 value 都放到了 entry 中，效率更高。如果是 JDK8，使用 Map.forEach 方法。

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

Map map = new HashMap();
            map.put(1,2);
            map.put(2,2);
            map.put(3,2);
            map.put(4,2);
    
            map.forEach(new BiConsumer() {
                @Override
                public void accept(Object o, Object o2) {
                    System.out.println(o + "=>" +  o2);
                }
            });
    
            map.forEach((k,v)->{
                System.out.println(k + " = > " + v);
            });

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

<table style="margin-left:38.4pt;"> 
 <tbody> 
 <tr> 
 <td style="border-color:#dddddd;width:107.3pt;"> 集合类 </td> 
 <td style="border-color:#dddddd;width:150px;"> Key </td> 
 <td style="border-color:#dddddd;width:110px;"> Value </td> 
 <td style="border-color:#dddddd;width:169px;"> Super </td> 
 <td style="border-color:#dddddd;width:277px;"> 说明 </td> 
 </tr> 
 <tr> 
 <td style="border-color:#dddddd;width:107.3pt;"> Hashtable </td> 
 <td style="width:150px;"> 不允许为 null </td> 
 <td style="width:110px;"> 不允许为 null </td> 
 <td style="width:169px;"> Dictionary </td> 
 <td style="width:277px;"> 线程安全 </td> 
 </tr> 
 <tr> 
 <td style="border-color:#dddddd;width:107.3pt;"> ConcurrentHashMap </td> 
 <td style="width:150px;"> 不允许为 null </td> 
 <td style="width:110px;"> 不允许为 null </td> 
 <td style="width:169px;"> AbstractMap </td> 
 <td style="width:277px;"> 锁分段技术（JDK8:CAS） </td> 
 </tr> 
 <tr> 
 <td style="border-color:#dddddd;width:107.3pt;"> TreeMap </td> 
 <td style="width:150px;"> 不允许为 null </td> 
 <td style="width:110px;"> 允许为 null </td> 
 <td style="width:169px;"> AbstractMap </td> 
 <td style="width:277px;"> 线程不安全 </td> 
 </tr> 
 <tr> 
 <td style="border-color:#dddddd;width:107.3pt;"> HashMap </td> 
 <td style="width:150px;"> 允许为 null </td> 
 <td style="width:110px;"> 允许为 null </td> 
 <td style="width:169px;"> AbstractMap </td> 
 <td style="width:277px;"> 线程不安全 </td> 
 </tr> 
 </tbody> 
</table>

反例：由于 HashMap 的干扰，很多人认为 ConcurrentHashMap 是可以置入 null 值，而事实上，存储 null 值时会抛出 NPE 异常。

### 16. 线程池不允许使用 Executors 去创建 ###

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

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

1.FixedThreadPool 和 SingleThreadPool：

允许的请求队列长度为 Integer.MAX\_VALUE，可能会堆积大量的请求，从而导致 OOM。

2.CachedThreadPool：

允许的创建线程数量为 Integer.MAX\_VALUE，可能会创建大量的线程，从而导致 OOM。

### 17. SimpleDateFormat 是线程不安全的类 ###

1.  SimpleDateFormat 是线程不安全的类，一般不要定义为 static 变量，如果定义为 static，必须加锁，或者使用 DateUtils 工具类。正例：注意线程安全，使用 DateUtils。亦推荐如下处理：

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

说明：如果是 JDK8 的应用，可以使用 Instant 代替 Date，LocalDateTime 代替 Calendar，

DateTimeFormatter 代替 SimpleDateFormat，官方给出的解释：simple beautiful strong immutable thread-safe。

LocalDateTime rightNow= LocalDateTime.now();
            String date=DateTimeFormatter.ISO_LOCAL_DATE.format(rightNow);
            System.out.println(date);
            
            DateTimeFormatter formatter=DateTimeFormatter.ofPattern("YYYY-MM-dd HH:mm:ss");
            System.out.println(formatter.format(rightNow));

### 18. 必须回收自定义的 ThreadLocal 变量 ###

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

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

正例：

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

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

说明：Lock 对象的 unlock 方法在执行时，它会调用 AQS 的 tryRelease 方法（取决于具体实现类），如果  
当前线程不持有锁，**则抛出 IllegalMonitorStateException 异常**

正例：

public static void main(String[] args) {
    
            Lock lock = new ReentrantLock();
            // ...
            boolean isLocked = lock.tryLock();
            if (isLocked) {
                try {
                    //todo
                } finally {
                    lock.unlock();
                }
            }
    
    
        }

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

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

### 21.Timer 异常情况注意 ###

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

### 22. CountDownLatch 异常情况注意 ###

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

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

### 23.避免 Random 实例被多线程使用 ###

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

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

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

24. Double-Checked Locking is Broken

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

问题隐患(可参考 The "**Double-Checked Locking is Broken" Declaration**)，推荐解决方案中较为简单一种（适用于 JDK5 及以上版本），将目标属性声明为 volatile 型。

public class LazyInitDemo {
            // 注意一定要加volatile 
            private  volatile   Object helper = null;
            public Object getHelper() {
                if (helper == null) {
                    synchronized(this) {
                        if (helper == null)
                            helper = new Object();
                    }
    
                }
                return helper;
            }
        }

### 25.volatile 解决多线程内存不可见问题 ###

对于一写多读，是可以解决变量同步问题，但是如果多写，同样无法解决线程安全问题。

说明：如果是 count++操作，使用如下类实现：AtomicInteger count = new AtomicInteger(); count.addAndGet(1); 如果是 JDK8，推荐使用 LongAdder 对象，比 AtomicLong 性能更好（减少乐观锁的重试次数）。

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

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");
            }
        }
    
    ----------------------------------------------
    
    Exception in thread "main" java.lang.NullPointerException
    	at com.alibaba.SwitchTest.method(SwitchTest.java:10)
    	at com.alibaba.SwitchTest.main(SwitchTest.java:5)

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

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

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

反例：判断剩余奖品数量等于 0 时，终止发放奖品，但因为并发处理错误导致奖品数量瞬间变成了负数，这样的话，活动无法终止。

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

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

### 29.获取当前毫秒数 ###

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

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

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

### 30.日期格式化时，传入 pattern 中表示年份统一使用小写的 y。 ###

日期格式化时，传入 pattern 中表示年份统一使用小写的 y。

说明：日期格式化时，yyyy表示当天所在的年，而大写的YYYY代表是week in which year

（JDK7 之后引入的概念），意思是当天所在的周属于的年份，一周从周日开始，周六结束，只要本周跨年，返回的YYYY就是下一年。另外需要注意：

*   *  表示月份是大写的 M
     *  表示分钟则是小写的 m
     *  24 小时制的是大写的 H
     *  12 小时制的则是小写的 h

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

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

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

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

32.不要在 finally 块中使用 return。

说明：try 块中的 return 语句执行成功后，并不马上返回，而是继续执行 finally 块中的语句，如果此处存在 return 语句，则在此直接返回，无情丢弃掉 try 块中的返回点。

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

### 33.防止 NPE，注意 NPE 产生的场景： ###

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

反例：public int f() \{ return Integer 对象\}， 如果为 null，自动解箱抛 NPE。

1.  数据库的查询结果可能为 null。
2.  集合里的元素即使 isNotEmpty，取出的数据元素也可能为 null。
3.  远程调用返回对象时，一律要求进行空指针判断，防止 NPE。
4.  对于 Session 中获取的数据，建议进行 NPE 检查，避免空指针。
5.  级联调用 obj.getA().getB().getC()；一连串调用，易产生 NPE。

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

### 34.日志存储规约 ###

所有日志文件至少保存 15 天，因为有些异常具备以“周”为频次发生的特点。网络运行状态、安全相关信息、系统监测、管理后台操作、用户敏感操作需要留存相关的网络日志不少于 6 个月。

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

说明：因为 String 字符串的拼接会使用 StringBuilder 的 append()方式，有一定的性能损耗。使用占位符仅是替换动作，可以有效提升性能。

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

### 36.避免重复打印日志，浪费磁盘空间，务必在 log4j.xml 中设置 additivity=false。 ###

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

### 37.生产环境禁止输出 debug 日志 ###

谨慎地记录日志。生产环境禁止输出 debug 日志；有选择地输出 info 日志；如果使用 warn 来记录刚上线时的业务行为信息，一定要注意日志输出量的问题，避免把服务器磁盘撑爆，并记得及时删除这些观察日志。

说明：大量地输出无效日志，不利于系统性能提升，也不利于快速定位错误点。记录日志时请思考：这些日志真的有人看吗？看到这条日志你能做什么？能不能给问题排查带来好处

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

可以使用 warn 日志级别来记录用户输入参数错误的情况，避免用户投诉时，无所适从。

### 38.单元测试中不准使用 System.out 来进行人肉验证，必须使用 assert 来验证。 ###

### 39.小数类型为 decimal，禁止使用 float 和 double。 ###

说明：在存储的时候，float 和 double 都存在精度损失的问题，很可能在比较值的时候，得到不正确的结果。如果存储的数据范围超过 decimal 的范围，建议将数据拆成整数和小数并分开存储。

### 40.varchar优化 ###

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

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

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

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

说明：不要以为唯一索引影响了 insert 速度，这个速度损耗可以忽略，但提高查找速度是明显的；另外，即使在应用层做了非常完善的校验控制，只要没有唯一索引，根据墨菲定律，必然有脏数据产生。

### 43.超过三个表禁止 join。 ###

需要 join 的字段，数据类型必须绝对一致；多表关联查询时，保证被关联的字段需要有索引。

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

### 44.在 varchar 字段上建立索引时，必须指定索引长度，没必要对全字段建立索引，根据实际文本区分度决定索引长度即可。 ###

说明：索引的长度与区分度是一对矛盾体，一般对字符串类型数据，长度为 20 的索引，区分度会高达

90%以上，可以使用 count(distinct left(列名, 索引长度))/count(\*)的区分度来确定。

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

说明：索引文件具有 B-Tree 的最左前缀匹配特性，如果左边的值未确定，那么无法使用此索引。

### 46.利用延迟关联或者子查询优化超多分页场景。 ###

说明：MySQL 并不是跳过 offset 行，而是取 offset+N 行，然后返回放弃前 offset 行，返回 N 行，那当 offset 特别大的时候，效率就非常的低下，要么控制返回的总页数，要么对超过特定阈值的页数进行 SQL 改写。

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

>       SELECT a.\* FROM 表 1 a, (select id from 表 1 where 条件 LIMIT 100000,20 ) b where a.id=b.id

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

说明：

1.  consts 单表中最多只有一个匹配行（主键或者唯一索引），在优化阶段即可读取到数据。
2.  ref 指的是使用普通的索引（normal index）。
3.  range 对索引进行范围检索。

反例：explain 表的结果，type=index，索引物理文件全扫描，速度非常慢，这个 index 级别比较 range 还低，与全表扫描是小巫见大巫。

### 48.不要使用 count(列名)或 count(常量)来替代 count(\*). ###

count(\*)是 SQL92 定义的标准统计行数的语法，跟数据库无关，跟 NULL 和非 NULL 无关。

说明：count(\*)会统计值为 NULL 的行，而 count(列名)不会统计此列为 NULL 值的行。

### 49.count(distinct col) 计算该列除 NULL 之外的不重复行数 ###

注意 count(distinct col1, col2) 如果其中一列全为 NULL，那么即使另一列有不同的值，也返回为 0。

### 50.当某一列的值全是 NULL 时，count(col)的返回结果为 0，但 sum(col)的返回结果为 NULL，因此使用 sum()时需注意 NPE 问题。 ###

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

### 51.使用 ISNULL()来判断是否为 NULL 值。 ###

说明：NULL 与任何值的直接比较都为 NULL。

1. NULL<>NULL 的返回结果是 NULL，而不是 false。
2. NULL=NULL 的返回结果是 NULL，而不是 true。
3. NULL<>1 的返回结果是 NULL，而不是 true。

### 52. 不得使用外键与级联，一切外键概念必须在应用层解决。 ###

说明：以学生和成绩的关系为例，学生表中的 student\_id 是主键，那么成绩表中的 student\_id 则为外键。如果更新学生表中的 student\_id，同时触发成绩表中的 student\_id 更新，即为级联更新。

外键与级联更新适用于单机低并发，不适合分布式、高并发集群；级联更新是强阻塞，存在数据库更新风暴的风险；

外键影响数据库的插入速度。

### 53.禁止使用存储过程，存储过程难以调试和扩展，更没有移植性 ###

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

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

说明：

SELECT LENGTH("轻松工作")； 返回为 12

SELECT CHARACTER\_LENGTH("轻松工作")； 返回为 4

如果需要存储表情，那么选择 utf8mb4 来进行存储，注意它与 utf-8 编码的区别。

### 56.TRUNCATE 不建议在开发代码中使用。 ###

TRUNCATE TABLE 比 DELETE 速度快，且使用的系统和事务日志资源少，但TRUNCATE 无事务且不触发 trigger，有可能造成事故，故不建议在开发代码中使用此语句。

说明：TRUNCATE TABLE 在功能上与不带 WHERE 子句的 DELETE 语句相同。

### 57.在表查询中，一律不要使用 \* 作为查询的字段列表 ###

在表查询中，一律不要使用 \* 作为查询的字段列表，需要哪些字段必须明确写明。

说明：

1）增加查询分析器解析成本。

2）增减字段容易与 resultMap 配置不一致。

3）无用字段增加网络消耗，尤其是 text 类型的字段。

### 58.POJO 类的布尔属性不能加 is，而数据库字段必须加 is\_，要求在 resultMap 中进行字段与属性之间的映射。 ###

说明：参见定义 POJO 类以及数据库字段定义规定，在<resultMap>中增加映射，是必须的。在

MyBatis Generator 生成的代码中，需要进行对应的修改。

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

### 60.@Transactional 事务不要滥用。 ###

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

阿里Java开发手册[泰山版] 关键速记 ?

发表评论取消回复

还没有评论，来说两句吧...

相关阅读

相关阿里巴巴开发手册2020泰山版和嵩山版资源记录分享！

相关最新《阿里巴巴Java开发手册》华山版、泰山版、嵩山版速来领取！

相关阿里《Java开发手册》最新嵩山版发布！

相关阿里Java开发手册[泰山版] 关键速记 ?

相关阿里巴巴《Java 开发手册》2020 最新版泰山版阿里云官方免费免积分下载地址

相关 Java开发手册泰山版PDF下载

相关阿里Java开发手册（嵩山版）与阿里Java开发手册（泰山版）完整版下载！！

相关【文档】阿里巴巴泰山版Java开发手册下载地址

相关阿里正式发布《Java开发手册》终极版！

相关速来，围观阿里出品的泰山版Java开发手册