创新路
我们一直在努力

Java开发规约之编程规约

阿里技术部有关Java开发的规约,有编程规约、安全异常、MySQL规约、工程规约和安全规约。这里只是一部分,有兴趣的同学可以看看。


(一) 命名规约

1. 【强制】所有编程相关命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。 

反例: _name / __name / $Object / name_ / name$ / Object$

2. 【强制】所有编程相关的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。 说明:正确的英文拼写和语法可以让阅读者易于理解,避免歧义。注意,即使纯拼音命名方式

也要避免采用。

反例: DaZhePromotion [打折] / getPingfenByName() [评分] / int 变量 = 3;

正例: ali / alibaba / taobao / cainiao / aliyun / youku / hangzhou 等国际通用的

名称,可视为英文。

3. 【强制】类名使用 UpperCamelCase 风格,必须遵从驼峰形式,但以下情形例外:(领域模型 的相关命名)DO / DTO / VO / DAO 等。

正例: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 isSuccess;的属性,它的方法也是 isSuccess(),RPC

框架在反向解析的时候,“以为”对应的属性名称是 success,导致属性获取不到,进而抛出

异常。

9. 【强制】包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用 单数形式,但是类名如果有复数含义,类名可以使用复数形式。

正例: 应用工具类包名为 com.alibaba.mpp.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。

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?

3. 【推荐】不要使用一个常量类维护所有常量,应该按常量功能进行归类,分开维护。如:缓存 相关的常量放在类:CacheConsts 下;系统配置相关的常量放在类:ConfigConsts 下。

说明:大而全的常量类,非得 ctrl+f 才定位到修改的常量,不利于理解,也不利于维护。

4. 【推荐】常量的复用层次有五层:跨应用共享常量、应用内共享常量、子工程内共享常量、包

内共享常量、类内共享常量。

 1) 跨应用共享常量:放置在二方库中,通常是 client.jar 中的 const 目录下。

 2) 应用内共享常量:放置在一方库的 modules 中的 const 目录下。

  反例:

易懂变量也要统一定义成应用内共享常量,两位工程师在两个类中分别定义了表示

“是”的变量:

    类 A 中:public static final String YES = "yes";

    类 B 中:public static final String YES = "y";

    A.YES.equals(B.YES),预期是 true,但实际返回为 false,导致产生线上问题。

 3) 子工程内部共享常量:即在当前子工程的 const 目录下。

 4) 包内共享常量:即在当前包下单独的 const 目录下。

 5) 类内共享常量:直接在类内部 private static final 定义。

5. 【推荐】如果变量值仅在一个范围内变化用 Enum 类。如果还带有名称之外的延伸属性,必须 使用 Enum 类,下面正例中的数字就是延伸信息,表示星期几。

正例:

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

 

(三) 格式规约

1. 【强制】大括号的使用约定。如果是大括号内为空,则简洁地写成{}即可,不需要换行;如果 是非空代码块则:

 1) 左大括号前不换行。

 2) 左大括号后换行。

 3) 右大括号前换行。

 4) 右大括号后还有 else 等代码则不换行;表示终止右大括号后必须换行。

2. 【强制】 左括号和后一个字符之间不出现空格;同样,右括号和前一个字符之间也不出现空 格。详见第 5 条下方正例提示。

3. 【强制】if/for/while/switch/do 等保留字与左右括号之间都必须加空格。

4. 【强制】任何运算符左右必须加一个空格。 说明:运算符包括赋值运算符=、逻辑运算符&&、加减乘除符号、三目运行符等。

5. 【强制】代码块缩进 4 个空格,如果使用 tab 缩进,请设置成 1 个 tab 为 4 个空格。 正例: (涉及 1-5 点)

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

6. 【强制】单行字符数限制不超过 120 个,超出需要换行,换行时,遵循如下原则:  1) 换行时相对上一行缩进 4 个空格。

 2) 运算符与下文一起换行。

 3) 方法调用的点符号与下文一起换行。

 4) 在多个参数超长,逗号后进行换行。

 5) 在括号前不要换行,见反例。

正例:

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

7. 【强制】方法参数在定义和传入时,多个参数逗号后边必须加空格。 

正例:下例中实参的"a",后边必须要有一个空格。

method("a", "b", "c"); 

8. 【推荐】没有必要增加若干空格来使某一行的字符与上一行的相应字符对齐。

正例:

int a = 3;  long b = 4L;  float c = 5F;  StringBuffer sb = new StringBuffer();  说明:增加 sb 这个变量,如果需要对齐,则给 a、b、c 都要增加几个空格,在变量比较多的

情况下,是一种累赘的事情。

9. 【强制】IDE 的 text file encoding 设置为 UTF-8; IDE 中文件的换行符使用 Unix 格式,不要使用 windows 格式。

10.【推荐】方法体内的执行语句组、变量的定义语句组、不同的业务逻辑之间或者不同的语义之

间插入一个空行。相同业务逻辑和语义之间不需要插入空行。

说明:没有必要插入多行空格进行隔开。

未经允许不得转载:天府数据港官方信息博客 » Java开发规约之编程规约

客官点个赞呗! (0)
分享到:

评论 抢沙发

评论前必须登录!

天府云博 - 做有态度的开发&运维&设计学习分享平台!

联系我们百度云主机