看过很多公司的代码规范,阿里的最完善,Google 与 Twitter 的风格指南则分别代表了大厂对 Java 风格的两种取向。本篇是这个知识体系的总览,后续各篇逐一展开。
阿里巴巴 Java 开发手册
《阿里巴巴 Java 开发手册》是阿里巴巴集团技术团队的集体经验总结,经历了多次大规模一线实战的检验及不断的完善,反馈给广大开发者。现代软件行业的高速发展对开发者的综合素质要求越来越高,因为不仅是编程知识点,其它维度的知识点也会影响到软件的最终交付质量。比如:数据库的表结构和索引设计缺陷可能带来软件上的架构缺陷或性能风险;工程结构混乱导致后续维护艰难;没有鉴权的漏洞代码易被黑客攻击等等。
所以本手册以 Java 开发者为中心视角,划分为编程规约、异常日志、MySQL 数据库、工程结构、安全规约五大块,再根据内容特征,细分成若干二级子目录。根据约束力强弱及故障敏感性,规约依次分为强制、推荐、参考三大类。对于规约条目的延伸信息中,“说明”对内容做了引申和解释;“正例”提倡什么样的编码和实现方式;“反例”说明需要提防的雷区,以及真实的错误案例。
Google Java 编程风格指南
Google 出品的《Google Java Code Style》,由 fantasticmao 翻译,对应 github 仓库。
Twitter Java Style Guide
本文是 Twitter 的 Java 代码规范,从格式化、文档、注解、接口使用、可测试代码到最佳实践,附大量正反例代码。