當今的軟件開發(fā)需要使用許多不同的工具和技術(shù)來確保代碼質(zhì)量和穩(wěn)定性。PMD是一個流行的靜態(tài)代碼分析工具，可以幫助開發(fā)者在編譯代碼之前發(fā)現(xiàn)潛在的問題。在本文中，我們將討論如何在Gradle中使用PMD，并介紹一些最佳實踐。

什么是PMD？

PMD是一個用于Java代碼的靜態(tài)代碼分析工具。它可以幫助開發(fā)者找出潛在的問題，如代碼重復、未使用的變量、錯誤的異常處理等。PMD支持多種規(guī)則，可以根據(jù)具體項目的需要進行配置。其工作原理參考How PMD Works。

PMD支持通過命令行界面（CLI, Command Line Interface for batch scripting）和其他多種集成方式，比如Maven、Gradle、Java API等等。

PMD在Gradle中配置和使用

Gradle中自帶了PMD插件，插件的默認版本可以通過源碼DEFAULT_PMD_VERSION知道。使用和配置可以參考The PMD Plugin，頁面左上角可以選擇Gradle版本，確保查看的版本和你使用的Gradle版本一致，因為很多PMD的配置屬性或者功能不一定在每個版本都有。

通過頁面左上角選了其他版本后跳轉(zhuǎn)的地址是Gradle文檔的首頁，而不是PMD插件的文檔頁。我們可以通過修改The PMD Plugin鏈接中的8.0.2為其他版本號即可跳轉(zhuǎn)到對應(yīng)Gradle版本包含的PMD插件文檔的頁面。比如：

當前最新版：https://docs.gradle.org/current/userguide/pmd_plugin.html

7.3.3版本：https://docs.gradle.org/7.3.3/userguide/pmd_plugin.html

在項目build.gradle文件中增加以下內(nèi)容應(yīng)用插件和擴展PMD，參考Usage和Configuration，更多的配置屬性可以參考PmdExtension。

plugins {
    id 'pmd'
}

pmd {
    // 是否將 PMD 結(jié)果輸出到終端
    consoleOutput = true
    // 要使用的PMD版本
    toolVersion = "6.21.0"
    // 規(guī)則優(yōu)先級閾值，低于這個優(yōu)先級則會被忽略
    rulesMinimumPriority = 5
    // 使用的規(guī)則集配置文件路徑
    ruleSets = ["category/java/errorprone.xml", "category/java/bestpractices.xml"]
}

插件會生成兩個主要的PMD TaskpmdMain和pmdTest分別對main和test兩個項目源文件目錄使用PMD進行代碼檢查。

找到IDEA Gradle窗口 > Tasks > other，雙擊生成的Task；或者在項目根目錄運行./gradlew pmdMain都可以運行PMD。檢查結(jié)果將輸出到終端中（前提是配置了consoleOutput = true），違反了PMD規(guī)則的類會給出完整的跳轉(zhuǎn)路徑以及規(guī)則提示信息。

最后還會給出一個報告的地址，內(nèi)容包含了輸出到終端的信息。Problem列出了規(guī)則的提示，點擊可以跳轉(zhuǎn)到PMD規(guī)則描述文檔對應(yīng)的位置。

Gradle PMD Plugin擴展屬性

在這里我們將PMD插件的擴展屬性作用進行說明，參考PmdExtension，這個文檔詳細說明了各個屬性的作用、默認值和配置示例。如果文檔描述的不是很清楚也可以參考PMD CLI options的對應(yīng)描述。

consoleOutput

是否將結(jié)果輸出到終端（System.out）允許值為true|false。

ignoreFailures

如果出現(xiàn)了警告，是否允許繼續(xù)構(gòu)建，允許值為true|false。

配置為否（false），在執(zhí)行build的時候（build任務(wù)中默認包含了pmdMain和pmdTest），如果發(fā)現(xiàn)了代碼有違反規(guī)則，將會中斷構(gòu)建過程；配置為是（true），將不會中斷構(gòu)建，只是輸出報告信息。

maxFailures

停止構(gòu)建前允許的最大失敗次數(shù)。

incrementalAnalysis

是否開啟增量分析，允許值為true|false。在pmd docs Incremental Analysis中詳細描述了增量分析的相關(guān)信息。簡單來說，開啟了增量分析，PMD會緩存分析數(shù)據(jù)和結(jié)果，后續(xù)分析僅查看那些新的/已更改的文件，以此顯著減少分析的時間，在Gradle中，這個功能使用PMD6.0.0及以上版本才有。

但是有一些情況會導致增量分析的緩存失效：使用PMD的版本發(fā)生了變化；使用的規(guī)則集已更改；被分析的代碼的類路徑已更改；被分析代碼依賴的庫的類路徑已更改。具體參考When is the cache invalidated?

在以上前提下，即使切換分支緩存也是有效的，甚至還支持在不同的機器重復使用緩存文件。參考Can I reuse a cache created on branch A for analyzing my project on branch B? 和Can I reuse a cache file across different machines?

reportsDir

報告生成的路徑。

ruleSetFiles

