阿里java编码规范（一）命名风格，常量定义，和代码格式

古城微笑少年丶 2022-06-14 07:50 560阅读 0赞

最近阿里出了一个java开发手册，里面涉及到很多工作规范的地方，有很多借鉴和参考的作用，也可以给新入行的工程师作为参考。

下载地址是在：http://techforum-img.cn-hangzhou.oss-pub.aliyun-inc.com/阿里巴巴Java开发手册v1.2.0.pdf

(一) 命名风格

1.  【强制】 代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。
    
    反例: \_name / \_\_name / $Object / name\_ / name$ / Object$
2.  【强制】 代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。说明:正确的英文拼写和语法可以让阅读者易于理解,避免歧义。注意,即使纯拼音命名方式也要避免采用。  
    正例: alibaba / taobao /  youku / hangzhou 等国际通用的名称,可视同英文。反例: DaZhePromotion \[打折\] / getPingfenByName() \[评分\] / int  某变量 = 3
3.  【强制】类名使用 UpperCamelCase 风格,必须遵从驼峰形式,但以下情形例外:DO / BO  /DTO / VO /  AO  
    正例:MarcoPolo / UserDO  / XmlService  / TcpUdpDeal  / TaPromotion反例:macroPolo / UserDo  / XMLService  / TCPUDPDeal  / TAPromotion
4.  【强制】方法名、参数名、成员变量、局部变量都统一使用  lowerCamelCase 风格,必须遵从驼峰形式。
    
    正例: localValue / getHttpMessage() / inputUserId
5.  【强制】常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长。正例: MAX\_STOCK\_COUNT  
    反例: MAX\_COUNT
6.  【强制】抽象类命名使用 Abstract 或 Base 开头;异常类命名使用 Exception 结尾;测试类命名以它要测试的类的名称开始,以 Test 结尾。

7.【强制】中括号是数组类型的一部分,数组定义如下:String\[\] args;反例:使用String args\[\]的方式来定义。

8. 【强制】POJO 类中布尔类型的变量,都不要加 is,否则部分框架解析会引起序列化错误。反例:定义为基本数据类型Boolean isDeleted;的属性,它的方法也是isDeleted(),RPC框架在反向解析的时候,“以为”对应的属性名称是 deleted,导致属性获取不到,进而抛出异

常。

9. 【强制】包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式,但是类名如果有复数含义,类名可以使用复数形式。  
正例: 应用工具类包名为com.alibaba.open.util、类名为MessageUtils(此规则参考spring 的框架结构)

10. 【强制】杜绝完全不规范的缩写,避免望文不知义。  
反例: AbstractClass“缩写”命名成 AbsClass;condition“缩写”命名成 condi,此类随意缩写严重降低了代码的可阅读性。

11. 【推荐】如果使用到了设计模式,建议在类名中体现出具体模式。说明:将设计模式体现在名字中,有利于阅读者快速理解架构设计思想。正例:public class OrderFactory;

public class LoginProxy;public class ResourceObserver;

12.【推荐】接口类中的方法和属性不要加任何修饰符号(public 也不要加),保持代码的简洁性,并加上有效的 Javadoc 注释。尽量不要在接口里定义变量,如果一定要定义变量,肯定是与接口方法相关,并且是整个应用的基础常量。  
正例:接口方法签名:void f();

接口基础常量表示:String COMPANY = "alibaba";  
反例:接口方法定义:public abstract void f();  
说明:JDK8 中接口允许有默认实现,那么这个 default 方法,是对所有实现类都有价值的默认实现。

13. 接口和实现类的命名有两套规则:  
1)【强制】对于 Service 和 DAO 类,基于 SOA 的理念,暴露出来的服务一定是接口,内部

的实现类用 Impl 的后缀与接口区别。正例:CacheServiceImpl 实现 CacheService 接口。

2)【推荐】 如果是形容能力的接口名称,取对应的形容词做接口名(通常是–able 的形式)。正例:AbstractTranslator 实现 Translatable。

14. 【参考】枚举类名建议带上 Enum 后缀,枚举成员名称需要全大写,单词间用下划线隔开。说明:枚举其实就是特殊的常量类,且构造方法被默认强制是私有。正例:枚举名字:DealStatusEnum,成员名称:SUCCESS / UNKOWN\_REASON。

![page5image8576][]

15. 【参考】各层命名规约:  
A) Service/DAO层方法命名规约

1) 获取单个对象的方法用get做前缀。

2) 获取多个对象的方法用list做前缀。

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. 【强制】不允许任何魔法值(即未经定义的常量)直接出现在代码中。反例: String key = "Id\#taobao\_" \+ tradeId;

cache.put(key, value);

2. 【强制】long 或者 Long 初始赋值时,必须使用大写的 L,不能是小写的 l,小写容易跟数字1 混淆,造成误解。  
说明:Long a = 2l; 写的是数字的21,还是Long型的2?

