阿⾥新版java开发⼿册（2019华⼭版、2020泰⼭版）
pdf⽂件链接:
提取码: in6y
⽬录
⼀、编程规约
(⼀) 命名风格
1. 【强制】代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。
反例：_name / __name / $name / name_ / name$ / name__
2. 【强制】代码中的命名严禁使⽤拼⾳与英⽂混合的⽅式，更不允许直接使⽤中⽂的⽅式。
说明：正确的英⽂拼写和语法可以让阅读者易于理解，避免歧义。注意，纯拼⾳命名⽅式更要避免采⽤。
正例：renminbi / alibaba / taobao / youku / hangzhou 等国际通⽤的名称，可视同英⽂。
反例：DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3
3. 【强制】类名使⽤ UpperCamelCase 风格，但以下情形例外：DO / BO / DTO / VO / AO / PO / UID 等。
正例：JavaServerlessPlatform / UserDO / XmlService / TcpUdpDeal / TaPromotion
反例：javaserverlessplatform / UserDo / XMLService / TCPUDPDeal / TAPromotion
4. 【强制】⽅法名、参数名、成员变量、局部变量都统⼀使⽤ lowerCamelCase 风格，必须遵从驼峰形式。
正例： localValue / getHttpMessage() / inputUserId
5. 【强制】常量命名全部⼤写，单词间⽤下划线隔开，⼒求语义表达完整清楚，不要嫌名字长。
正例：MAX_STOCK_COUNT / CACHE_EXPIRED_TIME
反例：MAX_COUNT / EXPIRED_TIME
6. 【强制】抽象类命名使⽤ Abstract 或 Base 开头；异常类命名使⽤ Exception 结尾；测试类命名以它要测试的类的名称开始，以 Test 结尾。
7. 【强制】类型与中括号紧挨相连来表⽰数组。
正例：定义整形数组 int[] arrayDemo;
反例：在 main 参数中，使⽤ String args[]来定义。
8. 【强制】POJO 类中布尔类型变量都不要加 is 前缀，否则部分框架解析会引起序列化错误。
说明：在本⽂ MySQL 规约中的建表约定第⼀条，表达是与否的值采⽤ is_xxx 的命名⽅式，所以，需要在<resultMap>设置从 is_xxx 到xxx 的映射关系。
反例：定义为基本数据类型 Boolean isDeleted 的属性，它的⽅法也是 isDeleted()，RPC 框架在反向解析的时候，“误以为”对应的属性名称是 deleted，导致属性获取不到，进⽽抛出异常。
9. 【强制】包名统⼀使⽤⼩写，点分隔符之间有且仅有⼀个⾃然语义的英语单词。包名统⼀使⽤单数形式，但是类名如果有复数含义，类名可以使⽤复数形式。
正例：应⽤⼯具类包名为 com.alibaba.ai.util、类名为 MessageUtils（此规则参考 spring 的框架结构）
10.【强制】避免在⼦⽗类的成员变量之间、或者不同代码块的局部变量之间采⽤完全相同的命名，使可读性降低。
说明：⼦类、⽗类成员变量名相同，即使是 public 类型的变量也是能够通过编译，⽽局部变量在同⼀⽅法
内的不同代码块中同名也是合法的，但是要避免使⽤。对于⾮ setter/getter 的参数名称也要避免与成员变量名称相同。
反例：
public class ConfusingName {
public int age;
// ⾮ setter/getter 的参数名称，不允许与本类成员变量同名
public void getData(String alibaba) {
if (true) {
final int money = 531;
// ...
}
for (int i = 0; i < 10; i++) {
// 在同⼀⽅法体中，不允许与其它代码块中的 taobao 命名相同
final int money = 615;
// ...
}
}
}
class Son extends ConfusingName {
// 不允许与⽗类的成员变量名称相同
public int age;
}
11.【强制】杜绝完全不规范的缩写，避免望⽂不知义。
反例：AbstractClass“缩写”命名成 AbsClass；condition“缩写”命名成 condi，此类随意缩写严重降低了代码的可阅读性。
12.【推荐】为了达到代码⾃解释的⽬标，任何⾃定义编程元素在命名时，使⽤尽量完整的单词组合来表达其意。
正例：在 JDK 中，表达原⼦更新的类名为：AtomicReferenceFieldUpdater。
反例：int a 的随意命名⽅式。
13.【推荐】在常量与变量的命名时，表⽰类型的名词放在词尾，以提升辨识度。
正例：startTime / workQueue / nameList / TERMINATED_THREAD_COUNT
反例：startedAt / QueueOfWork / listName / COUNT_TERMINATED_THREAD
14.【推荐】如果模块、接⼝、类、⽅法使⽤了设计模式，在命名时需体现出具体模式。
说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计理念。
正例： public class OrderFactory;
public class LoginProxy;
public class ResourceObserver;
15.【推荐】接⼝类中的⽅法和属性不要加任何修饰符号（public 也不要加），保持代码的简洁性，并加上有效的 Javadoc 注释。尽量不要在接⼝⾥定义变量，如果⼀定要定义变量，肯定是与接⼝⽅法相关，并且是整个应⽤的基础常量。
正例：接⼝⽅法签名 void commit();
接⼝基础常量 String COMPANY = "alibaba";
反例：接⼝⽅法定义 public abstract void f();
说明：JDK8 中接⼝允许有默认实现，那么这个 default ⽅法，是对所有实现类都有价值的默认实现。
16.接⼝和实现类的命名有两套规则：
1）【强制】对于 Service 和 DAO 类，基于 SOA 的理念，暴露出来的服务⼀定是接⼝，内部的实现类⽤Impl 的后缀与接⼝区别。正例：CacheServiceImpl 实现 CacheService 接⼝。
2） 【推荐】如果是形容能⼒的接⼝名称，取对应的形容词为接⼝名（通常是–able 的形容词）。
正例：AbstractTranslator 实现 Translatable 接⼝。
17.【参考】枚举类名带上 Enum 后缀，枚举成员名称需要全⼤写，单词间⽤下划线隔开。
说明：枚举其实就是特殊的类，域成员均为常量，且构造⽅法被默认强制是私有。
正例：枚举名字为 ProcessStatusEnum 的成员名称：SUCCESS / UNKNOWN_REASON。
18.【参考】各层命名规约：
java编译器ide最新版下载A) Service/DAO 层⽅法命名规约
1） 获取单个对象的⽅法⽤ get 做前缀。
2） 获取多个对象的⽅法⽤ list 做前缀，复数形式结尾如：listObjects。
3） 获取统计值的⽅法⽤ count 做前缀。
4） 插⼊的⽅法⽤ save/insert 做前缀。
5） 删除的⽅法⽤ remove/delete 做前缀。
6） 修改的⽅法⽤ update 做前缀。
B) 领域模型命名规约
1） 数据对象：xxxDO，xxx 即为数据表名。
2） 数据传输对象：xxxDTO，xxx 为业务领域相关的名称。
3） 展⽰对象：xxxVO，xxx ⼀般为⽹页名称。
4） POJO 是 DO/DTO/BO/VO 的统称，禁⽌命名成 xxxPOJO。
(⼆) 常量定义
1. 【强制】不允许任何魔法值（即未经预先定义的常量）直接出现在代码中。
反例：String key = "Id#taobao_" + tradeId;
cache.put(key, value);
// 缓存 get 时，由于在代码复制时，漏掉下划线，导致缓存击穿⽽出现问题
2. 【强制】在 long 或者 Long 赋值时，数值后使⽤⼤写的 L，不能是⼩写的 l，⼩写容易跟数字 1 混淆，造成误解。
说明：Long a = 2l; 写的是数字的 21，还是 Long 型的 2。
3. 【推荐】不要使⽤⼀个常量类维护所有常量，要按常量功能进⾏归类，分开维护。
说明：⼤⽽全的常量类，杂乱⽆章，使⽤查功能才能定位到修改的常量，不利于理解和维护。
正例：缓存相关常量放在类 CacheConsts 下；系统配置相关常量放在类 ConfigConsts 下。
4. 【推荐】常量的复⽤层次有五层：跨应⽤共享常量、应⽤内共享常量、⼦⼯程内共享常量、 包内共享常量、类内共享常量。
1） 跨应⽤共享常量：放置在⼆⽅库中，通常是 client.jar 中的 constant ⽬录下。
2） 应⽤内共享常量：放置在⼀⽅库中，通常是⼦模块中的 constant ⽬录下。
反例：易懂变量也要统⼀定义成应⽤内共享常量，两位⼯程师在两个类中分别定义了“YES”的变量：
类 A 中：public static final String YES = "yes";
类 B 中：public static final String YES = "y";
A.YES.equals(
B.YES)，预期是 true，但实际返回为 false，导致线上问题。
3） ⼦⼯程内部共享常量：即在当前⼦⼯程的 constant ⽬录下。
4） 包内共享常量：即在当前包下单独的 constant ⽬录下。
5） 类内共享常量：直接在类内部 private static final 定义。
5. 【推荐】如果变量值仅在⼀个固定范围内变化⽤ enum 类型来定义。
说明：如果存在名称之外的延伸属性应使⽤ enum 类型，下⾯正例中的数字就是延伸信息，表⽰⼀年中的第⼏个季节。
正例：
public enum SeasonEnum {
SPRING(1), SUMMER(2), AUTUMN(3), WINTER(4);
private int seq;
SeasonEnum(int seq) {
this.seq = seq;
}
public int getSeq() {
return seq;
}
}
(三) 代码格式
1. 【强制】如果是⼤括号内为空，则简洁地写成{}即可，⼤括号中间⽆需换⾏和空格；如果是⾮空代码块则：
1） 左⼤括号前不换⾏。
2） 左⼤括号后换⾏。
3） 右⼤括号前换⾏。
4） 右⼤括号后还有 else 等代码则不换⾏；表⽰终⽌的右⼤括号后必须换⾏。
2. 【强制】左⼩括号和字符之间不出现空格；同样，右⼩括号和字符之间也不出现空格；⽽左⼤括号前需要空格。详见第 5 条下⽅正例提⽰。
反例：if (空格 a == b 空格)
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 点）
public static void main(String[] args) {
// 缩进 4 个空格
String say = "hello";
// 运算符的左右必须有⼀个空格
int flag = 0;
// 关键词 if 与括号之间必须有⼀个空格，括号内的 f 与左括号，0 与右括号不需要空格
if (flag == 0) {
System.out.println(say);
}
// 左⼤括号前加空格且不换⾏；左⼤括号后换⾏
if (flag == 1) {
System.out.println("world");
// 右⼤括号前换⾏，右⼤括号后有 else，不⽤换⾏
} else {
System.out.println("ok");
// 在右⼤括号后直接结束，则必须换⾏
}
}
6. 【强制】注释的双斜线与注释内容之间有且仅有⼀个空格。
正例：
// 这是⽰例注释，请注意在双斜线之后有⼀个空格
String param = new String();
7. 【强制】在进⾏类型强制转换时，右括号与强制转换值之间不需要任何空格隔开。正例：
long first = 1000000000000L;
int second = (int)first + 2;
8. 【强制】单⾏字符数限制不超过 120 个，超出需要换⾏，换⾏时遵循如下原则：
1）第⼆⾏相对第⼀⾏缩进 4 个空格，从第三⾏开始，不再继续缩进，参考⽰例。
2）运算符与下⽂⼀起换⾏。
3）⽅法调⽤的点符号与下⽂⼀起换⾏。
4）⽅法调⽤中的多个参数需要换⾏时，在逗号后进⾏。
5）在括号前不要换⾏，见反例。
正例：
StringBuilder sb = new StringBuilder();
// 超过 120 个字符的情况下，换⾏缩进 4 个空格，点号和⽅法名称⼀起换⾏
sb.append("Jack").append("Ma")...
.append("alibaba")...
.append("alibaba")...
.append("alibaba");
反例：
StringBuilder sb=new StringBuilder();
// 超过 120 个字符的情况下，不要在括号前换⾏
sb.append("Jack").append("Ma")...append
("alibaba");
// 参数很多的⽅法调⽤可能超过 120 个字符，不要在逗号前换⾏
method(args1,args2,args3,...
,argsX);
9. 【强制】⽅法参数在定义和传⼊时，多个参数逗号后边必须加空格。

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。