如何使用Java编译器插件自定义静态代码规范检查规则-java教程-PHP中文网

java编译器（如javac）本身不支持插件式静态检查扩展，真正用于自定义静态代码规范检查的是独立工具：checkstyle（xml配置风格规则）、pmd（xpath或java代码编写语义规则）、sonarjava（开发java插件实现深度语义分析），三者均无需修改javac源码，基于公开扩展点稳定可维护。

如何使用java编译器插件自定义静态代码规范检查规则

Java编译器本身（如javac）并不直接支持插件式静态检查规则扩展。真正用于自定义静态代码规范检查的，是独立的静态分析工具，它们可集成进IDE或构建流程，但并非“Java编译器插件”。常见且实用的三类工具是：Checkstyle、PMD、SonarJava。它们各自提供明确的自定义机制，无需修改javac源码。

下面分工具说明如何落地自定义规则：

Checkstyle：定制XML配置实现风格与结构约束

适合命名规范、缩进、行宽、类/方法长度等格式和基础结构检查。

自定义方式：编辑checkstyle.xml配置文件，增删<module></module>节点
关键操作：

deep-java-review
Java项目代码review工具。分析Git变更+完整调用链路上下文，推断业务需求，进行多维度评分和分类汇总，生成完整PRD文档。包含细粒度Java代码审查清单（Null安全、异常处理、Streams、并发、equals/hashCode、资源管理、API设计、性能、MyBatis/ORM、事务边界、SQL/DD...

下载
- 复制官方配置（如google_checks.xml）作为基线
- 修改已有规则参数，例如：
```
<module name="LineLength"><property name="max" value="120"></property></module>
```
- 添加新规则，例如禁止public工具类构造器：
```
<module name="HideUtilityClassConstructor"></module>
```
- 禁用不适用规则，用<module name="..."></module>注释或删除即可
IDE中实时生效：在IntelliJ IDEA → Settings → Other Settings → CheckStyle 中指定该XML文件，并启用实时检查。

PMD：用XPath或Java代码编写语义级规则

适合检测逻辑问题、安全漏洞、设计缺陷等深层问题（如禁止System.exit()、强制DTO后缀）。

XPath规则（轻量、声明式）：

<rule name="NoSystemExit" language="java" message="禁止调用System.exit()"><priority>1</priority><properties><property name="xpath"><value></value></property></properties></rule>

Java规则（灵活、可编程）：继承AbstractJavaRule，重写visit(ASTMethodCall node, Object data)，做AST遍历与条件判断。
集成方式：将规则文件放入rulesets/目录，通过pmd.xml引用；Maven中配置pmd-maven-plugin指向自定义规则集。

SonarJava：开发Java插件注入自定义规则

适合需要深度语义理解、跨文件分析或与SonarQube平台联动的场景。

开发步骤：
- 创建Maven模块，依赖sonar-java-plugin SDK
- 编写JavaCheck子类，使用Tree API遍历语法树（如查找未加密的password字段赋值）
- 注册规则到JavaCheckRegistrar
- 打包为JAR，部署到SonarQube服务器或本地SonarLint
优势：支持数据流分析、污点追踪，能发现String password = request.getParameter("pwd")这类潜在风险