阿里Java开发手册-编程规范

一、编程规范

1）.命名规范：

• 1.【强制】代码中的命名均不可以以下划线或者美元符号（$）开始和结束

  • 反例：name 、 name 、$name、name$

• 2.【强制】代码中禁止使用中文，且禁止使用拼音与英文混合的方式

  • 说明：正确的英语拼写和语法可以让阅读者更便于理解，避免歧义，纯拼音的命名方式也是需要避免使用的
  • 反例：DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3
  • 正确示例：alibaba、taobao （国际通用的名称，可以视为英文）

• 3.【强制】类名称使用UpperCamelCase命名风格（单词首字母均大写），遵守驼峰形式

  • 正确示例：MarcoPolo、UserDao
  • 反例：marcoPolo、userDao

• 4.【强制】方法名、参数名、成员变量、局部变量使用LowerCamelCase命名风格，遵守驼峰形式

  • 正确示例：marcoName、 localValue / getHttpMessage() / inputUserId

• 5.【强制】常量命名全部大写，单词间用下划线隔开，力求见名知意，不要嫌名称过长

  • 正确示例：MAX_STOCK_COUNT
  • 反例：MAX_COUNT

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

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

  • 反例：切勿使用String args[]的方式定义

• 8.【强制】POJO类（实体类）中Boolean类型的变量的命名都不要加is，否则会在部分框架解析的时候会引起序列化的错误

  • 反例：定义基本类型boolean的属性isSuccess，它的方法也是isSuccess（），在RPC框架方向解析的时候，会认为属性名称为success，导致属性获取不到，抛出异常

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

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

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

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

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

  • 说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计思想。
  • 正例：public class OrderFactory;public class LoginProxy;public class ResourceObserver;

• 12【推荐】接口类中的方法和属性不要添加任何修饰符号（public 也不要加）