阿里语法规范PDF资源-CSDN文库

需积分: 10 14 浏览量 2019-04-12 21:18:24 上传评论收藏 1.06MB PDF 举报

资源详情

资源评论

一、编程规约 ................................................................................................................................................................................ 1

(一) 命名规约 ................................................................................................................................................................ 1

(二) 常量定义 ................................................................................................................................................................ 3

(三) 格式规约 ................................................................................................................................................................ 4

(四) OOP 规约 ................................................................................................................................................................ 6

(五) 集合处理 ............................................................................................................................................................. 10

(六) 并发处理 ............................................................................................................................................................. 12

(七) 控制语句 ............................................................................................................................................................. 15

(八) 注释规约 ............................................................................................................................................................. 16

(九) 其它 ....................................................................................................................................................................... 17

二、异常日志 ............................................................................................................................................................................. 19

(一) 异常处理 ............................................................................................................................................................. 19

(二) 日志规约 ............................................................................................................................................................. 20

三、MySQL 规约 ....................................................................................................................................................................... 22

(一) 建表规约 ............................................................................................................................................................. 22

(二) 索引规约 ............................................................................................................................................................. 24

(三) SQL 规约 ............................................................................................................................................................. 26

(四) ORM 规约 ............................................................................................................................................................. 27

四、工程规约 ............................................................................................................................................................................. 28

(一) 应用分层 ............................................................................................................................................................. 28

(二) 二方库规约 ......................................................................................................................................................... 29

(三) 服务器规约 ......................................................................................................................................................... 31

五、安全规约 ............................................................................................................................................................................. 32

（注：全文浏览时请使用 PDF 左侧导航栏）

阿里巴巴 Java 开发手册

——禁止用于商业用途，违者必究—— 1 / 35

Java 开发手册

版本号

制定团队

更新日期

备注

1.0.0

阿里巴巴集团技术团队

2017.2.9

正式版

1.0.1

2017.2.13

修正部分描述

1.0.2

2017.2.20

修正部分示例

一、编程规约

(一) 命名规约

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

反例： _name / __name / $Object / name_ / name$ / Object$

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

说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式

也要避免采用。

反例： DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3

正例： alibaba / taobao / youku / hangzhou 等国际通用的名称，可视同英文。

3. 【强制】类名使用 UpperCamelCase 风格，必须遵从驼峰形式，但以下情形例外：（领域模型

的相关命名）DO / BO / DTO / VO 等。

正例：MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion

反例：macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion

4. 【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格，必须遵从

驼峰形式。

正例： localValue / getHttpMessage() / inputUserId

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

正例： MAX_STOCK_COUNT

反例： MAX_COUNT

6. 【强制】抽象类命名使用 Abstract 或 Base 开头；异常类命名使用 Exception 结尾；测试类

命名以它要测试的类的名称开始，以 Test 结尾。

7. 【强制】中括号是数组类型的一部分，数组定义如下：String[] args;

反例：使用 String args[]的方式来定义。

阿里巴巴 Java 开发手册

——禁止用于商业用途，违者必究—— 2 / 35

8. 【强制】POJO 类中布尔类型的变量，都不要加 is，否则部分框架解析会引起序列化错误。

反例：定义为基本数据类型 Boolean isSuccess；的属性，它的方法也是 isSuccess()，RPC

框架在反向解析的时候，“以为”对应的属性名称是 success，导致属性获取不到，进而抛出异

常。

9. 【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用

单数形式，但是类名如果有复数含义，类名可以使用复数形式。

正例：应用工具类包名为 com.alibaba.open.util、类名为 MessageUtils（此规则参考

spring 的框架结构）

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

反例： AbstractClass“缩写”命名成 AbsClass；condition“缩写”命名成 condi，此类

随意缩写严重降低了代码的可阅读性。

11. 【推荐】如果使用到了设计模式，建议在类名中体现出具体模式。

说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计思想。

正例：public class OrderFactory;

public class LoginProxy;

public class ResourceObserver;

