12、Java命名规范（详细）

最近，阿里巴巴发布了《阿里巴巴Java开发手册》，总结了阿里人多年一线实战中积累的研发流程规范，这些流程规范在一定程度上能够保证最终的项目交付质量，通过限制开发人员的编程风格、实现方式来避免研发人员在实践中容易犯的错误，同样的问题大家使用同样的模式解决，便于后期维护和扩展，确保最终在大规模协作的项目中达成既定目标。

1 命名规约

1. 【强制】 代码中的命名均不能以下划线或美元符 开始，也不能以下划线或美元符 结束。

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

   白话：

   • 这条不够严格，普通的变量、类名、方法名必须使用驼峰式命名，最好不要使用下划线和美元符 ，否则看起来像脚本语言似得，常量可以使用下划线，但是也不要放在常量开头和结尾。

2. 【强制】 代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。

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

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

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

   白话：

   • 中英混合的人种咱不歧视，变量名混合太丑了。
   • Java编译器支持Unicode（UTF-8)，允许中文命名变量，不过打中文还是没有英文快。
   • 英文！英文起名，洋气、大方、高大上…

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

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

   反例:macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion

   白话：

   • 约定俗成的名称或者缩写例外。

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

   正例: localValue / getHttpMessage() / inputUserId

   白话：

   • 约定俗称的名称或者缩写例外。
   • ID为简写，Id和ID均可。

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

   正例: MAX_STOCK_COUNT

   反例: MAX_COUNT

   白话：

   • 必须全部大写，除了字母数字只可以使用下划线，并且不能用在开头和结尾。

6. 【强制】抽象类命名使用 Abstract 或 Base 开头;异常类命名使用 Exception 结尾;测试类命名以它要测试的类的名称开始，以 Test 结尾。

   白话：

   • 家里放一瓶敌敌畏，上面不写标签，万一喝大了、渴了、喝了、就惨了，你懂的。

7. 【强制】中括 是数组类型的一部分，数组定义如下:String[] args;

   反例: 使用String args[]的方式来定义。

   白话：

   • 这种语法编译器也认，但是我们毕竟写Java程序，而不是写C/C++程序。
   • 这怪Java编译器小组，一开始就不应该支持这种语法。

8. 【强制】POJO 类中布尔类型的变量，都不要加 is，否则部分框架解析会引起序列化错误。

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

   白话：

   • 一些框架使用getter和setter做序列化，有的根据属性本身取值，带了is前缀就找不到了，变量名不要带be动词，语法不对，英文补考！

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

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

   白话：

   • 包名大写、带下划线等，不专业、难看、不高大上。

10. 【强制】杜绝完全不规范的缩写，避免望文不知义。

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

    白话：

    • 不要太抠，不是太长的名字直接写上就好，编译器编译优化后变量名将不存在，会编译成相对于方法堆栈bp指针地址的相对地址，长变量名不会占用更多空间。
    • 英文中的缩写有个惯例，去掉元音留下辅音即可，不能乱缩写。

11. 【推荐】如果使用到了设计模式，建议在类名中体现出具体模式。

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

    正例: public class OrderFactory;

    白话：

    • 让全世界都知道你会设计模式，这是个崇尚显摆的 会。

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

    正例: 接口方法签名:void f();

    反例: 接口方法定义:public abstract void f();

    白话：

    • 脱了裤子放屁始终有点麻烦。

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

    正例: CacheServiceImpl 实现 CacheService 接口。

    2)【推荐】 如果是形容能力的接口名称，取对应的形容词做接口名(通常是–able 的形式)。

    正例: AbstractTranslator 实现 Translatable。

    白话：

    • 严重同意！可是想想Observer和Observable，我就不说话了。

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) 领域模型命名规约
    7. 数据对象:xxxDO，xxx即为数据表名。
    8. 数据传输对象:xxxDTO，xxx为业务领域相关的名称。
    9. 展示对象:xxxVO，xxx一般为 页名称。
    10. POJO是DO/DTO/BO/VO的统称，禁止命名成xxxPOJO。

    白话：

    • 大家都这么认为很重要。

2 常量定义

