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

阿里巴巴开源Java编码规范背后的故事

云木西 2017-03-07 13:52:06 浏览4238 评论1

安全 架构 算法 java 程序员 面向对象 阿里巴巴 索引 空格 编码规范 编程规则

摘要: 《阿里巴巴Java开发手册》(下称《手册》)凝聚了阿里集团很多同学的知识智慧和经验,这些经验甚至是用血淋淋的故障换来的,希望前车之鉴,后车之师,能够帮助更多的开发者少踩坑,杜绝踩重复的坑。

(作者:无独 | 校对:孤尽)
《阿里巴巴Java开发手册》(下称《手册》)凝聚了阿里集团很多同学的知识智慧和经验,这些经验甚至是用血淋淋的故障换来的,希望前车之鉴,后车之师,能够帮助更多的开发者少踩坑,杜绝踩重复的坑。 

手册下载:https://yq.aliyun.com/articles/69327

此手册从构思到现在的最新版本,历时一年半,历经无数次内部针锋相对的讨论,迭代105次。可以说手册中每一个条目的背后,都有一个很长、很精彩的故事。为了让广大开发者更加深入地了解到项目组的初衷,项目组第一次公开谈一些手册背后的故事。

为何叫《Java开发手册》?

第一、本手册主要是面向Java开发群体,Java做为面向对象语言,在业界的生命力还是非常强大的,技术生态丰富,框架结构成熟,经历了超高并发的“双十一”实战考验,阿里真诚地想把多年的Java技术积累回馈给Java开发者 社区。
第二、它是一个广义的编码规范, 一个随时可以查阅的技术参考,在手册中可以找到很多的技术规范、最佳实践,避坑指南等。

手册内容为何引入数据库、安全、服务器等知识?

现代软件行业的高速发展对于开发者的综合素质要求越来越高,因为不仅是编程知识,其它维度的知识结构也会影响到软件的最终交付质量。比如:数据库的表结构和索引设计缺陷可能带来软件上的架构缺陷或性能风险;工程结构混乱导致维护困难;没有鉴权的漏洞代码被黑客攻击等等。
所以手册以Java开发者为中心视角,划分为编程规约、异常日志规约、MySQL规约、工程规约、安全规约五大块。那么衍生的问题是为什么我们提到的这些看似与编码毫无关系的内容,有人说,仅安全规约如果扩展开来可以是上百页的资料,不知道写在《手册》里的意义何在,我们的答案是,手册关注的是与开发紧密相关的知识点,试问一个不知道水平权限校验的Java开发者,会是一个合格的程序员吗?《手册》不是提倡大家深究所有的知识点而成为安全专家、运维专家,而是关注在编码相关的生态知识上。

约束力等级为何是三级?

《手册》根据约束力强弱及故障敏感性,规约依次分为强制、推荐、参考三大类。强制是一种指令型的,是协作的Gap,或是故障的痛点;而推荐,希望这样做是一件好事,大家都这样做,结构更清晰,协作更高效,但是不这样做也不会死。而参考分成两种情况:第一种是无法用代码量化的描述,提倡什么什么样的做法,如索引的创建索引时,宁滥勿缺的错误做法;第二种是真心觉得或左或右都可以,只是有倾向于一种,这个自由度由开发者自己把握。
扩展的说明、正例、反例用来表达什么。如果只是冷冰冰的条目,对于阅读者理解成本和记忆成本都是很大的挑战,《手册》希望阅读者能够非常舒心地看完整个文档,掩卷遐思,亦有所得。具体来说, “说明”是对内容做了引申和解释,为求知其然;“正例”提倡什么样的编码和实现方式,推荐做法的其中之一;“反例”说明需要提防的雷区,以及真实的错误案例,让人知其不然。
最后,《手册》的愿景是码出质量、码出高效,即代码的字里行间如何提升系统的质量,如何提升协作的高效性。 我们提倡算法效率和架构扩展的个性化,而不是代码风格随意化,尽量减少没有营养的“圣战”,如:4个空格、单行语句换行等。程序员是天生幻想创造个性化作品的艺术家,变着法子想着要如何与众不同,最好代码只有自己能够看懂,只有自己能够维护。

码出质量、码出高效

真正的艺术家是个性独立、张扬文化的群体,他们之间不需要协同工作,大家很少见过书法,画画、雕塑是一个团队协作来创作完成的,但是程序员这个工种,天生需要团队协作,而协作的正能量要放在问题的有效讨论和快速解决上, 个性化应尽量表现在代码质量和算法效率的提升上,而不是对于合作规范上纠缠不休的争论。再者,公司是请程序员来产出实际价值的,而不是经常消耗时间为几个空格的事情争得脸红脖子粗的。有时候,就是一个规定,大家这么做了,协作效率自然就提升了,正所谓无规矩不成方圆,无规范难以协作。

用云栖社区APP,舒服~

【云栖快讯】快速解决数据库难题,云数据库经典案例及最佳实践直播专场!阿里云数据库专家团队成员倾囊相授!赶紧报名。  详情请点击

网友评论

1F
言语萌萌123

😂

(来自社区APP)
关注
云木西
云计算、大数据、人工智能技术之路上的徒步者
44篇文章|331关注
凝聚阿里巴巴多年来在无线业务安全防御的成功经验和技术成果,并面向开发者和企业提供安全扫描、应用加固、安全组件、数...

阿里云机器学习是基于阿里云分布式计算引擎的一款机器学习算法平台。用户通过拖拉拽的方式可视化的操作组件来进行试验,...

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

为您提供简单高效、处理能力可弹性伸缩的计算服务,帮助您快速构建更稳定、安全的应用,提升运维效率,降低 IT 成本...
2017云栖大会·上海峰会火热报名中

2017云栖大会·上海峰会火热报名中