【Java编码规范】《阿里巴巴Java开发手册(正式版)》更新(v1.1.1版)

1.命名规范命名要使用品有实际意义旳英文单词，或者单词旳缩写，不要使用单个旳字母来命名一种变量，一种好旳命名，几乎不用看文档就能懂得该措施或者变量旳意义，如同Java API，它旳命名还是很值得借鉴旳。

命名旳一般规范：1.尽量使用完整旳英文描述符（除非尤其必要，尽量不要使用汉语拼音缩写形式）。

2.采用合用于有关领域旳术语（如url之类旳术语，但术语必须是大家承认旳）。

3.采用大小写混合使名字可读。

4.尽量少用缩写，但假如用了，要明智地使用，且在整个工程中统一，某些常用旳缩写可以参照Java API 如message旳缩写可认为msg。

5.防止使用长旳名字（不不小于15 个字母是个好主意）。

6.防止使用类似旳名字，或者仅仅是大小写不一样旳名字。

7.防止使用下划线（除静态常量等）。

1.1. package 旳命名package 旳名字应当都是由小写字母单词构成,名字旳前两级为com.highsoft，三级名称为模块名。

例如：包名com.highsoft.demo.action表达demo模块下处理类包名。

1.2. Class 旳命名Class 旳名字必须由大写字母开头而其他字母都小写旳单词构成，对于所有标识符，其中包括旳所有单词都应紧靠在一起，并且大写中间单词旳首字母。

例如：public class ThisAClassName{}1.3. 变量旳命名对于变量旳命名，要尽量到达能通过变量名懂得这个变量体现旳含义，变量采用小写字母开头，对于由多种单词构成旳变量名，所有单词都应紧靠在一起，并且大写中间单词旳首字母。

对于常量（static final类型）采用如下方式命名：字母所有大写并使用下划线分隔单词（如：DB_CONFIG）。

1.4. 参数旳命名参数旳名字必须和变量旳命名规范一致。

1.5. 数组旳命名数组命名和变量命名类似，重要是能体现出这是一组数据。

1.6. 措施旳参数使用故意义旳参数命名。

同步请参照“变量旳命名”条目。

前言《阿里巴巴Java开发手册》是阿里巴巴集团技术团队的集体智慧结晶和经验总结，经历了多次大规模一线实战的检验及不断完善，系统化地整理成册，回馈给广大开发者。

现代软件行业的高速发展对开发者的综合素质要求越来越高，因为不仅是编程知识点，其它维度的知识点也会影响到软件的最终交付质量。

比如：数据库的表结构和索引设计缺陷可能带来软件上的架构缺陷或性能风险；工程结构混乱导致后续维护艰难；没有鉴权的漏洞代码易被黑客攻击等等。

所以本手册以Java开发者为中心视角，划分为编程规约、异常日志、单元测试、安全规约、MySQL数据库、工程结构、设计规约七个维度，再根据内容特征，细分成若干二级子目录。

根据约束力强弱及故障敏感性，规约依次分为强制、推荐、参考三大类。

对于规约条目的延伸信息中，“说明”对规约做了适当扩展和解释；“正例”提倡什么样的编码和实现方式；“反例”说明需要提防的雷区，以及真实的错误案例。

本手册的旨在码出高效，码出质量。

现代软件架构的复杂性需要协同开发完成，如何高效地协同呢？无规矩不成方圆，无规范难以协同，比如，制订交通法规表面上是要限制行车权，实际上是保障公众的人身安全，试想如果没有限速，没有红绿灯，谁还敢上路行驶。

对软件来说，适当的规范和标准绝不是消灭代码内容的创造性、优雅性，而是限制过度个性化，以一种普遍认可的统一方式一起做事，提升协作效率，降低沟通成本。

代码的字里行间流淌的是软件系统的血液，质量的提升是尽可能少踩坑，杜绝踩重复的坑，切实提升系统稳定性，码出质量。

考虑到可以零距离地与众多开发同学进行互动，决定未来在线维护《手册》内容，此1.4.0的PDF版本，是最为详尽的版本，新增设计规约大章节，并增加若干条目；我们已经在2017杭州云栖大会上发布了阿里巴巴Java开发规约插件（点此下载），阿里云效（一站式企业协同研发云）也集成了代码规约扫描引擎。

最后，《码出高效——阿里巴巴Java开发手册详解》即将出版，敬请关注。

Java编码规范一、 Java命名的一般性规范1. 类名首字母应该大写。

属性（成员变量）、方法、对象变量以及所有标识符（如形式参数、实际参数、局部变量）的首字母应小写，其中包含的所有单词都应紧靠在一起，而且大写中间单词的首字母。

