阿里巴巴编程规范文档(必备7篇)

阿里巴巴编程规范文档 第1篇

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

2，【强制】左小括号和字符之间不出现空格 ； 同样，右小括号和字符之间也不出现空格；而左大括号前需要空格。

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

4，【强制】任何二目、三目运算符的左右两边都需要加一个空格。

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

以上5点的正确示例：

6，【强制】注释的双斜线与注释内容之间有且仅有一个空格。这里个人容易不符合规范

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

8，【推荐】没有必要增加若干空格来使某一行的字符与上一行对应位置的字符对齐。正例：

说明：增加 stringBuffer 这个变量，如果需要对齐，则给 one 、two 、three 都要增加几个空格，在变量比较多的情况下，是非常累赘的事情。

9，【强制】在进行类型强制转换时，右括号与强制转换值之间不需要任何空格隔开。

正例：double first = ; int second = (int)first + 2;

10，【推荐】不同逻辑、不同语义、不同业务的代码之间插入一个空行分隔开来以提升可读性。这里个人容易不符合规范

阿里巴巴编程规范文档 第2篇

关于类和方法调用的一些规范：

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

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

结论6：别随便改第三方接口的方法签名，同时，长点儿心，更新了接口考虑好兼容性就把旧的替了好不好，不然很让调用方苦恼的。

3 【强制】Object 的 equals 方法容易抛空指针异常，应使用常量或确定有值的对象来调用 equals。这里个人容易不符合规范

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

5 【强制】浮点数之间的等值判断，基本数据类型不能用==来比较，包装数据类型不能用 equals来判断。

反例：

正例：

6.【强制】如上所示 BigDecimal 的等值比较应使用 compareTo()方法，而不是 equals()方法。

7 【强制】禁止使用构造方法 BigDecimal(double)的方式把 double 值转化为 BigDecimal 对象。

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

9，【推荐】循环体内，字符串的连接方式，使用 StringBuilder 的 append 方法进行扩展。这里个人容易不符合规范

10，【推荐】慎用 Object 的 clone 方法来拷贝对象。,说明：对象的 clone 方法默认是浅拷贝，若想实现深拷贝需要重写 clone 方法实现域对象的深度遍历式拷贝。关于深拷贝和浅拷贝可以看我另一篇博客讲到了 深浅拷贝，可以参考下

收获还是很多的，在写和学习的过程中思考了下自己之前写代码的一些不规范和考虑不到的点，例如代码逻辑中自己会搞多行空格，注释反斜杠直接挨着注释内容，字符串直接拼，调用equals方法不做NPE校验，甚至从来不考虑类内各种方法的顺序，也从来不想着访问修饰符的严格级别，还有常量的共享级别、方法和变量命名格式等，仔细想想这些看起来的小问题之后可能真的是很难排查的大问题，保持一个好的编程习惯真的很重要啊。

阿里巴巴编程规范文档 第3篇

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

2【强制】类型与中括号紧挨相连来表示数组变量定义。

3 【强制】避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命名，使可理解性降低。这里个人容易不符合规范

4，【强制】 POJO 类中布尔类型的变量，都不要加 is 前缀 ，否则部分框架解析会引起序列化错误。这里个人容易不符合规范

注：POJO 专指只有 setter / getter/ toString 的简单类，包括 DO/DTO/BO/VO 等。属于贫血类，相对于领域驱动设计里的充血类而言的。

5 【推荐】在常量与变量的命名时，表示类型的名词放在词尾，以提升辨识度。这里个人容易不符合规范

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

2，【强制】不允许任何魔法值 （ 即未经预先定义的常量 ） 直接出现在代码中。反例：这里个人容易不符合规范

3，【强制】在 long 或者 Long 赋值时，数值后使用大写的 L ，不能是小写的 l ，小写容易跟数字1 混淆，造成误解。这里个人容易不符合规范

4，【推荐】不要使用一个常量类维护所有常量，要按常量功能进行归类，分开维护。

5，【推荐】常量的复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。这里个人容易不符合规范

解释下：一方库: 本工程内部子项目模块依赖的库（jar 包）。二方库: 公司内部发布到中央仓库，可供公司内部其它应用依赖的库（jar 包）。三方库: 公司之外的开源库（jar 包）。

