没有合适的资源?快使用搜索试试~ 我知道了~
首页阿里巴巴开发规范.docx
阿里巴巴开发规范 一、编程规约 1 (一) 命名规约 1 (二) 常量定义 3 (三) 格式规约 4 (四) OOP 规约 6 (五) 集合处理 10 (六) 并发处理 12 (七) 控制语句 15 (八) 注释规约 16 (九) 其它 17 二、异常日志 19 (一) 异常处理 19 (二) 日志规约 20 三、MySQL 规约 22 (一) 建表规约 22 (二) 索引规约 23 (三) SQL 规约 25 (四) ORM 规约 26 四、工程规约 27 (一) 应用分层 27 (二) 二方库规约 28 (三) 服务器规约 30 五、安全规约 31
资源详情
资源评论
资源推荐

JAVA 开发手册
目录
一、编程规约....................................................................................................................1
(一) 命名规约..........................................................................................................1
(二) 常量定义..........................................................................................................3
(三) 格式规约..........................................................................................................4
(四) OOP 规约.........................................................................................................................6
(五) 集合处理.........................................................................................................10
(六) 并发处理.........................................................................................................12
(七) 控制语句.........................................................................................................15
(八) 注释规约.........................................................................................................16
(九) 其它...............................................................................................................17
二、异常日志...................................................................................................................19
(一) 异常处理.........................................................................................................19
(二) 日志规约.........................................................................................................20
三、MySQL 规约.............................................................................................................22
(一) 建表规约.........................................................................................................22
(二) 索引规约.........................................................................................................23
(三) SQL 规约.......................................................................................................................25
(四) ORM 规约......................................................................................................................2 6
四、工程规约...................................................................................................................27
(一) 应用分层.........................................................................................................27
(二) 二方库规约.....................................................................................................2 8
(三) 服务器规约.....................................................................................................3 0
五、安全规约...................................................................................................................31

阿里巴巴 Java 开发手册
Java 开发手册
版本号 制定团队 更新日期 备注
1.0.0
阿里巴巴集团技术团队
2017.2.9
正式版
一、编程规约
(一) 命名规约
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[]的方式来定义。
——
禁止用于商业用途,违者必究——
1 / 34

阿里巴巴 Java 开发手册
8. 【强制】POJO
类中布尔类型
的变量,都不
要加 is,否则
部分框架解析
会引起序列化
错误。 反例:
定义为基本数
据类型 boolean
isSuccess;的
属性,它的方
法也是
isSuccess(),R
PC
框 架在反向解
析的时候,“以
为”对应的属性
名 称 是
success , 导 致
属性获取不到
进而抛出异 常。
9. 【 强制 】 包 名
统一使用小写
点 分隔 符 之 间
有 且仅 有 一 个
自 然语 义的 英
语 单词 。 包 名
统一使用 单数
形 式 , 但 是类
名 如果 有复 数
含 义 , 类 名可
以 使用 复数 形
式。
正例: 应用
工具 类包 名
为
com.alibaba.
open.util、类
名 为
MessageUtils
( 此 规 则 参
考 spring 的
框架结构)

10. 【强制】杜绝
完全不规范的
缩写,避免望
文不知义。
反例:
AbstractClass
“缩写”命名成
AbsClass;
condition“缩写”
命名成 condi,
此类
随意缩写严重
降低了代码的
可阅读性。
11. 【推荐】如果
使用到了设计模式,
建议在类名中体现
出具体模式。
说明:将设计
模式体现在名
字中,有利于
阅读者快速理
解架构设计思
想。
正例:
p
u
b
l
i
c
c
l
a
s
s
O
r
d
e
r
F
a
c
t

o
r
y
;
p
u
b
l
i
c
c
l
a
s
s
L
o
g
i
n
P
r
o
x
y
;
p
u
b
l
i
c
c
l
a
s
s
R
e
剩余63页未读,继续阅读













安全验证
文档复制为VIP权益,开通VIP直接复制

评论0