如何通过静态代码分析禁止Java代码使用java.nio.file.*并集成Maven构建

针对你的需求——在保留Java 7/8特性的前提下，通过静态代码分析阻止java.nio.file.*类的使用，并集成到Maven构建流程中（PR引入违规代码即失败），以下是几个成熟的工具和具体配置方案：

一、Checkstyle（推荐，配置简单易维护） #

Checkstyle是Java生态中常用的代码规范检查工具，完全支持Java 7/8，且能轻松集成到Maven中，通过自定义规则禁止java.nio.file.*的使用。

1. 编写Checkstyle规则文件 #

在你的通用Java库根目录下创建checkstyle.xml文件，添加以下规则：

<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
        "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
        "https://checkstyle.org/dtds/configuration_1_3.dtd">
<module name="Checker">
    <module name="TreeWalker">
        <!-- 禁止导入java.nio.file包下的所有类 -->
        <module name="ForbiddenImport">
            <property name="forbiddenImports" value="java.nio.file.*"/>
        </module>
        <!-- 禁止直接使用全限定名引用该包下的类（避免绕过import的情况） -->
        <module name="RegexpSingleline">
            <property name="format" value="java\.nio\.file\.[A-Za-z0-9_]+"/>
            <property name="message" value="禁止使用java.nio.file包下的类，以兼容Android API 21"/>
        </module>
    </module>
</module>

2. 集成到Maven构建 #

在通用Java库的pom.xml中添加maven-checkstyle-plugin配置，绑定到verify阶段（构建验证时执行检查，失败则终止构建）：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-checkstyle-plugin</artifactId>
            <version>3.3.0</version>
            <executions>
                <execution>
                    <id>enforce-nio-file-ban</id>
                    <phase>verify</phase>
                    <goals>
                        <goal>check</goal>
                    </goals>
                </execution>
            </executions>
            <configuration>
                <configLocation>checkstyle.xml</configLocation>
                <failOnError>true</failOnError> <!-- 发现违规直接构建失败 -->
                <encoding>UTF-8</encoding>
            </configuration>
        </plugin>
    </plugins>
</build>

二、PMD（功能丰富，支持更多代码质量检查） #

PMD也是一款强大的静态代码分析工具，除了禁止特定类/包，还能检测其他代码问题，同样适配Java 7/8。

1. 编写PMD规则文件 #

创建pmd-rules.xml文件，添加禁止java.nio.file.*的规则：

<?xml version="1.0"?>
<ruleset name="Custom NIO File Ban Rules" xmlns="http://pmd.sourceforge.net/ruleset/2.0.0">
    <rule name="ForbiddenJavaNioFileClasses"
          message="禁止使用java.nio.file包下的类，以兼容Android API 21"
          class="net.sourceforge.pmd.lang.java.rule.basic.ForbiddenClassRule">
        <description>阻止所有java.nio.file包中的类被使用</description>
        <properties>
            <property name="forbiddenClasses" value="java.nio.file.*"/>
        </properties>
    </rule>
</ruleset>

2. 集成到Maven构建 #

在pom.xml中配置maven-pmd-plugin：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-pmd-plugin</artifactId>
            <version>3.21.0</version>
            <executions>
                <execution>
                    <id>pmd-check</id>
                    <phase>verify</phase>
                    <goals>
                        <goal>pmd</goal>
                    </goals>
                </execution>
            </executions>
            <configuration>
                <rulesets>
                    <ruleset>pmd-rules.xml</ruleset>
                </rulesets>
                <failOnViolation>true</failOnViolation> <!-- 违规则构建失败 -->
            </configuration>
        </plugin>
    </plugins>
</build>

三、方案适配性说明 #

• Java版本兼容：以上工具均支持Java 7/8源码级别，无需降低你的源码版本，完全满足保留Java 7/8特性的需求。
• 子模块场景：将规则配置在通用Java库自身的pom.xml中，无论该库是单独构建，还是作为Git子模块被Android库导入构建，都会执行检查，确保违规代码无法流入。
• PR防护：由于检查绑定到Maven的verify阶段，只要PR中引入了java.nio.file.*的使用，构建就会直接失败，从CI层面阻止违规代码合并。

内容的提问来源于stack exchange，提问作者Kaloyan Raev