1. 【强制】不允许出现任何魔法值(即未经定义的常量)直接出现在代码中。

   反例:

   白话：

   • 这个不用说了，随地吐痰和随地大小便是不应该的，新加坡是要鞭刑的！

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

   说明: Long a = 2l; 写的是数字的21，还是Long型的2/p>

   白话：

   • 看看区块链中用了base58，而不是base64，秒懂什么是从用户角度考虑产品设计！

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

   说明: 大而全的常量类，非得使用查找功能才能定位到修改的常量，不利于理解和维护。

   白话：

   • 尽量让功能自闭包，标准是一个小模块拷贝出去直接就能用，而不是缺这缺那的，是不是读者很多时候拷贝了一套类，运行时候发现不能用，缺常量，把常量类拷贝过来，发现常量类中有很多不相关的常量，还得清理。

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

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

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

   反例: 易懂变量也要统一定义成应用内共享常量，两位攻城师在两个类中分别定义了表示 “是”的变量:

   类A中:

   类B中: ，预期是 true，但实际返回为 false，导致产生线上问题。

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

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

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

   白话：

   • 一方库、二方库、三方库，叫法很专业，放在离自己最近的上面一个层次即可。

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

   正例:

   白话：

   • 枚举值需要定义延伸属性的场景通常是要持久数据库，或者显示在界面上。

3 格式规约

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

   1. 左大括 前不换行。
   2. 左大括 后换行。
   3. 右大括 前换行。
   4. 右大括 后还有else等代码则不换行;表示终止右大括 后必须换行。

   白话：

   • 好风格，讨厌那种左大括 前换行的，看不惯。

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

   白话：

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

   白话：

4. 【强制】任何运算符左右必须加一个空格。

   说明: 运算符包括赋值运算符=、逻辑运算符&&、加减乘除符 、三目运算符等。

   白话：

5. 【强制】缩进采用 4 个空格，禁止使用 tab 字符。

   说明: 如果使用 tab 缩进，必须设置 1 个 tab 为 4 个空格。IDEA 设置 tab 为 4 个空格时，请勿勾选Use tab character; 而在 eclipse 中，必须勾选 insert spaces for tabs。

   正例: (涉及1-5点)

   白话：

   • 这样看惯了，怎么看怎么清晰。

6. 【强制】单行字符数限制不超过 120 个，超出需要换行，换行时遵循如下原则:

   1. 第二行相对第一行缩进 4 个空格，从第三行开始，不再继续缩进，参考示例。
   2. 运算符与下文一起换行。
   3. 方法调用的点符 与下文一起换行。
   4. 在多个参数超长，逗 后进行换行。
   5. 在括 前不要换行，见反例。

   正例:

   反例:

   白话：

   • 一行代码尽量不要写太长，长了拆开不就得了。

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

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

   白话：

   • 不加空格太挤了，就像人没长开似得。

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

   白话：

   • 请不要用GB字符集，换了环境总有问题，Java程序多数跑在Linux上，当然要用Unix换行符。

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

   正例:

   说明: 增加 sb 这个变量，如果需要对齐，则给 a、b、c 都要增加几个空格，在变量比较多的 情况下，是一种累赘的事情。

   白话：

   • 没必要，没必要，那样反而不好看。

10. 【推荐】方法体内的执行语句组、变量的定义语句组、不同的业务逻辑之间或者不同的语义
    之间插入一个空行。相同业务逻辑和语义之间不需要插入空行。

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

    白话：

    • 和我的习惯一样一样的，一段逻辑空一行。

4 OOP 规约

1. 【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成
   本，直接用类名来访问即可。

   白话：

   • 也不直观，看调用代码看不出来是静态方法，容易误解。

2. 【强制】所有的覆写方法，必须加@Override 注解。

   反例:getObject()与 get0bject()的问题。一个是字母的 O，一个是数字的 0，加@Override 可以准确判断是否覆盖成功。另外，如果在抽象类中对方法签名进行修改，其实现类会马上编译 错。

   白话：

   • Java和C++不一样，C++是在父类先声明虚拟函数子类才覆写，Java是任何方法都能覆写，也可以不覆写，所以覆写不覆写是没有编译器检查的，除非接口中某一个方法完全没有被实现才会编译 错。

3. 【强制】相同参数类型，相同业务含义，才可以使用 Java 的可变参数，避免使用 Object。

   说明: 可变参数必须放置在参数列表的最后。(提倡同学们尽量不用可变参数编程)

   正例:

   白话：

   • 用处不大，可以用重载方法或者数组参数代替。
   • 一般应用在日志的 API 定义上，用于传不定的日志参数。