例如：类名：ThisIsAClassName属性或方法名：thisIsMethodOrFieldName对象变量：thisIsAClassVariable2. Java 包（Package）属于一种特殊情况，它们全都是小写字母，即便中间的单词亦是如此。

对于全局包，将你的Internet 域名反转并接上包名，例如：com.yourcorp.web.public.package另外，package 行要在import 行之前，import 中标准的包名要在本地的包名之前，而且按照字母顺序排列。

如果import 行中包含了同一个包中的不同子目录，则应该用* 来处理。

例如package .stats;import java.io.*;import java.util.Observable;import hotlava.util.Application;这里 java.io.* 是用来代替InputStream and OutputStream 的。

3. 接口（Interface）：采用完整的英文描述符说明接口封装，所有单词的第一个字母大写。

习惯上，名字后面加上后缀able，ible 或者er。

例如：Contactable，Prompter。

4. 组件（Component）使用完整的英文描述来说明组件的用途，末端应接上组件类型。

例如：okButton，customerList，fileMenu。

5. 类中常用方法的命名：● 类的获取方法（一般具有返回值）一般要求被方法名使用被访问字段名，前面加上前缀get，如getFirstName(), getLastName()。

● 类的布尔型的判断方法一般要求方法名使用单词is 做前缀，如isPersistent(),isString()。

目录前言 (1)一、编程规约 (2)(一) 命名规约 (2)(二) 常量定义 (4)(三) 格式规约 (5)(四) OOP规约 (7)(五) 集合处理 (11)(六) 并发处理 (13)(七) 控制语句 (16)(八) 注释规约 (17)(九) 其它 (18)二、异常日志 (20)(一) 异常处理 (20)(二) 日志规约 (21)三、MySQL规约 (23)(一) 建表规约 (23)(二) 索引规约 (25)(三) SQL规约 (27)(四) ORM规约 (28)四、工程规约 (29)(一) 应用分层 (29)(二) 二方库规约 (30)(三) 服务器规约 (32)五、安全规约 (33)附1：版本历史 (34)附2：本规约专有名词 (34)附3：法律声明 (34)（注：全文浏览时请使用PDF左侧导航栏）前言《阿里巴巴Java开发手册》是阿里巴巴集团技术团队的集体经验总结，经历了多次大规模一线实战的检验及不断的完善，反馈给广大开发者。

现代软件行业的高速发展对于开发者的综合素质要求越来越高，因为不仅是编程知识点，其它维度的知识点也会影响到软件的最终交付质量。

比如：数据库的表结构和索引设计缺陷可能带来软件上的架构缺陷或性能风险；工程结构混乱导致维护困难；没有鉴权的漏洞代码被黑客攻击等等。

所以本手册以Java开发者为中心视角，划分为编程规约、异常日志规约、MySQL规约、工程规约、安全规约五大块，再根据内容特征，细分成若干二级子目录。

根据约束力强弱及故障敏感性，规约依次分为强制、推荐、参考三大类。

对于规约里的内容，“说明”对内容做了引申和解释；“正例”提倡什么样的编码和实现方式；“反例”说明需要提防的雷区，以及真实的错误案例。

本手册的愿景是码出质量、码出高效。

代码的字里行间流淌的是软件生命中的血液，质量的提升是尽可能少踩坑，杜绝踩重复的坑，切实提升质量意识。

另外，现代软件架构都需要协同开发完成，高效考虑的是降低协同成本，所谓无规矩不成方圆，无规范不能协作。

阿里巴巴java开发手册解析一、前言阿里巴巴java开发手册是一份非常全面、系统的技术规范，囊括了Java开发中的方方面面。

它旨在帮助开发人员编写高质量、高效率、安全性和可维护性兼具的Java代码，同时也提供了一些在实际项目中积累的经验和范例。

在本文中，我将对阿里巴巴java开发手册进行全面解析，深入探讨其中的重要规范和原则，以期能够帮助读者更好地理解和应用这些规范。

二、基本概念与原则1. 命名规范在阿里巴巴java开发手册中，对于包名、类名、方法名、变量名等的命名规范有非常详细的要求。

包名统一使用小写，类名使用驼峰命名法等。

这些统一规范的命名方式可以使得代码更加易读易懂，提高了代码的可维护性。

2. 代码风格在代码风格方面，阿里巴巴java开发手册提出了一系列的规范，包括缩进、括号的使用、代码注释等。

这些规范的制定可以使得团队内的代码风格更加统一，也有利于降低代码维护的难度。

3. 异常处理在异常处理方面，规范了异常的抛出和捕获、异常信息的打印等。

合理的异常处理可以提高代码的健壮性和可靠性，避免了不必要的异常被悄悄吞噬。

