阿里发布的规约插件使用指南

01

—

前言

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

把《阿里巴巴 Java 开发规约》强制条目转化自动插件，并实现部分的自动编码。

该插件已经在 Github 上开源，有兴趣的可以直接去看看。

github.com/alibaba/p3c 或者在Github直接搜索p3c

02

—

功能介绍

该插件主要是对《阿里巴巴 Java 开发规约》的一个规约，它是一个 IDE 的插件，可以自动对手册中的 Java 不规范的问题进行提示。现在主要支持（IDEA、Eclipse）。

Android Studio 是基于 IDEA 的，所以也是支持 Android 开发人员的。

该插件在扫描代码后，会将不符合规约的代码按照 Blocker、Critical、Major 三个等级显示在下方，甚至在 IDEA 上。

还可以基于 Inspection 机制提供了实时检测的功能，编写代码的同时也能快速发现不规范的代码。而对于历史代码，部分规则实现了批量一键修复的功能。

03

—

安装

在Android Studio中，和普通插件一样：

File->Setting->Plugins，搜索alibaba，找到Alibaba Java Coding Guidelines ，第一条就是，如图：

安装：

重启 就可以了！

04

—

使用介绍

1、语言切换

因为该插件是阿里团队开发，那当然是支持中文的啦。同时也支持英文。

你可以在Tools->Alibaba Coding Guidelines->Switch language to XXX 进行切换

切换之后，需要重启才能生效。

2、实时监测

Inspections 大家应该都不陌生，会自动在编码阶段，进行快速灵活的静态代码分析，自动检测编译器和运行时错误，并提示开发人员。

所有的规范，可以在Setting->Inspections中看到：

举个例子：

可以看到，这里提示ZQWebViewActivity类没有严格按照大驼峰命名法进行命名，也没用注明作者。

可以点击more查看完整提示：

3、静态分析代码

该插件除了支持实时监测，也可以静态全局分析代码：

通过Tools->阿里编码规约->编码规约扫描，进行代码扫描，监测代码规范。当然也可以使用快捷键：Ctrl+Alt+Shift+J 。

执行完成后，会按照Blocker、Critical、Major（极严重、严重、警告）三个等级来显示不规范的地方：

因为当前插件是中文版，所以对于我们来说非常友好！

4、VCS前监测

我们在团队开发时一定会用到版本控制，无非两种：Git和SVN。而此规约插件是同时支持两种版本控制工具的：

在代码提交界面，勾选Alibaba Code Guidelines，点击Commit，会如图弹框提示，开发者可继续提交，或者取消去修改代码。