4. 【强制】外部正在调用或者二方库依赖的接口，不允许修改方法签名，避免对接口调用方产生 影响。接口过时必须加@Deprecated 注解，并清晰地说明采用的新接口或者新服务是什么。

   白话：

   • 设计时没有考虑周全，需要改造接口，需要通过增加新接口，迁移后下线老接口的方式实现。
   • REST接口只能增加参数，不能减少参数，返回值的内容也是只增不减。

5. 【强制】不能使用过时的类或方法。

   说明: java.net.URLDecoder 中的方法 decode(String encodeStr) 这个方法已经过时，应该使用双参数 decode(String source, String encode)。接口提供方既然明确是过时接口，那么有义务同时提供新的接口; 作为调用方来说，有义务去考证过时方法的新实现是什么。

   白话：

   • 明确了责任和义务，接口提供方也有义务推动接口使用方尽早迁移，不要积累技术负债。

6. 【强制】Object 的 equals 方法容易抛空指针异常，应使用常量或确定有值的对象来调用 equals。

   正例:

   反例:

   说明: 推荐使用 (JDK7引入的工具类)

   白话：

   • 常量比变量，永远都不变的原则。

7. 【强制】所有的相同类型的包装类对象之间值的比较，全部使用 equals 方法比较。

   说明: 对于Integer var = -128至127之间的赋值，Integer对象是在 IntegerCache.cache 产生，会复用已有对象，这个区间内的 Integer 值可以直接使用==进行 判断，但是这个区间之外的所有数据，都会在堆上产生，并不会复用已有对象，这是一个大坑， 推荐使用 equals 方法进行判断。

   白话：

   • Java世界里相等请用equals方法，==表示对象相等，一般在框架开发中会用到。

8. 关于基本数据类型与包装数据类型的使用标准如下:

   1. 【强制】所有的POJO类属性必须使用包装数据类型。
   2. 【强制】RPC方法的返回值和参数必须使用包装数据类型。
   3. 【推荐】所有的局部变量使用基本数据类型。

   说明: POJO 类属性没有初值是提醒使用者在需要使用时，必须自己显式地进行赋值，任何
   NPE 问题，或者入库检查，都由使用者来保证。

   正例: 数据库的查询结果可能是 null，因为自动拆箱，用基本数据类型接收有 NPE 风险。

   反例: 比如显示成交总额涨跌情况，即正负 x%，x 为基本数据类型，调用的 RPC 服务，调用不成功时，返回的是默认值，页面显示:0%，这是不合理的，应该显示成中划线-。所以包装数据类型的 null 值，能够表示额外的信息，如:远程调用失败，异常退出。

   白话：

   • 其实包装数据类型与基本数据类型相比，增加了一个null的状态，可以携带更多的语义。

9. 【强制】定义 DO/DTO/VO 等 POJO 类时，不要设定任何属性默认值。

   反例: POJO类的gmtCreate默认值为new Date(); 但是这个属性在数据提取时并没有置入具体值，在更新其它字段时又附带更新了此字段，导致创建时间被修改成当前时间。

   白话：

   • 虽然这里反例不太容易看懂，但是要记得持久领域对象之前由应用层统一赋值gmtCreate和gmtModify字段。

10. 【强制】序列化类新增属性时，请不要修改 serialVersionUID 字段，避免反序列失败; 如 果完全不兼容升级，避免反序列化混乱，那么请修改 serialVersionUID 值。

    说明:注意 serialVersionUID 不一致会抛出序列化运行时异常。

    白话：

    • 不到万不得已不要使用JDK自身的序列化，机制很重，信息冗余有版本。

11. 【强制】构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在 init 方法中。

    白话：

    • 这样做一种是规范，代码清晰，还有就是异常堆栈上更容易识别出错的方法和语句。

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

    说明: 在方法执行抛出异常时，可以直接调用 POJO 的 toString()方法打印其属性值，便于排 查问题。

    白话：

    • 这里还有一个大坑，写toString的时候要保证不会发生NPE，有的时候toString调用实例变量的toString，实例变量由于某些原因为null，导致NPE，代码没有处理好就终止，这个问题坑了好多次。

13. 【推荐】使用索引访问用 String 的 split 方法得到的数组时，需做最后一个分隔符后有无内容的检查，否则会有抛 IndexOutOfBoundsException 的风险。

    说明:

    声明：本站部分文章及图片源自用户投稿，如本站任何资料有侵权请您尽早请联系jinwei@zod.com.cn进行处理,非常感谢！