如何使用gradle-pmd-plugin将自定义java pmd规则添加到gradle项目？

Question

在处理arch4u-pmd项目期间，我们制定了几个基于java的pmd规则，在基于XML的规则集< code>our-rules.xml中配置它们，并将其作为普通的java库/工件(< code > io . github . ABC:my-PMD-rules:0 . 1 . 0 )发布到我们的工件存储库中。工件结构如下所示:

> unzip -l my-pmd-rules-0.1.0.jar   
Archive:  my-pmd-rules-0.1.0.jar   
  Length      Date    Time    Name
---------  ---------- -----   ----
        0  02-15-2022 00:24   META-INF/
      139  02-15-2022 00:24   META-INF/MANIFEST.MF
        0  02-15-2022 00:24   io/
        0  02-15-2022 00:24   io/github/
        0  02-15-2022 00:24   io/github/rules/
        ...
     4781  02-15-2022 00:24   io/github/rules/MissingMandatoryAnnotation.class
     ...
     1138  02-15-2022 00:24   io/github/rules/our-rules.xml
     ...

我们如何使用pmd插件将它们添加到Gradle项目中？

我们必须处理以下材料/问题/答案：

1. https://stackoverflow.com/search?page=2&tab=Relevance&q=pmd%20classpath
2. ClassNotFoundException: Using custom java rule for PMD ruleset
3. Gradle's PMD plugin: what are acceptable arguments?
4. Adding a ruleset to PMD?
5. Adding custom rules in PMD - class not found issue
6. https://discuss.gradle.org/t/pmd-ruleset-not-available-in-classpath/7201
7. https://discuss.gradle.org/t/custom-rules-with-pmd-plugin/5859/4
8. How to configure PMD Auxiliary classpath in Sonar
9. https://docs.gradle.org/current/userguide/pmd_plugin.html
10. https://github.com/gradle/gradle/blob/master/subprojects/code-quality/src/main/groovy/org/gradle/api/plugins/quality/PmdPlugin.java
11. Custom PMD rule with Gradle also don't work

    tasks.withType(Pmd) {
       pmdClasspath += file("path/to/rules.jar")
    }
    

Answer 1

在Gradle pmd插件的官方文档中，有一个依赖性部分，在没有实际示例的情况下从高层解释了这一方面：

1. pmd - 要使用的 PMD 库
2. pmdAux - 在分析期间可用于类型解析的附加库。如果 PMD 抱怨缺少类，这可能很有用。

为了将自定义java规则添加到项目中

>

使用Gradle插件

apply plugin: 'pmd'

repositories {
   mavenCentral() // if your rules in Maven Central
   mavenLocal()   // if your rules is in .m2 folder 
   maven {
      // if your rules are in some custom/self-hosted artifacts repository like Nexus
   }
}

dependencies {
   ...
   pmd "io.github.abc:my-pmd-rules:0.1.0" 
   pmd "commons-io:commons-io:2.11.0"     // required dependency by pmd engine
   ...
}

pmd {
   consoleOutput = true
   ruleSetFiles = files("io/github/rules/our-rules.xml")    // exactly path as in your lib classpath
   ruleSets = []                                            // Keep it as is, workaround for pmd
}

使用Maven插件

...
<build>
 <plugins>
   ...
   <plugin>
     <groupId>org.apache.maven.plugins</groupId>
     <artifactId>maven-pmd-plugin</artifactId>
     <version>3.15.0</version>
     <executions>
       <execution>
         <phase>test</phase>
         <goals>
           <goal>check</goal>
         </goals>
       </execution>
     </executions>
     <configuration>
       <printFailingErrors>true</printFailingErrors>
       <rulesets>
         ...
         <ruleset>io/github/rules/our-rules.xml</ruleset> <!-- exactly path as in your lib classpath -->
         ...
       </rulesets>
       <excludeRoots>
         <excludeRoot>target/generated-sources/</excludeRoot>
       </excludeRoots>
     </configuration>
     <dependencies>
       <!-- your custom rules -->
       <dependency>
         <groupId>io.github.abc</groupId>
         <artifactId>my-pmd-rules</artifactId>
         <version>0.1.0</version>
       </dependency>
     </dependencies>
   </plugin>
   ...
 </plugins>
</build>
 ...

如果您已经有一个规则集，并且只想包含自定义 Java 规则（来自库），则可以按原样直接在规则集 xml 中定义它：

  <!-- Define a rule -->
  <rule name="TheRuleName"
        language="java"
        externalInfoUrl="https://link.to.your.rule.official.docs.com"
        message="The violation message regarding your rule"
        class="io.github.rules.MissingMandatoryAnnotation">
    <priority>3</priority>
    <properties>
       ...
    </properties>
  </rule>