6，【推荐】如果变量值仅在一个固定范围内变化用 enum 类型来定义固化。

一些代码编排规范：

阿里巴巴编程规范文档 第4篇

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

2，【推荐】 setter 方法中，参数名称与类成员变量名称一致， this .成员名 = 参数名。在getter / setter 方法中，不要增加业务逻辑，增加排查问题的难度。反例：

结论5：无论何种编程语言，PoJo类的那几个初始化方法（构造方法、setter、getter）都别写业务逻辑，并且有时候系统提供的方法不一定满足要求要按业务重构

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

阿里巴巴编程规范文档 第5篇

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

2， 关于基本数据类型与包装数据类型的使用标准如下：这里个人容易不符合规范

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

通俗的说远程调用返回值只有包装类型才能包装没有NPE风险并且可以提供额外错误信息。

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

4，【强制】定义 DO / DTO / VO 等 POJO 类时，不要设定任何属性默认值。这里个人容易不符合规范

5，【强制】 POJO 类必须写 toString 方法。使用 IDE 中的工具： source > generate toString,时，如果继承了另一个 POJO 类，注意在前面加一下 super . toString 。说明：在方法执行抛出异常时，可以直接调用 POJO 的 toString() 方法打印其属性值，便于排查问题。，或者直接加lombook注解。

6，【强制】禁止在 POJO 类中，同时存在对应属性 xxx 的 isXxx() 和 getXxx() 方法。说明：框架在调用属性 xxx 的提取方法时，并不能确定哪个方法一定是被优先调用到。

7，【推荐】当一个类有多个构造方法，或者多个同名方法，这些方法应该按顺序放置在一起，便于阅读。这条规则优先于规则【类内方法定义顺序】

8，【推荐】 类内方法定义的顺序依次是：公有方法或保护方法 > 私有方法 > getter / setter方法。这里个人容易不符合规范

9， 【推荐】类成员与方法访问控制从严，其实就是访问修饰符如何使用的问题：这里个人容易不符合规范

说明：任何类、方法、参数、变量，严控访问范围。过于宽泛的访问范围，不利于模块解耦。

思考：如果是一个 private 的方法，想删除就删除，可是一个 public 的 service 成员方法或成员变量，删除一下，不得手心冒点汗吗？变量像自己的小孩，尽量在自己的视线内，变量作用域太大，无限制的到处跑，那么你会担心的。

结论4：无论何种编程语言，类、方法、成员的访问是能严就严，性能损耗能小就小，少定默认值，多用包装类

10 【强制】任何货币金额，均以最小货币单位且整型类型来进行存储。

11 .【强制】定义数据对象 DO 类时，属性类型要与数据库字段类型相匹配。这里个人容易不符合规范

12，【强制】序列化类新增属性时，请不要修改 serialVersionUID 字段，避免反序列失败 ； 如果完全不兼容升级，避免反序列化混乱，那么请修改 serialVersionUID 值。这里个人容易不符合规范

阿里巴巴编程规范文档 第6篇

1,【强制】类名使用 UpperCamelCase 风格，但以下情形例外： DO / BO / DTO / VO / AO /PO / UID 等。

除外的原因是DO / BO / DTO / VO / AO /PO / UID 等本身是缩写。补充说明：类的名字要用名词, 例如计划清单类:PlanList

2,【参考】枚举类名建议带上 Enum 后缀，枚举成员名称需要全大写，单词间用下划线隔开。说明：枚举其实就是特殊的常量类，域成员均为常量，且构造方法被默认强制是私有。

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

结论2：类均采用UpperCamelCase 命名法且均为名词，并且特殊用途时需要加特殊前后缀

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

5，接口和实现类的命名有两套规则：

阿里巴巴编程规范文档 第7篇

通识规范有如下几条：

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

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

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

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

阅读完以上四条规范，回忆下Java的命名规范：

综合阿里和标准的Java命名规范，得出规范：

结论1：最好使用纯英文且尽量完整的单词进行命名，_和$符只能出现在中间，数字只能出现在中间和末尾

5，【推荐】如果模块、接口、类、方法使用了设计模式，在命名时需体现出具体模式。

6，【强制】代码和注释中都要避免使用任何语言的种族歧视性词语。

7，【参考】各层命名规约：这里个人容易不符合规范