（4.2.41）优雅编码：在Android口袋助理中引入Alibaba之Java开发规约

代码规约对于团队协作来说非常重要，它约束团队成员遵循一个良好统一的编码习惯，不仅可以帮助规避一些语言层面潜在的bug提高产品的质量，同时也提高了后面代码审查和维护的效率…

一、背景

2017年2月Alibaba发布第一版《Java开发手册》，直至2017年9月25号正式发布《Java开发手册》终极版，该版本将是阿里官方对外释放的最后一个PDF版本，也是史上内容最全、修正最为彻底的一个版本。

期间经过诸多java、Android等开发人员的反馈和修正，《阿里巴巴Java开发手册》系统性地从编程、数据库、异常日志、工程结构、安全、单元测试六大方面，总结出优秀Java开发者必备的技术素养。

无疑，《阿里巴巴Java开发手册》是针对任何java从业者应该必读的一份指导文档，但是作为一份覆盖多方面的指导建议，在具体落实的时候却会遇到一些阻碍，因此一份真正的代码约束规范就显得尤其重要。

二、Alibaba-Java开发规约插件

2017年10月14日，阿里巴巴在杭州云栖大会上，正式发布了由阿里巴巴 P3C 项目组，经过 247 天的持续研发，正式发布众所期待的 《阿里巴巴 Java 开发规约》的扫描插件。

该插件主要是对今年发布的《阿里巴巴 Java 开发规约》的一个延伸，它以一个 IDE 的插件存在，可以自动对手册中的 Java 不规范的问题进行提示。现在主要支持（IDEA、Eclipse），Android Studio 是基于 IDEA 的，所以也是支持 Android 开发人员的

该插件在扫描代码后，会将不符合规约的代码按照 Blocker/Critical/Major 三个等级显示在下方，甚至在 IDEA 上，还可以基于 Inspection 机制提供了实时检测的功能，编写代码的同时也能快速发现不规范的代码。而对于历史代码，部分规则实现了批量一键修复的功能，为首次在成熟项目上，使用插件，做了非常友善的支持
现代软件架构都需要协同开发完成，高效协作即降低协同成本，提升沟通效率，所谓无规矩不成方圆，无规范不能协作.

对软件来说，适当的规范和标准绝不是消灭代码内容的创造性、优雅性，而是限制过度个性化，以一种普遍认可的统一方式一起做事，提升协作效率。代码的字里行间流淌的是软件生命中的血液，质量的提升是尽可能少踩坑，杜绝踩重复的坑，切实提升质量意识

而随着规约插件的部署，也就能够将代码约束规范落实到实处。

2.1 Android Studio 引入说明

1. 依次选择：Setting >> Plugins >> Browse repositories .

2. 搜索关键字『alibaba』，并在结果中，找到 Alibaba Java Coding Guidelines 并安装

1. 安装完成后重启Studio

2.2 使用说明

2.2.1 Inspections 支持

Alibaba-Java开发规约插件会自动在我们编码的阶段，进行快速灵活的静态代码分析，自动检测编译器和运行时错误，并提示开发人员再编译之前就进行有效的改正和改进

ps: 所有的规范，都可以再 Inspections 中查看到

2.2.2 代码静态分析

阿里规约插件，除了支持 Inspections 之外，还可以对现有项目进行静态代码分析. 它分析的结果，会以 Blocker/Critical/Major 三个级别进行区分。最终检测出来的效果也非常的直观，如果你是当前插件语言是中文，基本上一眼就看出来哪里有问题，并给出了修复建议

2.2.3 VCS 支持

阿里规约插件支持在git\svn提交代码前，对本次提交的代码进行规约检测

后言

文档虽有终极版，技术没有终点站，在开发的过程中不断打磨自己、积累自己，形成自我良好的编码习惯也多需注意