三、深入探讨1. 泛型阿里巴巴java开发手册对于泛型的使用有着详细的规范和说明，其中包括泛型的基本概念、通配符的使用、泛型方法等。

通过学习这些规范，我们可以更加深入地理解泛型的原理和使用方法，在实际项目中更加灵活地应用泛型。

2. 多线程在多线程编程方面，阿里巴巴java开发手册提出了一些高质量的编码原则和规范，包括多线程安全指南、可见性原则、可重入锁等。

这些规范有助于开发人员更加深入地理解多线程编程中的重要概念和原理，编写出更加高效、安全的多线程代码。

3. 安全性在安全性方面，阿里巴巴java开发手册对于输入校验、输出编码、敏感信息保护等提出了一些规范。

这些规范可以帮助开发人员更加深入地理解安全编程的重要性，避免了常见的安全漏洞。

四、总结与回顾阿里巴巴java开发手册作为一份全面、系统的技术规范，囊括了Java 开发中的方方面面。

Java程序的编码规范所有的程序开发手册都包含了各种规则。

一些习惯自由程序人员可能对这些规则很不适应，但是在多个开发人员共同写作的情况下，这些规则是必需的。

这不仅仅是为了开发效率来考虑，而且也是为了后期维护考虑。

一、命名规范定义这个规范的目的是让项目中所有的文档都看起来像一个人写的，增加可读性，减少项目组中因为换人而带来的损失。

(这些规范并不是一定要绝对遵守，但是一定要让程序有良好的可读性)> Package 的命名Package 的名字应该都是由一个小写单词组成。

> Class 的命名Class 的名字必须由大写字母开头而其他字母都小写的单词组成。

> Class 变量的命名变量的名字必须用一个小写字母开头。

后面的单词用大写字母开头。

> Static Final 变量的命名Static Final 变量的名字应该都大写，并且指出完整含义。

> 参数的命名参数的名字必须和变量的命名规范一致。

> 数组的命名数组应该总是用下面的方式来命名：1.byte[] buffer;而不是：1.byte buffer[];> 方法的参数使用有意义的参数命名，如果可能的话，使用和要赋值的字段一样的名字：1.SetCounter(int size){2.3.this.size = size;4.}二、Java文件样式所有的 Java(*.java) 文件都必须遵守如下的样式规则：> 版权信息版权信息必须在java文件的开头，比如：1./**2. * Copyright ?2000 Shanghai XXX Co. Ltd.3. * All right reserved.4. */其他不需要出现在javadoc的信息也可以包含在这里。

> Package/Importspackage 行要在import行之前，import中标准的包名要在本地的包名之前，而且按照字母顺序排列。

概述1.1编写目的本文描述了JAVA开发中的有关包、类、接口、方法、实例变量、变量和常量的命名规则，用于规范JAVA编程过程中的命名和代码书写规范。

1.2适用范围适用于开发组所有基于JAVA开发的项目。

2命名规范2.1包命名规则开发组将基于JAVA开发中产生的包分为两类，一是与各业务系统相关的包，一是与业务系统无关的、可公用的包。

它们的命名规则除要遵守“包名应全部是小写字母，包名中不能出现下划线，并且第一个字母不能是数字，单词间不要用字符隔开”的规则。

2.1.1与业务系统相关的包命名与业务系统相关的包命名格式为：com.wisoft.<projectname>.<modulename>。

其中：<projectname>为项目英文简称或缩写；<modulename>为模块英文名称或简称，如果无细分模块的话可省略模块名。

2.2类名、接口命名规则类和接口的名称应是一个名词，采用大小写混和的方式，如果使用拼音则应是全拼，所有单词都应紧靠在一起，其中每个单词的首字母应大写，接口名称应以大写I开始，类名、接口命名要首字母大写。

2.2.1 后缀类名往往用不同的后缀表达额外的意思，如下表：2.3方法命名规则方法名应是一个动词或动名结构，并且，动词在前；采用大小写混和的方式，其中第一个单词的首字母用小写，其后单词的首字母大写。

每个方法前必须加说明包括：参数说明、返回值说明、异常说明。

如果方法名实在是太长可以对变量名缩写，但是必须添加相应的说明。

2.3.1动词前缀往往表达特定的含义，如下表：2.4变量命名规则变量命名一般采用大小写混和的方式，第一个单词的首字母小写，其后单词的首字母大写，变量名一般不要用下划线或美元符号开头。

变量名应简短且有意义，即，能够指出其用途。

除非是一次性的临时变量，应尽量避免单个字符的变量名。

变量名左对齐。

