1. 云栖社区>
  2. 博客列表>
  3. 正文

【Java编码规范】《阿里巴巴Java开发手册(正式版)》更新(v1.1.0版)

云木西 2017-02-08 17:01:38 浏览233503 评论89

java 阿里巴巴 开发手册

摘要: 阿里巴巴集团推出的《阿里巴巴Java开发手册(正式版)》是阿里巴巴近万名开发同学集体智慧的结晶,以开发视角为中心,详细列举如何开发更加高效、更加容错、更加有协作性,力求知其然,更知其不然,结合正反例,让Java开发者能够提升协作效率、提高代码质量。

2017年开春之际,诚意献上重磅大礼:阿里巴巴Java开发手册,首次公开阿里官方Java代码规范标准。这套Java统一规范标准将有助于提高行业编码规范化水平,帮助行业人员提高开发质量和效率、大大降低代码维护成本。

点击下载《阿里巴巴Java开发手册》(v1.1.0版):https://yq.aliyun.com/attachment/download/?id=1200

v1.1.0版更新说明:1)增加手册前言。2)增加版本历史。3)增加专有名词解释。

 (版本不断更新中,请收藏本文,以免错过重要更新)

94978f1bf8474dc3b2fe30b0fc0ff29f1e45b277

(点击参与话题讨论:Java开发者们,一起来聊聊大家的开发规约吧


你是否曾因Java代码规范版本纷杂而无所适从?

你是否想过代码规范能将系统故障率降低20%?

你是否曾因团队代码风格迥异而协同困难?

你是否正在review一些原本可以避免的故障?

你是否无法确定自己的代码足够健壮? 

码出高效,码出质量!

相比C++代码规范业界已经达成共识,Java代码规范业界比较混乱,我们期待这次发布的Java代码规范能够给业界带来一个标准,促使整体行业代码规范水平得到提高,最终能够帮助企业和开发者提升代码质量和降低代码故障率。

 

阿里出品,质量保证!

阿里Java技术团队一手打造出Dubbo、JStorm、Fastjson等诸多流行开源框架,部分已成为Apache基金会孵化项目;

阿里在Java后端领域支撑起全球访问量最大的服务器集群;

Java代码构建的阿里双11业务系统订单处理能力达到17.5万笔/秒;

到目前已累计数亿行高并发、高稳定性的最佳Java代码实践;

……

此次首度公开的Java开发手册正是出自这样的团队,近万名阿里Java技术精英的经验总结,并经历了多次大规模一线实战检验及完善,铸就了这本高含金量的阿里Java开发手册。该手册以Java开发者为中心视角,划分为编程规约、异常日志规约、MYSQL规约、工程规约、安全规约五大块,再根据内容特征,细分成若干二级子目录。根据约束力强弱和故障敏感性,规约依次分为强制、推荐、参考三大类。此套规范不仅能让代码一目了然, 更有助于加强团队分工与合作、真正提升效率。 


无规矩不成方圆 无规范不能协作

众所周知,制订交通法规表面上是要限制行车权,实际上是保障公众的人身安全。试想如果没有限速,没有红绿灯,没有规定靠右行驶,谁还敢上路行驶。 

同理,对软件来说,适当的规范和标准绝不是消灭代码内容的创造性、优雅性,而是限制过度个性化,以一种普遍认可的方式一起做事,降低故障率,提升协作效率。开发手册详细列举如何开发更加高效,更加容错,更加有协作性,力求知其然,更知其不然,结合正反例,提高代码质量。比如,异常日志处理时的各种不规范行为;集合转换的各种坑;创建线程池出现的等待队列OOM等。 


阿里技术资深大咖联袂推荐

阿里高级研究员多隆:工程师对于代码,一定要“精益求精”,不论从性能,还是简洁优雅,都要具备“精益求精”的工匠精神,认真打磨自己的作品。 

阿里研究员毕玄:一个优秀的工程师和一个普通工程师的区别,不是现在满天飞的架构图,他的功底就是体现在他写的每一行代码上。 

阿里研究员玄难:代码是软件工程里面的产品设计、系统架构设计等工作的最后承载体,代码的质量决定了一切工作的成败。 

阿里巴巴B2B事业群CTO李纯:好的软件产品离不开工程师高质量的代码及相互间顺畅的沟通与合作。简单,适用的代码规约背后所传递的是技术上的追求卓越、协同合作的精神,是每个技术团队不可缺失的重要利器。 

阿里研究员、HipHop作者:赵海平(花名:福贝):程序员是创造个性化作品的艺术家,但同时也是需要团队合作的工种。个性化应尽量表现在代码效率和算法方面,牺牲小我,成就大我。 


拥抱规范,远离伤害!

开发的同学们赶紧行动起来,遵守代码规范,你好,我好,大家好! 


【9元建站,点击立享:https://market.aliyun.com/tpldns


59794d5bb7e6873b96982944551182cd97f96856

(点击图片抢红包)


关注云栖社区微信公众号:

2adbbb40545618044d6ebff62c513480e7591581

用云栖社区APP,舒服~

【云栖快讯】2017开年大作,云栖大会·深圳峰会 3月28日开幕!37场论坛,2天云生态大展,100+分享嘉宾,更有云产业“奥斯卡”现场揭晓。现场坐席有限,报名倒计时中!  详情请点击

网友评论

1F
屏峰远望

可以当一个尺子了,量一下团队的代码质量~

dadadadadada

规范而已,很多时候不能代表代码质量

raorihong

厉害了

贾人rusher

第26页的ORM规约,不允许直接拿HashMap或者Hashtable作为查询结果集的输出是什么意思??sql查询出来的结果不是很多都是map了吗?

屏峰远望

如果不写对应的Class或者resultMap,那么可以直接通过Hashmap或者hashtable直接置入,虽然省事,但是会带来一些未知的数据转化问题。

孤尽

外部团队可以直接使用,或者在此基础上进行修订后公司内部使用。

铎铎哥哥

@贾人rusher 可操作性查

管局审查员

一流公司制定规范,二流公司申请专利,三流公司生产产品。

评论
2F
zangkang

真心不错!

3F
想想念念

很不错,对大规模应用java的团队很有指导意义

4F
司徒阿仔

棒,推荐给项目组成员

呵呵呵x

wad

评论
5F
云栖徒骇

你好,我好,大家好!

6F
snowdream86

火钳留名

7F
modprobe

8F
jimbray

下来学习一下

9F
米西

有python的手册没

(来自社区APP)
10F
板溪

集合中的:
12.【参考】合理利用好集合的有序性(sort)和稳定性(order),避免集合的无序性(unsort)和 不稳定性(unorder)带来的负面影响。 说明:稳定性指集合每次遍历的元素次序是一定的。有序性是指遍历的结果是按某种比较规则 依次排列的。如:ArrayList 是 order/unsort;HashMap 是 unorder/unsort;TreeSet 是 order/sort。

这里有关 ArrayList 和 TreeSet 的说明感觉弄反了.

mrclass

并不反,这里的有序说的是对象在集合中存放时是否会排序,不是存数据时的顺序。

kimi_xxd

领教,概念弄清楚很重要,有时候两个程序员将技术问题就像鸡与鸭的交流,都是基于自己的理解,规范的意义不仅在于提升代码质量和可以管理大规模代码,还在于给团队成员一个交流的统一语言,使沟通更更顺畅。

评论
11F
wendal

还好意思提dubbo,早就停更了

努力努力!依旧西卡 赞同
initiate

这么多人用,怎么不能提?

评论
12F
ccfdd

10.【推荐】使用CountDownLatch进行异步转同步操作,每个线程退出前必须调用countDown方 法,线程执行代码注意catch异常,确保countDown方法可以执行,避免主线程无法执行至countDown方法,直到超时才返回结果。

这里写错了应该改成 避免主线程无法执行至await方法,直到超时才返回结果。

gao本1676582893221743wyes 赞同
屏峰远望

现在最新版本是v1.0.2版本,此问题在1.0.1中已经修正,感谢提的反馈。

评论
13F
周梦康

加油

14F
淘实惠

不错

15F
wangkaimin

拜读

16F
hyhcgwq

多谢~

17F
casxter

学习中!

18F
玖伍贰柒

阿里的项目开源完就不管了

(来自社区APP)
19F
许工

好东西

(来自社区APP)
20F
wuyc

😊昨晚刚在找这方面的资料,挺好的。
在这里,我推荐其它语言的规范(来自Google项目)https://google.github.io/styleguide/

(来自社区APP)
jimyhj芝麻谷h515502400idealities 赞同
关注
云木西
云计算、大数据、人工智能技术之路上的徒步者
44篇文章|237关注
大数据开发套件(Data IDE),提供可视化开发界面、离线任务调度运维、快速数据集成、多人协同工作等功能,为您...

超过10,000,000域名在这里注册

国内建站市场NO.1

为您提供简单高效、处理能力可弹性伸缩的计算服务,帮助您快速构建更稳定、安全的应用,提升运维效率,降低 IT 成本...
开年采购季,惊喜不间断!

开年采购季,惊喜不间断!