阿里编码规范重点内容讲解

阿里编码规范重点内容讲解

一、编码风格：

1.命名风格

驼峰命名法

不能以下划线或美元符号开始，也不能以下划线或美元符号结束

常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚

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

类型与中括号紧挨相连来定义数组。 public static void main(String[] args) { … }

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

包名：com.thunisoft.*

2.常量定义

不允许任何魔法值（即未经预先定义的常量）直接出现在代码中。

long 或者 Long 初始赋值时，使用大写的 L，不能是小写的 l，小写容易跟数字 1 混 淆，造成误解。

eg. Long a = 2L

3.代码格式

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");
    // 在右大括号后直接结束，则必须换行
    }
}   

4.oop规约

手册6-9页 1-12重点 17 18 19 20比较常用的方面

5.集合处理

【强制】关于 hashCode 和 equals 的处理，遵循如下规则：

​ 1） 只要重写 equals，就必须重写 hashCode。

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

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

【强制】ArrayList的subList结果不可强转成ArrayList，否则会抛出ClassCastException 异常，即 java.util.RandomAccessSubList cannot be cast to java.util.ArrayList.

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

【强制】使用集合转数组的方法，必须使用集合的 toArray(T[] array)，传入的是类型完全 一样的数组，大小就是 list.size()。

List<String> list = new ArrayList