阿里巴巴规约没有注意的点

Posted 2021-01-06 willvi624

1. 抽象类命名使用 Abstract 或 Base 开头；异常类命名使用 Exception 结尾；测试类
   命名以它要测试的类的名称开始，以 Test 结尾。

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

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

4. 接口类中的方法和属性不要加任何修饰符号（public 也不要加），保持代码的简洁
   性，并加上有效的 Javadoc 注释。尽量不要在接口里定义变量，如果一定要定义变量，肯定是
   与接口方法相关，并且是整个应用的基础常量。

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

6. 领域模型命名规约
   1） 数据对象：xxxDO，xxx 即为数据表名。
   2） 数据传输对象：xxxDTO，xxx 为业务领域相关的名称。
   3） 展示对象：xxxVO，xxx 一般为网页名称。
   4） POJO 是 DO/DTO/BO/VO 的统称，禁止命名成 xxxPOJO。

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

8. public static void main(String[] args) {
   // 缩进 4 个空格
   String say = "hello";
   // 运算符的左右必须有一个空格
   int flag = 0;
   // 关键词 if 与括号之间必须有一个空格，括号内的 f 与左括号，0 与右括号不需要空格
   if (flag == 0) {
   System.out.println(say);
   }
   
   // 左大括号前加空格且不换行；左大括号后换行
   if (flag == 1) {
   System.out.println("world");
   // 右大括号前换行，右大括号后有 else，不用换行
   } else {
   System.out.println("ok");
   // 在右大括号后直接结束，则必须换行
   }
   } 

9. 注释的双斜线与注释内容之间有且仅有一个空格。

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

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

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

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

13. 类内方法定义的顺序依次是：公有方法或保护方法 > 私有方法 > getter/setter
    方法。

14. setter 方法中，参数名称与类成员变量名称一致，this.成员名 = 参数名。在
    getter/setter 方法中，不要增加业务逻辑，增加排查问题的难度。

15. 使用集合转数组的方法，必须使用集合的 toArray(T[] array)，传入的是类型完全
    一样的数组，大小就是 list.size()。
    说明：使用 toArray 带参方法，入参分配的数组空间不够大时，toArray 方法内部将重新分配
    内存空间，并返回新数组地址；如果数组元素个数大于实际所需，下标为[ list.size() ]
    的数组元素将被置为 null，其它数组元素保持原值，因此最好将方法入参数组大小定义与集
    合元素个数一致。
    正例：

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

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

16. 使用工具类 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)也会随之修改。

17. 不要在 foreach 循环里进行元素的 remove/add 操作。remove 元素请使用 Iterator
    方式，如果并发操作，需要对 Iterator 对象加锁。
    正例：

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

    反例：

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

    说明：以上代码的执行结果肯定会出乎大家的意料，那么试一下把“1”换成“2”，会是同样的
    结果吗？ConcurrentModificationException并发修改异常

18. 在 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 比较结果相同。
    反例：下例中没有处理相等的情况，实际使用中可能会出现异常：

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

19. 集合泛型定义时，在 JDK7 及以上，使用 diamond 语法或全省略。
    说明：菱形泛型，即 diamond，直接使用<>来指代前边已经指定的类型。
    正例：

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

20. 集合初始化时，指定集合初始值大小。
    说明：HashMap 使用 HashMap(int initialCapacity) 初始化。
    正例：initialCapacity = (需要存储的元素个数 / 负载因子) + 1。注意负载因子（即 loader
    factor）默认为 0.75，如果暂时无法确定初始值大小，请设置为 16（即默认值）。
    反例：HashMap 需要放置 1024 个元素，由于没有设置容量初始大小，随着元素不断增加，容
    量 7 次被迫扩大，resize 需要重建 hash 表，严重影响性能。

21. 使用 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 值组合集合。

22. 合理利用好集合的有序性(sort)和稳定性(order)，避免集合的无序性(unsort)和
    不稳定性(unorder)带来的负面影响。
    说明：有序性是指遍历的结果是按某种比较规则依次排列的。稳定性指集合每次遍历的元素次
    序是一定的。如：ArrayList 是 order/unsort；HashMap 是 unorder/unsort；TreeSet 是
    order/sort。

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

24. 获取单例对象需要保证线程安全，其中的方法也要保证线程安全。
    说明：资源驱动类、工具类、单例工厂类都需要注意。

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

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

27. SimpleDateFormat 是线程不安全的类，一般不要定义为 static 变量，如果定义为
    static，必须加锁，或者使用 DateUtils 工具类。
    正例：注意线程安全，使用 DateUtils。亦推荐如下处理：
    private static final ThreadLocal df = new ThreadLocal() {
    @Override
    protected DateFormat initialValue() {
    return new SimpleDateFormat("yyyy-MM-dd");
    }
    };
    说明：如果是 JDK8 的应用，可以使用 Instant 代替 Date，LocalDateTime 代替 Calendar，
    DateTimeFormatter 代替 SimpleDateFormat，官方给出的解释：simple beautiful strong
    immutable thread-safe。

