一起养成写作习惯！这是我参与「掘金日新计划 · 4 月更文挑战」的第2天，点击查看活动详情。

这是我自己对于阿里Java开发手册（黄山版）一些规约的总结，手册里面有很多知识点是日常开发中经常遇到且困惑的。书写该博文供日常翻查，并且渐渐地去试行到工作以及日常开发中。

文档的获取途径可以通过GitHub链接下载。

一、命名风格

1.1、所有命名

所有编程相关命名不能以下划线或美元符号_$开始或结束；
所有编程相关命名严禁使用拼音与英文混合的方式，也不允许直接使用中文的方式（按照正确的英文拼写和语法）；
代码和注释中避免使用任何人类语言中种族歧视或侮辱性词语；
为了达到代码自解释的目标，任何自定义编程元素在命名时，使用完整的单词组合来表达；
如果模块、接口、类、方法使用了设计模式，在命名时要体现出具体模式。

1.2、类、接口

类名使用UpperCamelCase风格（使用大写英文字母打头）；
抽象类命名使用Abstract或Base开头；
异常类命名使用Exception结尾；
测试类命名以它要测试的类的名称开始，以Test结尾；
接口类中的方法和属性不要加任何修饰符号（public也不要加），保持代码的简洁性，并加上有效的Javadoc注释*；
接口和实现类的命名规则：
1. 对于Service和DAO类，内部的实现类用Impl的后缀与接口区别；
  
  CacheServiceImpl实现CacheService接口
2. 如果是形容能力的接口名称，取对应的形容词为接口名（通常是-able结尾的形容词）。
  
  AbstractTranslator实现Translatable
枚举类*名带上Enum后缀，枚举成员名称需要全大写，单词间下划线隔开。

1.3、方法、参数、成员变量、局部变量、常量、数组

方法名、参数名、成员变量、局部变量使用lowerCamelCase风格（使用小写英文字母打头）；
常量命名应该全部大写，单词间用下划线隔开；
类型与中括号紧挨相连来定义数组 Type[] arrayList；
在常量与变量命名时，表示类型的名词放在词尾，以提高辨识度nameList/startTime/workQueue；

1.4、包名

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

1.5、各层命名规约

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

二、代码格式

2.1、大括号、小括号

如果大括号内为空，简洁地写成{}即可，大括号中间无需换行和空格；

如果非空代码块，则：

public static void main(String[] args) {// 左边大括号前加空格切不换行，左大括号后换行
			if (xxx == xx) {
					xxxxx
					// 右大括号前换行，右大括号后有else，else在同一行，不用换行
			} else {
					xxxxx
			} // 在右大括号后直接结束，则必须换行
}
复制代码

if/for/while/switch/do等保留字与左右括号之间都必须加空格；
左小括号和右边相邻字符之间不需要空格；
右小括号和左边相邻字符之间不需要空格；
左大括号前要加空格；

2.2、运算符

任何二目、三目运算符的左右两边都要加一个空格（包括赋值运算符=、逻辑运算符&&、加减乘除符号等；

2.3、其它

采用4个空格缩进，禁止使用tab字符（可以在ide进行tab缩进的设置）；
注释的双斜线与注释内容之间有且仅有一个空格；
在进行类型强制转换时，右括号与强制转换值之间不需要任何空格隔开；
单行字符数限制不超过120个，超出需要换行，换行时遵循如下原则：
- 第二行相对第一行缩进4个空格，从第三行开始，不再继续缩进；
- 运算符与下文一起换行；
- 方法调用的点符号与下文一起换行；
- 方法调用中的多个参数需要换行时，在逗号后进行；
- 在括号前不要换行。
方法参数在定义和传入时，多个参数逗号后面必须加空格；

method(arg1, arg2, arg3);
单个方法总行数不超过80行；
没有必要增加若干空格来使变量的赋值等号与上一行对应位置的等号对齐；

未完待续....

三、总结

后续有空再陆陆续续添加mysql相关、Java相关规约补充，很多规约没有形成文档的时候都是一团乱麻。好比看了阿里的开发手册后我才发现公司框架中很多地方是遵循了这个规约但是并没有文档可以参考，大部分的编码风格都是靠项目初期整理或搭建框架的“大佬“定下的主基调，后续的人有的遵循着开发有的就另辟自己的风格，导致项目中很多东西都很难理解和看懂，冗余以及效率上的问题时有发生。

最近有在听《组织进化论》的播客节目，硬知识干货不少，硬广爸爸飞书的推广也是很足，导致现在让我感觉不使用飞书就不是好企业的幻觉。但是有一点特别赞同的，不管是哪个工作时期，工作中留下文档是很必要的，不管是让别人知道你干了些什么，或者是你会干什么，更或者是你离职了之后后面的人如何接手你的工作，都是一个很好的参考，对于你自己的复盘也是一个很棒的资料。推荐大家积极留下文档，但不限于形式。

【Java】阿里Java开发手册-部分总结（一）