（1）类的实例对象定义如下：Person person;（2）同一个类的多个对象可以采用一下定义方式：Person person1；Person person2；（3）集合类的实例命名使用集合包含元素的英文名称的复数表示，例如：Vector persons;（4）如果变量名实在是太长可以对变量名缩写，但是必须在类说明或方法说明部分（视缩写的范围而定）进行说明。

第一章概述前言代码相当于程序的基石，一行行代码都是程序员的心血经过日日夜夜凝结而成的。

它不仅仅是一行一行的字母+文字，它是程序员思想和经验的总结；编码规范只是大家在程序范围内达成一致的约定，这样大家的代码就可以互相看懂，维护起来更加容易，思想更畅快的交流，经验更快的得到传播。

代码规范不是限制程序员的个性，应该知道，不遵守规范的个性的代码并不代表程序员的性格，并不能张扬个性。

个性应该体现在用更简单、更优雅、更易读、更易理解以及算法实现效率更高等方面。

可读性，可理解性是代码的重要方面，本规范主要围绕如何去产生规范易读的代码。

另外，它也保证了大家对同一代码段使用共同的语言进行描述。

匈牙利命名法（Hungarian notation）通过在变量名前面加上相应的小写字母的符号标识作为前缀，标识出变量的作用域，类型等。

这些符号可以多个同时使用，顺序是先m_（成员变量），再指针，再简单数据类型，再其他。

例如：m_lpszStr, 表示指向一个以0字符结尾的字符串的长指针成员变量。

骆驼命名法（Camel）混合使用大小写字母来构成变量和函数的名字例如：person, orderDetail, oilTank帕斯卡命名法（Pascal）与骆驼命名法类似，所有单词第一个字母大写，其它字母小写例如：OilLevel, CustomerName没有一个规范可以到处适用，也不可能无所不包。

1.本规范并非完全强制性规范，对于任何违背本规范但能提高代码可读性的措施，都可以采用。

2.本规范第3，4，5 章为强制性规范，其它章节为建议规范。

如违背本条，请参考第一条。

1.所有包，类，接口，方法，属性，变量，参数均使用英文单词进行命名，具体细节请参见命名规范一章。

2.命名包，类，接口，方法以及变量时，尽量使用贴近问题域的表意丰富的名称。

3.修改源代码时，应尽量保持与所修改系统的编码风格保持一致。

修改时，请注释掉修改的内容，并注明修改的时间及原因。

Java开发规范（参照阿⾥规范改编）JAVA 开发规范v1.0.0 2021/08/27本篇规范基于阿⾥巴巴、华为的开发⼿册，补充了⼀些细节。

规范不是为了约束和禁锢⼤家的创造⼒，⽽是为了帮助⼤家能够在正确的道路上，尽可能的避免踩坑和跑偏。

规范可以让我们⽆论单枪匹马还是与众⼈同⾏的时候都能得⼼应⼿。

规范可以让我们在⾯对⽇益变态的需求和做代码接盘侠的时候，更优雅从容。

⼀、编程规范1、好代码的原则我们参考 Kent Beck 的简单设计四原则来指导我们的如何写出优秀的代码，如何有效地判断我们的代码是优秀的。

通过所有测试（Passes its tests）：强调的是外部需求，这是代码实现最重要的尽可能消除重复 (Minimizes duplication)：代码的模块架构设计，保证代码的正交性，保证代码更容易修改尽可能清晰表达 (Maximizes clarity)：代码的可阅读性，保证代码是容易阅读的更少代码元素 (Has fewer elements)：保证代码是简洁的，在简洁和表达⼒之间，我们更看重表达⼒以上四个原则的重要程度依次降低，这组定义被称做简单设计原则。

22-1全部采⽤⼩写⽅式，以中划线分隔。

正例：mall-management-system / order-service-client / user-api反例：mall_management-system / mallManagementSystem / orderServiceClient2-2模块名称：{项⽬名称}-{模块名称} 模块名称简洁体现职责模块名字作为模块组件的名称（即maven中的标签）2-3包名不应该⽤来表达模块完整的意思，包名应该仅⽤作与同包下的其他包做区分。

但尽可能使⽤单个单词命名，如果单个单词⽆法正确表达，可采⽤.分割，实在不⾏可采⽤全部单词⼩写（参考的spring命名）2-4类名使⽤ UpperCamelCase 风格，必须遵从驼峰形式，但以下情形例外：DO / BO / DTO / VO / AO ；抽象类命名使⽤ Abstract 或 Base 开头；异常类命名使⽤ Exception 结尾；测试类命名以它要测试的类的名称开始，以 Test 结尾；如果使⽤到了设计模式，建议在类名中体现出具体模式；枚举类名建议带上 Enum 后缀，枚举成员名称需要全⼤写，单词间⽤下划线隔开。