阿里的Java开发规范插件验证

Posted 2021-09-05 bisal

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了阿里的Java开发规范插件验证相关的知识，希望对你有一定的参考价值。

阿里最近有点“烦”，但是作为技术人，更多关注的还是技术层面，其他的就交给有关机构和时间来证明。

最近有项工作借鉴了阿里的Java开发规范，为了能让其落地，需要验证方案，而这个Java开发规范提供了对应的验证插件，因此从使用层面，了解一下。

目前该插件实现了开发手册中的的53条规则，大部分基于PMD实现，其中有4条规则基于IDEA实现，并且基于Inspection实现了实时检测功能，部分规则实现了Quick Fix功能。

目前插件检测有两种检测模式：实时检测、手动触发。

其中，实时检测功能会在开发过程中对当前文件进行检测，并以高亮的形式提示出来，同时也可以支持Quick Fix，该功能默认开启，可以通过配置关闭。

检测结果高亮提示，并且鼠标放上去会弹出提示信息。
Alt+Enter键可呼出Intention菜单，不同的规则会提示不同信息的Quick Fix按钮。
如果我们不希望对代码提示违规信息，可以通过Inspection的设置关闭实时检测功能。
- 通过菜单【关闭/打开实时检测功能】关闭/打开所有规则的实时检测功能。
- 通过File -> Settings -> Editor -> Inspections -> Ali-Check对每一个规则进行自由设置，比如可以关闭某条规则的实时检测功能或者修改提示级别。

阿里的Java开发规范设置了三个等级，

Blocker(崩溃)：阻碍开发或测试工作的问题。
Critical(严重)：系统主要功能部分丧失、数据库保存调用错误、用户数据丢失。
Major(一般)：功能没有完全实现但是不影响使用，功能菜单存在缺陷但不会影响系统稳定性。

目前的p3c插件支持IDEA、Eclipse。

P.S. https://github.com/alibaba/p3c/tree/master

IDEA的要求，

Project JDK: 1.7+
Gradle: 3.0+(Require JDK1.8+ for gradle)

Eclipse的要求，

Eclipse Juno+
maven3.+
JDK 1.7+

1. IDEA的安装，

IDEA中，选择Settings-Plugins，搜索Alibaba Java Coding Guidelines，

安装完成，在项目目录上右键点击会出现这两个功能按钮，

点击绿色的按钮即可开始扫描代码，或者在工程目录上右键也会出现检测的功能按钮。如果不想全部扫描，只扫描当前编辑的文件的话，在当前文件面板中点击右键会出现此功能按钮，

前面说的两种方式是手动检测，插件也提供了实时监测的功能，参考蓝色按钮，此功能默认开启，一旦开启则会在你编写代码时就会实时监测，一旦有不符合规范的语句就会出现错误提示。

例如如下代码，

package com.test;


/**
 * Hello world!
 *
 */
public class App {
    public static void main( String[] args ) {
        System.out.println( "Hello World!" );
        String test = "tset";
        if (test.equalsIgnoreCase("test")) {
            System.out.println("test");
        }
    }
}

扫描代码后，不符合规约的代码会按Blocker/Critical/Major三个等级显示在下方面板中，