Java编程规约（源于阿里，精简版）

Fearless____

已于 2023-07-19 17:27:09 修改

阅读量1.3k

点赞数

分类专栏： Java基础文章标签： java 代码规范

于 2023-03-02 20:14:23 首次发布

本文链接：https://blog.csdn.net/Fearless____/article/details/129292480

版权

Java基础专栏收录该内容

13 篇文章 0 订阅

订阅专栏

一、命名风格

（1）代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束

反例：_name / name$

（2）代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式

正例：alibaba / taobao / youku / hangzhou 等国际通用的名称，可视同英文

反例：getPingfenByName() [评分] / int 价格 = 3

（3）类名使用大驼峰命名法

正例：MarcoPolo / UserDO

（4）方法名、参数名、成员变量、局部变量使用小驼峰命名法

正例： localValue / getHttpMessage()

（5）包名统一用小写

正例： com.alibaba.open.util

（6）常量命名全部大写，单词间用下划线隔开

正例：MAX_STOCK_COUNT

（7）抽象类命名使用 Abstract 或 Base 开头；

异常类命名使用Exception结尾；

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

（8）定义数组的时候，应该 String[ ] args ，而不 String args[ ]

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

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

命名风格总结：

命名的目标就是让人见名知义，因此要先统一格式，比如，看到大驼峰命名就知道是个类名，并且还需要让人知道是个什么类，所以在命名的时候应该避开不适当的缩写、拼音与英文混用等问题

二、代码书写规范

如果使用IDEA进行开发，可以直接使用快捷键 Ctrl+Alt+L 进行代码格式化，格式化遵循以下的准则

（1）大括号的使用约定。如果大括号内为空，直接写为{}即可；如果大括号内不空则：

左大括号前部换行
左大括号后换行
右大括号前换行
右大括号后还有 else 等代码则不换行；表示终止的右大括号后必须换行

（2）一句格式化的代码：if[空格](a[空格]==[空格]b)

该实例可映射出如下规范：

if / for / while / switch / do 等保留字与括号之间都必须加空格
任何二目、三目运算符的左右两边都需要加一个空格（ == 为二目运算符）
左小括号和字符之间不出现空格；同样，右小括号和字符之间也不出现空格

（3）注释的双斜线与注释内容之间有且仅有一个空格

正例：//[空格]注释内容

（4）方法参数在定义和传入时，多个参数逗号后边必须加空格

正例：method("a",[空格]"b",[空格]"c")

以上是代码格式化能帮我们完成的，此外，我们还要遵循如下准则

（1）采用 4 个空格缩进，禁止使用 tab 字符

如果使用 tab 缩进，必须设置1个 tab 为4个空格。IDEA设置 tab 为4个空格时，不能勾选Use tab character

（2）单行字符数限制不超过 120 个，超出需要换行，换行时遵循如下原则：

第二行相对第一行缩进 4 个空格，从第三行开始，不再继续缩进，参考示例
运算符与下文一起换行
方法调用时，多个参数，需要换行时，在逗号后进行
在括号前不要换行，见反例

（3）IDE 的 text file encoding 设置为 UTF-8;IDE 中文件的换行符使用 Unix 格式，不要使用Windiws 格式

三、OOP（面向对象编程）规约

（1）避免通过一个类的对象引用访问此类的静态变量或静态方法，直接用类名来访问即可

（2）相同参数类型，相同业务含义，才可以使用 Java 的可变参数，并且可变参数必须放置在参数列表的最后（提倡尽量不用可变参数编程）

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

正例："test".equals(object)

反例：object.equals("test")

（4）所有的相同类型的包装类对象之间值的比较，全部使用 equals 方法比较，为的是避免128陷阱

（5）构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在 init 方法中

（6）对于POJO类（可以简单的理解为实体类）的规范

所有的 POJO 类属性必须使用包装数据类型
定义 DO/DTO/VO 等 POJO 类时，不要设定任何属性默认值

POJO 类必须写 toString 方法。使用 IDE 的中工具：source> generate toString时，如果继承了另一个 POJO 类，注意在前面加一下 super.toString

四、集合使用

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

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

如果自定义对象做为 Map 的键，那么必须重写 hashCode 和 equals

String 重写了hashCode 和 equals 方法，所以我们可以非常愉快地使用 String 对象作为 key 来使用

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

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

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

例子：

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

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

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

（5）泛型通配符<? extends T>来接收返回的数据，此写法的泛型集合不能使用 add 方法，而<? super T>不能使用 get 方法，做为接口调用赋值时易出错

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

正例：
Iterator<String> iterator = list.iterator(); 
while (iterator.hasNext()) { 
    String item = iterator.next(); 
    if (删除元素的条件) { 
        iterator.remove(); 
    } 
}

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

（7）在 JDK7 版本及以上，Comparator 要满足如下三个条件，不然 Arrays.sort，Collections.sort 会报 IllegalArgumentException 异常

三个条件如下：

x，y 的比较结果和 y，x 的比较结果相反
x>y，y>z，则 x>z
x=y，则 x，z 比较结果和 y，z 比较结果相同

反例：下例中没有处理相等的情况，实际使用中可能会出现异常

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