12. 【推荐】接口类中的方法和属性不要加任何修饰符号（public 也不要加），保持代码的简洁

性，并加上有效的 Javadoc 注释。尽量不要在接口里定义变量，如果一定要定义变量，肯定是

与接口方法相关，并且是整个应用的基础常量。

正例：接口方法签名：void f();

接口基础常量表示：String COMPANY = "alibaba";

反例：接口方法定义：public abstract void f();

说明：JDK8 中接口允许有默认实现，那么这个 default 方法，是对所有实现类都有价值的默

认实现。

13. 接口和实现类的命名有两套规则：

1）【强制】对于 Service 和 DAO 类，基于 SOA 的理念，暴露出来的服务一定是接口，内部

的实现类用 Impl 的后缀与接口区别。

正例：CacheServiceImpl 实现 CacheService 接口。

2）【推荐】如果是形容能力的接口名称，取对应的形容词做接口名（通常是–able 的形式）。

正例：AbstractTranslator 实现 Translatable。

14. 【参考】枚举类名建议带上 Enum 后缀，枚举成员名称需要全大写，单词间用下划线隔开。

说明：枚举其实就是特殊的常量类，且构造方法被默认强制是私有。

正例：枚举名字：DealStatusEnum，成员名称：SUCCESS / UNKOWN_REASON。

阿里巴巴 Java 开发手册

——禁止用于商业用途，违者必究—— 3 / 35

15. 【参考】各层命名规约：

A) Service/DAO 层方法命名规约

1）获取单个对象的方法用 get 做前缀。

2）获取多个对象的方法用 list 做前缀。

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);

2. 【强制】long 或者 Long 初始赋值时，必须使用大写的 L，不能是小写的 l，小写容易跟数字

1 混淆，造成误解。

说明：Long a = 2l; 写的是数字的 21，还是 Long 型的 2?

3. 【推荐】不要使用一个常量类维护所有常量，应该按常量功能进行归类，分开维护。如：缓存

相关的常量放在类：CacheConsts 下；系统配置相关的常量放在类：ConfigConsts 下。

说明：大而全的常量类，非得使用查找功能才能定位到修改的常量，不利于理解和维护。

4. 【推荐】常量的复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包

内共享常量、类内共享常量。

1）跨应用共享常量：放置在二方库中，通常是 client.jar 中的 constant 目录下。

2）应用内共享常量：放置在一方库的 modules 中的 constant 目录下。

反例：易懂变量也要统一定义成应用内共享常量，两位攻城师在两个类中分别定义了表示

“是”的变量：

类 A 中：public static final String YES = "yes";

类 B 中：public static final String YES = "y";

A.YES.equals(B.YES)，预期是 true，但实际返回为 false，导致产生线上问题。

剩余34页未读，继续阅读

评论收藏

内容反馈

阿里语法规范PDF

评论0

最新资源

阿里语法规范PDF

评论0

最新资源

相关推荐

英语语法.pdf 英语语法.pdf

freemarker语法.pdf

mysql语法.pdf

C# 基础语法.pdf （纯干货）

高中英语语法系统全解.pdf

Python基础语法合集.pdf

阿里巴巴Java开发规范最新PDF20180208

浪漫英语语法.pdf

groovy基础语法.pdf

华为公司编程语法规范

XML语法.pdf

Markdown语法大全（超级版）.pdf

python基础语法.pdf

JAVA语法.pdf

JavaScript基本语法.pdf

Java基本语法.pdf

protobuf3 语法详解 pdf

Java基础语法.pdf

Java第十五届蓝桥杯大赛软件JavaB组真题

SwitchHosts

安卓期末大作业（AndroidStudio开发），垃圾分类助手app，分为前台后台，代码有注释，均能正常运行

Notepad++安装包

2024北森能力测评题库.7z

微信小程序源码-合集1.rar

Java面试八股文2023最新版

Linux Centos7 升级最新版OpenSSH-9.6p1 有脚本（支持离线）

JDK1.8 windows 64位

ruoyi-vue-pro 芋道源码项目的表结构

myeclipse 10.7.1 windows 安装包