阿里巴巴开发手册简介（附下载地址）

文章目录

一、简介

《Java 开发手册》是阿里巴巴集团技术团队的集体智慧结晶和经验总结，经历了多次大规模一线实战的检验及不断完善，公开到业界后，众多社区开发者踊跃参与，共同打磨完善，系统化地整理成册。现代软件行业的高速发展对开发者的综合素质要求越来越高，因为不仅是编程知识点，其它维度的知识点也会影响到软件的最终交付质量。
我复制出来的一些常用的标准，虽然比较基础，但是在日常生活中都能用的到的，最基础也最重要的；

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

    反例：_name / name / name/name/namename / 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，导致属性获取不到，进而抛出异常。

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

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

  2. 【强制】避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命名，使可读性降低。

说明： 子类、父类成员变量名相同，即使是 public 类型的变量也是能够通过编译，而局部变量在同一方法内的不同代码块中同名也是合法的，但是要避免使用。对于非 setter/getter 的参数名称也要避免与成员变量名称相同。

反例：

public class ConfusingName {
	public int age;
 // 非 setter/getter 的参数名称，不允许与本类成员变量同名
 public void getData(String alibaba) {
	if(condition) {
		final int money = 531;
 // ...
 }
	for (int i = 0; i < 10; i++) {
 // 在同一方法体中，不允许与其它代码块中的 money 命名相同
		final int money = 615;
 // ...
		}
	} 
}
class Son extends ConfusingName {
 // 不允许与父类的成员变量名称相同
 public int age; 
}
  1. 【强制】杜绝完全不规范的缩写，避免望文不知义。

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

二、下载地址

链接：https://pan.baidu.com/s/1vnu5wymPBJSm2b3YoDH7Rw 
提取码：wdi1
posted @ 2019-12-24 20:32  ah_lydms  阅读(277)  评论(0)  编辑  收藏  举报