28. 高并发时，同步调用应该去考量锁的性能损耗。能用无锁数据结构，就不要用锁；能
    锁区块，就不要锁整个方法体；能用对象锁，就不要用类锁。
    说明：尽可能使加锁的代码块工作量尽可能的小，避免在锁代码块中调用 RPC 方法。

29. 对多个资源、数据库表、对象同时加锁时，需要保持一致的加锁顺序，否则可能会造
    成死锁。
    说明：线程一需要对表 A、B、C 依次全部加锁后才可以进行更新操作，那么线程二的加锁顺序
    也必须是 A、B、C，否则可能出现死锁。

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

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

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

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

34. 在并发场景下，通过双重检查锁（double-checked locking）实现延迟初始化的优
    化问题隐患(可参考 The "Double-Checked Locking is Broken" Declaration)，推荐解
    决方案中较为简单一种（适用于 JDK5 及以上版本），将目标属性声明为 volatile 型。
    反例：

    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...
    } 

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

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

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

38. 表达异常的分支时，少用 if-else 方式，这种方式可以改写成：

    if (condition) {
        ...
        return obj;
    }

    // 接着写 else 的业务逻辑代码;
    说明：如果非得使用 if()...else if()...else...方式表达逻辑，【强制】避免后续代码维
    护困难，请勿超过 3 层。
    正例：超过 3 层的 if-else 的逻辑判断代码可以使用卫语句、策略模式、状态模式等来实现，
    其中卫语句示例如下：

    public void today() {
        if (isBusy()) {
            System.out.println(“change time.”);
            return;
        }
        if (isFree()) {
            System.out.println(“go to travel.”);
            return;
        }
        System.out.println(“stay at home to learn Alibaba Java Coding Guidelines.”);
        return;
    }

39. 除常用方法（如 getXxx/isXxx）等外，不要在条件判断中执行其它复杂的语句，将
    复杂逻辑判断的结果赋值给一个有意义的布尔变量名，以提高可读性。
    说明：很多 if 语句内的逻辑相当复杂，阅读者需要分析条件表达式的最终结果，才能明确什么
    样的条件执行什么样的语句，那么，如果阅读者分析逻辑表达式错误呢？
    正例：
    // 伪代码如下

    final boolean existed = (file.open(fileName, "w") != null) && (...) || (...);
        if (existed) {
            ...
        }
    反例：
    if ((file.open(fileName, "w") != null) && (...) || (...)) {
        ...
    }

40. 及时清理不再使用的代码段或配置信息。
    说明：对于垃圾代码或过时配置，坚决清理干净，避免程序过度臃肿，代码冗余。
    正例：对于暂时被注释掉，后续可能恢复使用的代码片断，在注释代码上方，统一规定使用三
    个斜杠(///)来说明注释掉代码的理由。

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

42. 表名、字段名必须使用小写字母或数字，禁止出现数字开头，禁止两个下划线中间只
    出现数字。数据库字段名的修改代价很大，因为无法进行预发布，所以字段名称需要慎重考虑。
    说明：mysql 在 Windows 下不区分大小写，但在 Linux 下默认是区分大小写。因此，数据库名、
    表名、字段名，都不允许出现任何大写字母，避免节外生枝。
    正例：aliyun_admin，rdc_config，level3_name
    反例：AliyunAdmin，rdcConfig，level_3_name

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

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

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

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

47. 如果有 order by 的场景，请注意利用索引的有序性。order by 最后的字段是组合
    索引的一部分，并且放在索引组合顺序的最后，避免出现 file_sort 的情况，影响查询性能。
    正例：where a=? and b=? order by c; 索引：a_b_c
    反例：索引中有范围查找，那么索引有序性无法利用，如：WHERE a>10 ORDER BY b; 索引
    a_b 无法排序。

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

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

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

51. POJO 类的布尔属性不能加 is，而数据库字段必须加 is_，要求在 resultMap 中进行
    字段与属性之间的映射。
    说明：参见定义 POJO 类以及数据库字段定义规定，在中增加映射，是必须的。
    在 MyBatis Generator 生成的代码中，需要进行对应的修改。

52. 不要用 resultClass 当返回参数，即使所有类属性名与数据库字段一一对应，也需
    要定义；反过来，每一个表也必然有一个 POJO 类与之对应。
    说明：配置映射关系，使字段与 DO 类解耦，方便维护。

53. iBATIS 自带的 queryForList(String statementName,int start,int size)不推
    荐使用。
    说明：其实现方式是在数据库取到statementName对应的SQL语句的所有记录，再通过subList
    取 start,size 的子集合。

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

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

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

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

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