前言
《开发手册》是阿里巴巴集团技术团队的集体智慧结晶和经验总结，经历了多次
大规模一线实战的检验及不断完善，公开到业界后，众多社区开发者踊跃参与，共同打磨
完善，系统化地整理成册，当前的版本是嵩山版。现代软件行业的高速发展对开发者的综
合素质要求越来越高，因为不仅是编程知识点，其它维度的知识点也会影响到软件的最终
交付质量。比如：五花八门的错误码人为地增加排查问题的难度；数据库的表结构和索引
设计缺陷带来的系统架构缺陷或性能风险；工程结构混乱导致后续项目维护艰难；没有鉴
权的漏洞代码易被黑客攻击等等。所以本手册以 开发者为中
心视角，划分为编程规约、异常日志、单元测试、安全规约、数据库、工程结构、
设计规约七个维度，再根据内容特征，细分成若干二级子目录。另外，依据约束力强弱及
故障敏感性，规约依次分为【强制】、【推荐】、【参考】三大类。在延伸信息中，“说
明”对规约做了适当扩展和解释；“正例”提倡什么样的编码和实现方式；“反例”说明需要提
防的雷区，以及真实的错误案例。
手册的愿景是码出高效，码出质量。现代软件架构的复杂性需要协同开发完成，如何
高效地协同呢？无规矩不成方圆，无规范难以协同，比如，制订交通法规表面上是要限制
行车权，实际上是保障公众的人身安全，试想如果没有限速，没有红绿灯，谁还敢上路行
驶？对软件来说，适当的规范和标准绝不是消灭代码内容的创造性、优雅性，而是限制过
度个性化，以一种普遍认可的统一方式一起做事，提升协作效率，降低沟通成本。代码的
字里行间流淌的是软件系统的血液，质量的提升是尽可能少踩坑，杜绝踩重复的坑，切实
提升系统稳定性，码出质量。
我们已经在 杭州云栖大会上发布了配套的 开发规约 插件，下载量达到
万人次，阿里云效也集成了代码规约扫描引擎。次年，发布 万字的配套详解图书
《码出高效》，本书秉持“图胜于表，表胜于言”的理念，深入浅出地将计算机基础、面向
对象思想、探源、数据结构与集合、并发与多线程、单元测试等知识客观、立体地呈
现出来。紧扣学以致用、学以精进的目标，结合阿里巴巴实践经验和故障案例，与底层源
码解析融会贯通，娓娓道来。《码出高效》和《 开发手册》稿费所得收入均捐赠公益
事情，希望用技术情怀帮助更多的人
一、 编程规约
(一) 命名风格
【强制】代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结
束。
反例：
【强制】所有编程相关的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文
的方式。
说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，纯拼音命名方式更要避免采
开发手册（嵩山版）
剩余49页未读，继续阅读
评论0