JAVA代码规范（一）

阿里巴巴Java开发手册（华山版）

链接: https://pan.baidu.com/s/1ze_XDwIPY1hC7EqpG_yv5w
提取码：zk04
根据开发手册和日常开发，总结部分容易忽略和需要注意的地方。
JAVA代码规范（二）
JAVA代码规范（三）
JAVA代码规范（四）

一、编程规约

（一）命名规范

1、方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格，必须遵 从驼峰形式。
正例： localValue / getHttpMessage() / inputUserId
2、抽象类命名使用Abstract或Base开头；异常类命名使用Exception 结尾；测试类 命名以它要测试的类的名称开始，以Test结尾。
3、常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字 长。
正例：MAX_STOCK_COUNT / CACHE_EXPIRED_TIME
4、抽象类命名使用Abstract或Base开头；异常类命名使用Exception 结尾；测试类命名以它要测试的类的名称开始，以Test结尾。
5、POJO类中布尔类型变量都不要加is前缀，否则部分框架解析会引起序列化错误。
说明：在本文 MySQL 规约中的建表约定第一条，表达是与否的值采用 is_xxx 的命名方式，所以，需要在 设置从 is_xxx到 xxx的映射关系。
反例：定义为基本数据类型 Boolean isDeleted 的属性，它的方法也是 isDeleted()，RPC框架在反向解 析的时候，“误以为”对应的属性名称是 deleted，导致属性获取不到，进而抛出异常。
6、包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使 用单数形式，但是类名如果有复数含义，类名可以使用复数形式。
正例：应用工具类包名为 com.alibaba.ai.util、类名为 MessageUtils（此规则参考 spring 的框架结构）
7、如果模块、接口、类、方法使用了设计模式，在命名时需体现出具体模式。 说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计理念。
正例：

public class OrderFactory;
public class LoginProxy;
public class ResourceObserver;

8、接口类中的方法和属性不要加任何修饰符号（public 也不要加），保持代码的简洁 性，并加上有效的Javadoc注释。尽量不要在接口里定义变量，如果一定要定义变量，肯定 是与接口方法相关，并且是整个应用的基础常量。
正例：接口方法签名 void commit();
接口基础常量 String COMPANY = “alibaba”;
9、接口和实现类的命名有两套规则：
1）【强制】对于 Service和 DAO类，基于 SOA 的理念，暴露出来的服务一定是接口，内部的实现类用 Impl的后缀与接口区别。
正例：CacheServiceImpl 实现 CacheService 接口。
2） 【推荐】如果是形容能力的接口名称，取对应的形容词为接口名（通常是–able 的形容词）。
正例：AbstractTranslator 实现 Translatable 接口。
10、各层命名规约：
A) Service/DAO 层方法命名规约
1） 获取单个对象的方法用 get 做前缀。
2） 获取多个对象的方法用 list 做前缀，复数形式结尾如：listObjects。
3） 获取统计值的方法用 count 做前缀。
4） 插入的方法用save/insert 做前缀。
5） 删除的方法用remove/delete 做前缀。
6） 修改的方法用update 做前缀。
B) 领域模型命名规约
1） 数据对象：xxxDO，xxx 即为数据表名。
2） 数据传输对象：xxxDTO，xxx为业务领域相关的名称。
3） 展示对象：xxxVO，xxx一般为网页名称。
4） POJO是 DO/DTO/BO/VO的统称，禁止命名成 xxxPOJO。

（二）常量定义

1、如果变量值仅在一个固定范围内变化用enum类型来定义。
说明：如果存在名称之外的延伸属性应使用 enum类型，下面正例中的数字就是延伸信息，表示一年中的 第几个季节。
正例：

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

（三）代码格式

1、左小括号和字符之间不出现空格；同样，右小括号和字符之间也不出现空格；而左 大括号前需要空格。
2、if/for/while/switch/do 等保留字与括号之间都必须加空格。
3、采用4个空格缩进，禁止使用tab字符。
说明：如果使用 tab 缩进，必须设置1 个tab 为4 个空格。IDEA 设置 tab 为4 个空格时，请勿勾选 Use tab character；而在 eclipse 中，必须勾选 insert spaces for tabs。
4、单行字符数限制不超过120个，超出需要换行，换行时遵循如下原则：
1）第二行相对第一行缩进4 个空格，从第三行开始，不再继续缩进，参考示例。
2）运算符与下文一起换行。
3）方法调用的点符号与下文一起换行。
4）方法调用中的多个参数需要换行时，在逗号后进行。
5）在括号前不要换行，见反例。
正例：

StringBuilder sb = new StringBuilder();  // 超过120个字符的情况下，换行缩进4个空格，点号和方法名称一起换行
    sb.append("Jack").append("Ma")...
    .append("alibaba")...
    .append("alibaba")...
    .append("alibaba");

反例：

StringBuilder sb = new StringBuilder();  // 超过120个字符的情况下，不要在括号前换行
    sb.append("Jack").append("Ma")...append      
    ("alibaba");   
    // 参数很多的方法调用可能超过120个字符，不要在逗号前换行
    method(args1, args2, args3, ...     
    , argsX); 

5、不同逻辑、不同语义、不同业务的代码之间插入一个空行分隔开来以提升可读性。

（四）OOP规约

1、所有整型包装类对象之间值的比较，全部使用equals方法比较。
说明：对于Integer var = ? 在-128至127 范围内的赋值，Integer 对象是在 IntegerCache.cache 产 生，会复用已有对象，这个区间内的 Integer 值可以直接使用 == 进行判断，但是这个区间之外的所有数 据，都会在堆上产生，并不会复用已有对象，这是一个大坑，推荐使用 equals方法进行判断。
2、浮点数之间的等值判断，基本数据类型不能用 == 来比较，包装数据类型不能用 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");
     } 

3、POJO类必须写toString方法。使用IDE中的工具：source> generate toString 时，如果继承了另一个POJO类，注意在前面加一下super.toString。
4、禁止在POJO类中，同时存在对应属性xxx的isXxx()和getXxx()方法。
说明：框架在调用属性 xxx的提取方法时，并不能确定哪个方法一定是被优先调用到。
5、循环体内，字符串的连接方式，使用StringBuilder的append方法进行扩展。
说明：下例中，反编译出的字节码文件显示每次循环都会 new出一个 StringBuilder 对象，然后进行 append 操作，最后通过 toString 方法返回 String 对象，造成内存资源浪费。
反例：

    String str = "start";
    for (int i = 0; i < 100; i++) {
        str = str + "hello";
    }

最后

以上就是自由小蘑菇为你收集整理的JAVA代码规范（一）的全部内容，希望文章能够帮你解决JAVA代码规范（一）所遇到的程序开发问题。

如果觉得靠谱客网站的内容还不错，欢迎将靠谱客网站推荐给程序员好友。