要使用的自定義規(guī)則集文件路徑，可以在files()中填多個路徑。

ruleSetFiles = files("config/pmd/myRuleSet.xml")

ruleSetConfig

跟ruleSetFiles的作用一樣，不過只能填一個文件路徑。

ruleSetConfig = resources.text.fromFile("config/pmd/myRuleSet.xml")

ruleSets

指定使用的規(guī)則集，默認值為["category/java/errorprone.xml"]。建議如果配置了ruleSetFiles或者ruleSetConfig，就將ruleSets配置為空（ruleSets = []），以免互相干擾，官方文檔Custom ruleset給出的例子也是如此。

ruleSets = ["category/java/errorprone.xml", "category/java/bestpractices.xml"]

rulesMinimumPriority

每個規(guī)則都有個優(yōu)先級，是從 1 到 5 的整數(shù)，其中 1 是最高優(yōu)先級，參考[Message and priority overriding，每個規(guī)則的優(yōu)先級參考Java Rules。rulesMinimumPriority的作用是配置報告的最低優(yōu)先級，低于這個優(yōu)先級的規(guī)則將被忽略。比如配置rulesMinimumPriority = 4，優(yōu)先級為 5 的規(guī)則將被忽略。

sourceSets

作為 check 和 build 任務(wù)的一部分進行分析的源代碼集合，配置方式參考SourceSet。

targetJdk

PMD使用的JDK版本。有些規(guī)則可能會要求JDK的最低或者最高版本，具體要求參考Java Rules。

threads

PMD 運行時使用的線程數(shù)。

toolVersion

要使用的PMD的版本。

為項目自定義合適的規(guī)則集

規(guī)則分類和查找

PMD能檢測的語音有很多種（后面內(nèi)容以Java為例），針對不同的語音，PMD內(nèi)置了很多檢測規(guī)則，并歸為了以下幾個類別：

1. 最佳實踐（Best Practices）：這些規(guī)則執(zhí)行普遍接受的最佳實踐。
2. 代碼風格（Code Style）：這些規(guī)則強制執(zhí)行特定的編碼風格。
3. 設(shè)計（Design）：幫助您發(fā)現(xiàn)設(shè)計問題的規(guī)則。
4. 文檔（Documentation）：這些規(guī)則與代碼文檔有關(guān)。
5. 容易出錯（Error Prone）：用于檢測損壞、極度混亂或容易出現(xiàn)運行時錯誤的構(gòu)造的規(guī)則。
6. 多線程（Multithreading）：這些是在處理多個執(zhí)行線程時標記問題的規(guī)則。
7. 性能（Performance）：標記次優(yōu)代碼的規(guī)則。
8. 安全性（Security）：標記潛在安全漏洞的規(guī)則。

在Java Rules列出了所有相關(guān)的規(guī)則，點擊藍色字符可以跳轉(zhuǎn)到規(guī)則的詳細描述頁面。

下圖是規(guī)則AbstractClassWithoutAbstractMethod文檔描述的信息，其他規(guī)則的描述可能還會包含JDK版本的要求，其他可配置屬性等等。

需要注意有的規(guī)則可能被標記為Deprecated代表被棄用了。

配置規(guī)則集

我們可以編輯XML格式的規(guī)則集文件，指定我們項目要執(zhí)行的規(guī)則，參考Making rulesets。下面是沒有包含任何規(guī)則的規(guī)則集文件的模版。

<?xml version="1.0"?>

<ruleset name="Custom Rules"
    xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">

    <description>
        My custom rules
    </description>


    <!-- Your rules will come here -->

</ruleset>

從上文我們可以知道PMD內(nèi)置的每個規(guī)則都會提供引用實例，我們引用單個規(guī)則的時候，只需要將示例的XML代碼復制到規(guī)則集文件中即可。

<rule ref="category/java/errorprone.xml/EmptyCatchBlock" />

從ref中填寫的路徑category/java/bestpractices.xml/AbstractClassWithoutAbstractMethod我們可以明顯看到它是按照內(nèi)置規(guī)則集文件路徑/規(guī)則名稱的格式組織的，一個內(nèi)置規(guī)則集文件對應(yīng)了一個分類。

我們可以引用內(nèi)置規(guī)則集文件實現(xiàn)批量引入分類下的所有規(guī)則，每個分類對應(yīng)的XML文件名可以參考GitHub pmd-java resources。再通過exclude指定規(guī)則的名稱來排除某些規(guī)則。

<rule ref="category/java/codestyle.xml">
    <exclude name="WhileLoopsMustUseBraces"/>
    <exclude name="IfElseStmtsMustUseBraces"/>
</rule>

我們可以使用exclude-pattern排除某些文件，使其不被PMD檢查，也可以使用include-pattern包含的方式。如果兩種方式都包含相同的文件，最終這個文件會被PMD檢查。

<?xml version="1.0"?>
<ruleset name="myruleset"
		xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
		xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
		xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
    <description>My ruleset</description>

    <exclude-pattern>.*/some/package/.*</exclude-pattern>
    <exclude-pattern>.*/some/other/package/FunkyClassNamePrefix.*</exclude-pattern>
    <include-pattern>.*/some/package/ButNotThisClass.*</include-pattern>

    <!-- Rules here ... -->

</ruleset>

規(guī)則集文件編輯好后，使用ruleSetFiles或者ruleSetConfig配置路徑。比如下面配置的意思是指向了項目根目錄下的/code-analysis/pmd/rulesets/custom-rule.xml。

ruleSetFiles = files("${project.rootDir}/code-analysis/pmd/rulesets/custom-rule.xml"

配置規(guī)則

規(guī)則引用的同時，我們可以覆蓋其原有的一些配置，比如提示消息message和優(yōu)先級priority。

<rule ref="category/java/errorprone.xml/EmptyCatchBlock"
      message="Empty catch blocks should be avoided" >
      <priority>5</priority>
</rule>

某些規(guī)則可能有特定的屬性，我們也可以將其覆蓋。這些特定的屬性Java Rules中都有提供，比如下面這個例子參考NPathComplexity。

<rule ref="category/java/design.xml/NPathComplexity">
    <properties>
        <property name="reportLevel" value="150"/>
    </properties>
</rule>

有些屬性可以提供多個值，這種情況下可以通過分隔符來提供，比如豎線（|）或逗號（,）。

<property name="legalCollectionTypes"
          value="java.util.ArrayList|java.util.Vector|java.util.HashMap"/>

抑制警告

有時候PMD可能會產(chǎn)生誤報，這種時候我們可以通過抑制警告讓PMD跳過對這些代碼的檢查。

從Java 1.5開始可以使用注解@SuppressWarnings來標記類或者方法。

• @SuppressWarnings('PMD')抑制所有PMD的警告。
• @SuppressWarnings("PMD.UnusedLocalVariable")抑制規(guī)則UnusedLocalVariable的警告。
• @SuppressWarnings({"PMD.UnusedLocalVariable", "PMD.UnusedPrivateMethod"})抑規(guī)則UnusedLocalVariable和UnusedPrivateMethod的警告。
• @SuppressWarnings("unused")JDK里面的unusedPMD也遵守，抑制所有跟未使用相關(guān)的警告。比如：UnusedLocalVariable和UnusedPrivateMethod。

在警告提示的代碼行的末尾加上注釋// NOPMD也可以抑制這一行引起的警告，參考NOPMD。

在規(guī)則集文件中也可以配置要抑制警告的文件，匹配的方式可以是正則表達式或者XPath，具體可以了解The property violationSuppressRegex和The property violationSuppressXPath。

第三方規(guī)則集

除了PMD內(nèi)置的規(guī)則集，我們還可以引入第三方規(guī)則集。在3rd party rulesets中列出了一些，還有阿里Java開發(fā)規(guī)范p3c也基于PMD開發(fā)一套規(guī)則集，從它的pom.xml可以了解到是基于PMD6.15.0版本。

參考Dependency management引入規(guī)則集依賴，在規(guī)則集配置中引入提供的規(guī)則即可。

dependencies {
		pmd "com.alibaba.p3c:p3c-pmd:2.1.1"
}

需要注意的是，第三方的規(guī)則集很可能沒有按照PMD內(nèi)置規(guī)則集那樣分類，它們提供的規(guī)則配置文件目錄也可能不一樣，比如p3c的規(guī)則配置文件都在/resources/rulesets/目錄下并獨自定義了一套分類。

其他技巧

PMD的最新官方文檔地址是：https://docs.pmd-code.org/latest/pmd_userdocs_tools.html。鏈接中的latest對應(yīng)了版本號，指向的是當前最新版本，如果想查看其他版本的文檔，修改為對應(yīng)的版號即可。比如6.39.0版本的鏈接為：https://docs.pmd-code.org/pmd-doc-6.39.0/index.html。不過可能只有比較新的一些版本才能看到對應(yīng)的文檔。

官方提供了一個PMD的最佳實踐可以了解下。

PMD還有跟特定語言相關(guān)的文檔，比如Java support，里面有支持的JDK版本等信息。

如果使用過程中遇到了問題，可以參考Getting Help從這些網(wǎng)站里面尋找?guī)椭鷊ithub discussions、github issues、stackoverflow tagged pmd。

PMD官方文檔還提供了Copy/Paste Detector (CPD)關(guān)信息，CPD可以用于檢測重復代碼。還提及了Duplicate Code教我們遇到重復代碼如何消除，以及一個關(guān)于設(shè)計模式的網(wǎng)站Design Patterns。

關(guān)于PMD這個名字，并沒有特殊的含義，作者純粹只是覺得這幾個字母放一起作為名稱挺好的，來自What does 'PMD' mean?

參考

GitHub - pmd

PMD - docs

Gradle - The PMD Plugin文章來源地址http://www.zghlxwxcb.cn/news/detail-408944.html

到了這里，關(guān)于PMD插件：你必須掌握的代碼質(zhì)量工具！的文章就介紹完了。如果您還想了解更多內(nèi)容，請在右上角搜索TOY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章，希望大家以后多多支持TOY模板網(wǎng)！