java的编码规范你知道多少？你做到了吗？

1.1 命名风格

1 [ 强制]代码中的命名均不能以下画线或美元符号开始，也
不能以下画线或美元符号结束。
反例:_ name /_ name /$name/nam{e}_{/}name$ / name__
2 [强制]代码中的命名严禁使用拼音与英文混合的方式，更
不允许直接使用中文的方式。

说明:正确的英文拼写和语法可以让阅读者易于理解，避免歧 义。注意，即使是纯拼音命名方式也要避免采用

。

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

反例: DaZhePromotion [打折] / getPingFenByName ()

[评分] / int某变量= 3
❸[强制]类名使用UpperCamelCase风格，但DO/BO/ DTO/
Vo/ AO/ PO等情形例外。

正例: MarcoPolo / UserDO / XmlService / TcpUdpDeal/ TaPromotion/ QrCode

反例: macroPolo / UserDo / XMLService /TCPUDPDea/TAPromotion / QRCode

❹[强制] 方法名、参数名、成员变量、局部变量都统一使用
lowerCamelCase风格，必须遵从驼峰形式。

正例: localValue / getHttpMessage() / inputUserId

5 ) [强制]常量命名全部大写，单词间用下画线隔开，力求语
义表达完整清楚，不要嫌名字长。

• 正例: MAX_ STOCK_ COUNT/PRIZE_ NUMBER_ EVERYDAY 反例: MAX_
  COUNT/PRIZE_ NUMBER

6 [强制]抽象类命名使用Abstract或Base开头;异常类
命名使用Exception结尾;测试类命名以它要测试的类名
开始，以Test结尾。
7 [ 强制]类型与中括号之间无空格相连定义数组。
正例:定义整形数组int[] arrayDemo;
反例:在main参数中，使用String args[]来定义。
❽[强制]POJO类中布尔类型的变量都不要加is前缀，否则
部分框架解析会引起序列化错误。
反例:定义为基本数据类型Boolean isDeleted; 的属性，
它的方法名称也是isDeleted(), RPC框架在反向解
析的时候，“误以为” 对应的属性名称是deleted,导
致属性获取不到抛出异常。
9 [强制]包名统一-使用小写，点分隔符之间有且仅有一个自
然语义的英语单词。包名统一使用 单数形式，但是类名如果
有复数含义，则类名可以使用复数形式。

正例:应用工具类包名为com.alibaba.ai.util, 类名为 MessageUtils(此规则参考Spring的框架结构)。

10 [强制]杜绝完全不规范的缩写，避免词不达义。

反例: AbstractClass “缩写”命名成AbsClass, condition
“缩写”命名成condi,此类随意缩写严重降低了代码 的可读性。

11 [推荐] 为了达到代码自解释的目标，任何自定义编程元素
在命名时，使用尽量完整的单词组合来表达其意。

正例:在JDK中，对某个对象引用的volatile字段进行原子 更新的类名为: Atomi cReferenceFieldUpdater。
反例:变量int a;的随意命名方式。

12 [推荐]如果模块、接口、类、方法使用了设计模式，应在
命名时体现出具体模式。

说明:将设计模式体现在名字中，有利于阅读者快速理解架构

正例: public class OrderFactory;
public class LoginProxy;

public class ResourceObserver;

13 [ 推荐]接口类中的方法和属性不要加任何修饰符号(public
也不要加)，保持代码的简洁性，并加，上有效的Javadoc .
注释。尽量不要在接口里定义变量，如果一定要定义变量,
必须是与接口方法相关的，并且是整个应用的基础常量。

正例:接口方法签名: void commit() ; 接口基础常量: String COMPANY = “alibaba”;
反例:接口方法定义: public abstract void commit () ;
说明:如果JDK8中接口允许有默认实现，那么这个default 方法，是对所有实现类都有价值的默认实现。

14
接口和实现类的命名有两套规则:

1. [强制]对于Service和DAO类，基于SOA的理念，
   暴露出来的服务一定是接口， 内部的实现类用Impl后
   缀与接口区别。

正例: CacheServiceImpl 实现CacheService接口。

2. [推荐]如果是形容能力的接口名称，取对应的形容词
   为接口名(通常是-able的形式)。

正例: AbstractTranslator实现Translatable。

[参考]枚举类名建议带上Enum后缀，枚举成员名称需要
全大写，单词间用下画线隔开。

说明:枚举其实就是特殊的常量类，且构造方法被默认强制为 私有。

正例:枚举名字为ProcessStatusEnum 的成员名称: SUCCESS / UNKNOWN_ REASON 。

16[参考]各层命名规约:

1. Service/DAO 层方法命名规约如下。
   ●获取单个对象的方法用get作为前缀。
   ●获取多个对象的方法用list作为前缀。
   ●获取统计值的方法用count
   作为前缀。
   ●插入的方法用save / insert作为前缀。
   ●删除的方法用remove / delete 作为前缀。
   ●修改的方法用update作为前缀。
   2)领域模型命名规约如下。
   ●数据对象: xxxDO，xxx
   为数据表名。
   ●数据传输对象: xxxDTO，xxx
   为业务领域相关的名称。
   ●展示对象: xxxVO， xxx一般为网页名称。
   ●POJO 是DO/DTO/BO/ VO的统称，禁止命名成xxxPOJO。

1.2 常量定义

➊[ 强制]不允许任何魔法值(即未经预先定义的常量)直接
出现在代码中。

反例: String key = “Id#taobao_ .” + tradeId; cache.put (key, value) ;

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

说明: Long a = 21;写的是数字的21，还是Long型的2?

❸[推荐]不要使用一个常量类维护所有常量，要按常量功能
进行归类，分开维护。
❸[推荐]不要使用一个常量类维护所有常量，要按常量功能
进行归类，分开维护,

说明:大而全的常量类，非得使用查找功能才能定位到修改的 常量，不利于理解和维护。s要把的
正例:缓存相关常量放在类CacheConsts下;系统配置相关 常量放在类ConfigConsts下。

4 [推荐]常量的复用层次有5层:跨应用共享常量、应用内.
共享常量、子工程内共享常量、包内共享常量、类内共享常量。.
1)跨应用共享常量:放置在二方库中，通常是在client.
jar中的constant目录下。
2)应用内共享常量:放置在一方库中，通常是在子模块中
的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
定义。
❺[推荐] 如果变量值仅在一个范围内变化，则用enum类型
来定义。

说明:如果存在名称之外的延伸属性，则使用enum类型，下 面正例的数字就是延伸信息，表示一年中的第几个季节 。

正例:

public enum SeasonEnum {
SPRING(1)，SUMMER(2) ，AUTUMN(3), WINTER(4) ;
int seq;
SeasonEnum(int seq) {
this.seq = seq;
}

参考阿里巴巴代码规约文档