1.  【推荐】不要使用一个常量类维护所有常量,应该按常量功能进行归类,分开维护。如:缓存相关的常量放在类:CacheConsts 下;系统配置相关的常量放在类:ConfigConsts 下。说明:大而全的常量类,非得使用查找功能才能定位到修改的常量,不利于理解和维护。
2.  【推荐】常量的复用层次有五层:跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。
    
    1) 跨应用共享常量:放置在二方库中,通常是client.jar中的constant目录下。2) 应用内共享常量:放置在一方库的modules中的constant目录下。
    
    反例:易懂变量也要统一定义成应用内共享常量,两位攻城师在两个类中分别定义了表示“是”的变量:
    
    类A中:public static final String YES = "yes";  
    类B中:public static final String YES = "y";A.YES.equals(B.YES),预期是 true,但实际返回为 false,导致线上问题。
    
    3) 子工程内部共享常量:即在当前子工程的constant目录下。4) 包内共享常量:即在当前包下单独的constant目录下。  
    5) 类内共享常量:直接在类内部private static final定义。

![page6image9072][page5image8576]

5. 【推荐】如果变量值仅在一个范围内变化,且带有名称之外的延伸属性,定义为枚举类。下面

正例中的数字就是延伸信息,表示星期几。

正例:public Enum \{ MONDAY(1), TUESDAY(2), WEDNESDAY(3), THURSDAY(4), FRIDAY(5), SATURDAY(6),SUNDAY(7);\}

(三) 代码格式

1.  【强制】大括号的使用约定。如果是大括号内为空,则简洁地写成\{\}即可,不需要换行;如果是非空代码块则:
    
    1) 左大括号前不换行。  
    2) 左大括号后换行。  
    3) 右大括号前换行。  
    4) 右大括号后还有else等代码则不换行;表示终止的右大括号后必须换行。
2.  【强制】 左小括号和字符之间不出现空格;同样,右小括号和字符之间也不出现空格。详见第 5 条下方正例提示。  
    反例:if (空格a == b空格)
3.  【强制】if/for/while/switch/do 等保留字与括号之间都必须加空格。
4.  【强制】任何二目、三目运算符的左右两边都需要加一个空格。
    
    说明:运算符包括赋值运算符=、逻辑运算符&&、加减乘除符号等。
5.  【强制】缩进采用 4 个空格,禁止使用 tab 字符。
    
    说明:如果使用 tab 缩进,必须设置 1 个 tab 为 4 个空格。IDEA 设置 tab 为 4 个空格时,请勿勾选Use tab character
    
    正例: (涉及1-5点)
    
    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");

![page7image11456][page5image8576]

<table style="border-collapse:collapse">      
 <tbody> 
  <tr> 
   <td style="border-style:solid; border-width:0pt; border-top-color:rgb(0,0,0); border-right-color:rgb(0,0,0); border-bottom-color:rgb(0,0,0)"> 
    <div> 
     <div> 
      <p><span style="font-size:12.000000pt; font-family:'宋体'; color:rgb(20.000000%,20.000000%,20.000000%)">;而在 </span><span style="font-size:12.000000pt; font-family:'Fira Mono'; color:rgb(20.000000%,20.000000%,20.000000%)">eclipse </span><span style="font-size:12.000000pt; font-family:'宋体'; color:rgb(20.000000%,20.000000%,20.000000%)">中,必须勾选</span></p> 
     </div> 
    </div> </td> 
   <td style="border-style:solid; background-color:rgb(97.600000%,94.900000%,95.700000%); border-top-width:0.000000pt; border-top-color:rgb(0.000000%,0.000000%,0.000000%); border-right-width:0.000000pt; border-right-color:rgb(0.000000%,0.000000%,0.000000%); border-bottom-width:0.000000pt; border-bottom-color:rgb(0.000000%,0.000000%,0.000000%); border-left-width:0.000000pt; border-left-color:rgb(0.000000%,0.000000%,0.000000%)"> 
    <div> 
     <div> 
      <pre><span style="font-size:11.000000pt; font-family:'Fira Mono'; color:rgb(78.000000%,14.500000%,30.600000%)">insert spaces for tabs
</span></pre> 
     </div> 
    </div> </td> 
   <td style="border-style:solid; border-width:0pt; border-top-color:rgb(0,0,0); border-bottom-color:rgb(0,0,0); border-left-color:rgb(0,0,0)"> 
    <div> 
     <div> 
      <p><span style="font-size:12.000000pt; font-family:'宋体'; color:rgb(20.000000%,20.000000%,20.000000%)">。</span></p> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

// 在右大括号后直接结束,则必须换行

\}\}

6. 【强制】单行字符数限制不超过 120 个,超出需要换行,换行时遵循如下原则:1) 第二行相对第一行缩进 4 个空格,从第三行开始,不再继续缩进,参考示例。

2) 运算符与下文一起换行。  
3) 方法调用的点符号与下文一起换行。4) 在多个参数超长,在逗号后换行。5) 在括号前不要换行,见反例。

正例:

StringBuffer sb = new StringBuffer();

//超过 120 个字符的情况下,换行缩进 4 个空格,并且方法前的点符号一起换行sb.append("zi").append("xin")...

.append("huang")...
              .append("huang")...
              .append("huang");

反例:

StringBuffer sb = new StringBuffer();

//超过 120 个字符的情况下,不要在括号前换行sb.append("zi").append("xin")...append

("huang");