提高代碼質量！詳解在Gradle項目中使用PMD的正確姿勢

来源:https://www.cnblogs.com/shuiyao3/archive/2023/04/09/17301108.html
-Advertisement-
Play Games

當今的軟體開發需要使用許多不同的工具和技術來確保代碼質量和穩定性。PMD是一個流行的靜態代碼分析工具，可以幫助開發者在編譯代碼之前發現潛在的問題。在本文中，我們將討論如何在Gradle中使用PMD，並介紹一些最佳實踐。 什麼是PMD？ PMD是一個用於Java代碼的靜態代碼分析工具。它可以幫助開發者 ...


當今的軟體開發需要使用許多不同的工具和技術來確保代碼質量和穩定性。PMD是一個流行的靜態代碼分析工具，可以幫助開發者在編譯代碼之前發現潛在的問題。在本文中，我們將討論如何在Gradle中使用PMD，並介紹一些最佳實踐。

什麼是PMD？

PMD是一個用於Java代碼的靜態代碼分析工具。它可以幫助開發者找出潛在的問題，如代碼重覆、未使用的變數、錯誤的異常處理等。PMD支持多種規則，可以根據具體項目的需要進行配置。其工作原理參考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的配置屬性或者功能不一定在每個版本都有。

image-20230409124759078

通過頁面左上角選了其他版本後跳轉的地址是Gradle文檔的首頁，而不是PMD插件的文檔頁。我們可以通過修改The PMD Plugin鏈接中的8.0.2為其他版本號即可跳轉到對應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文件中增加以下內容應用插件和擴展PMD，參考Usage和Configuration，更多的配置屬性可以參考PmdExtension。

plugins {
    id 'pmd'
}

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

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

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

image-20230409135016234

最後還會給出一個報告的地址，內容包含了輸出到終端的信息。Problem列出了規則的提示，點擊可以跳轉到PMD規則描述文檔對應的位置。

image-20230409135722137

Gradle PMD Plugin擴展屬性

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

consoleOutput

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

ignoreFailures

如果出現了警告，是否允許繼續構建，允許值為true|false。

配置為否（false），在執行build的時候（build任務中預設包含了pmdMain和pmdTest），如果發現了代碼有違反規則，將會中斷構建過程；配置為是（true），將不會中斷構建，只是輸出報告信息。

maxFailures

停止構建前允許的最大失敗次數。

incrementalAnalysis

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

但是有一些情況會導致增量分析的緩存失效：使用PMD的版本發生了變化；使用的規則集已更改；被分析的代碼的類路徑已更改；被分析代碼依賴的庫的類路徑已更改。具體參考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

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

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

ruleSetConfig

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

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

ruleSets

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

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

rulesMinimumPriority

每個規則都有個優先順序，是從 1 到 5 的整數，其中 1 是最高優先順序，參考[Message and priority overriding，每個規則的優先順序參考Java Rules。rulesMinimumPriority的作用是配置報告的最低優先順序，低於這個優先順序的規則將被忽略。比如配置rulesMinimumPriority = 4，優先順序為 5 的規則將被忽略。

sourceSets

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

targetJdk

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

threads

PMD 運行時使用的線程數。

toolVersion

要使用的PMD的版本。

為項目自定義合適的規則集

規則分類和查找

PMD能檢測的語音有很多種（後面內容以Java為例），針對不同的語音，PMD內置了很多檢測規則，並歸為了以下幾個類別：

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

在Java Rules列出了所有相關的規則，點擊藍色字元可以跳轉到規則的詳細描述頁面。

image-20230409200607724

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

image-20230409200833756

需要註意有的規則可能被標記為Deprecated代表被棄用了。

配置規則集

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

<?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內置的每個規則都會提供引用實例，我們引用單個規則的時候，只需要將示例的XML代碼複製到規則集文件中即可。

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

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

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

<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>

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

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

配置規則

規則引用的同時，我們可以覆蓋其原有的一些配置，比如提示消息message和優先順序priority。

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

某些規則可能有特定的屬性，我們也可以將其覆蓋。這些特定的屬性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可能會產生誤報，這種時候我們可以通過抑制警告讓PMD跳過對這些代碼的檢查。

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

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

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

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

第三方規則集

除了PMD內置的規則集，我們還可以引入第三方規則集。在3rd party rulesets中列出了一些，還有阿裡Java開發規範p3c也基於PMD開發一套規則集，從它的pom.xml可以瞭解到是基於PMD6.15.0版本。

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

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

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

其他技巧

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

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

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

如果使用過程中遇到了問題，可以參考Getting Help從這些網站裡面尋找幫助github discussions、github issues、stackoverflow tagged pmd。

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

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

參考

GitHub - pmd

PMD - docs

Gradle - The PMD Plugin


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • Vue——patch.ts【十四】
    前言 前面我們簡單的瞭解了 vue 初始化時的一些大概的流程，這裡我們擴展下 Vue 的 patch。 內容 這一塊主要圍繞 vue 中的__patch__進行剖析。 __patch__ Vue.prototype.__patch__的方法位於scr/platforms/web/runtime/in ...
  • 【manim動畫教程】-- 坐標系
    沒有引入坐標系之前，在繪製圖形時，也有一個隱含的坐標系，它和屏幕的像素相關。 比如，我們之前示例中的各個圖形，屏幕的中心就是坐標原點（[0, 0]）, 橫軸坐標的範圍大概是 [-3.5, 3.5]，縱軸的坐標範圍大概是 [-4, 4]，這個範圍與設置的視頻解析度有關，解析度設置的越高的話，坐標範圍越 ...
  • odoo 開發入門教程系列-添加修飾
    添加修飾 我們的房地產模塊現在從商業角度來看是有意義的。我們創建了特定的視圖，添加了幾個操作按鈕和約束。然而，我們的用戶界面仍然有點粗糙。我們希望為列表視圖添加一些顏色，並使一些欄位和按鈕有條件地消失。例如，當房產已出售或取消時，“已售出”和“取消”按鈕應消失，因為此時不再允許更改狀態。 參考: 文 ...
  • Rust編程語言入門之cargo、crates.io
    cargo、crates.io 本章內容 通過 release profile 來自定義構建 在https://crates.io/上發佈庫 通過 workspaces 組織大工程 從 https://crates.io/來安裝庫 使用自定義命令擴展 cargo 一、通過 release profi ...
  • SpringMVC中使用引入jquery不能載入頁面
    今天在學習springMVC的json數據綁定時，需要使用到jquery發送ajax請求。但是當我通過是<script>標簽引入了jquery.js。 但是當我訪問該jsp的時候就是不顯示頁面的內容 我一直以為時SpringMVC的servelt攔截器攔截了靜態資源，但是我過濾了靜態資源還是不顯示。 ...
  • Java 異常處理：使用和思考
    概念 異常處理的概念起源於早期的編程語言，如 LISP、PL/I 和 CLU。這些編程語言首次引入了異常處理機制，以便在程式執行過程中檢測和處理錯誤情況。異常處理機制隨後在 Ada、Modula-3、C++、Python、Java 等編程語言中得到了廣泛採用和發展。在 Java 中，異常處理是提供一 ...
  • 機械硬碟與固態硬碟的適用場景
    之前一直以為固態硬碟各方面都比機械硬碟性能高，所以首選固態硬碟，直到看了極客時間-深入淺出電腦組成原理中硬碟相關章節的內容，才發現固態硬碟原來是有缺點的，所以這裡來做一個總結。 機械硬碟（HDD） 機械硬碟由以下幾個部分組成： 盤面：盤面（碟片）上有一層磁性塗層，數據就是存儲在這個磁性的塗層上，一 ...
  • 一天吃透電腦網路八股文
    網路分層結構 電腦網路體系大致分為三種，OSI七層模型、TCP/IP四層模型和五層模型。一般面試的時候考察比較多的是五層模型。最全面的Java面試網站 五層模型：應用層、傳輸層、網路層、數據鏈路層、物理層。 應用層：為應用程式提供交互服務。在互聯網中的應用層協議很多，如功能變數名稱系統DNS、HTTP協議 ...
一周排行
    -Advertisement-
    Play Games
  • C# + WPF 音頻播放器 界面優雅，體驗良好
    前言 本文介紹一款使用 C# 與 WPF 開發的音頻播放器，其界面簡潔大方，操作體驗流暢。該播放器支持多種音頻格式（如 MP4、WMA、OGG、FLAC 等），並具備標記、實時歌詞顯示等功能。 另外，還支持換膚及多語言（中英文）切換。核心音頻處理採用 FFmpeg 組件，獲得了廣泛認可，目前 Git ...
  • OAuth2.0授權-gitee授權碼模式
    OAuth2.0授權驗證-gitee授權碼模式 本文主要介紹如何筆者自己是如何使用gitee提供的OAuth2.0協議完成授權驗證並登錄到自己的系統，完整模式如圖 1、創建應用 打開gitee個人中心->第三方應用->創建應用 創建應用後在我的應用界面，查看已創建應用的Client ID和Clien ...
  • FastReport.OpenSource .Net下開源免費報表列印組件
    解決了這個問題：《winForm下，fastReport.net 從.net framework 升級到.net5遇到的錯誤“Operation is not supported on this platform.”》 本文內容轉載自：https://www.fcnsoft.com/Home/Sho ...
  • 如何在 ASP.NET Core Web API 方法執行前後 “偷偷“ 作一些 “壞“ 事？初識 ActionFilterAttribute
    國內文章 WPF 從裸 Win 32 的 WM_Pointer 消息獲取觸摸點繪製筆跡 https://www.cnblogs.com/lindexi/p/18390983 本文將告訴大家如何在 WPF 裡面，接收裸 Win 32 的 WM_Pointer 消息，從消息裡面獲取觸摸點信息，使用觸摸點 ...
  • 在 ASP.NET Core Web API 中使用異常篩選器捕獲和統一處理異常
    前言 給大家推薦一個專為新零售快消行業打造了一套高效的進銷存管理系統。 系統不僅具備強大的庫存管理功能，還集成了高性能的輕量級 POS 解決方案，確保頁面載入速度極快，提供良好的用戶體驗。 項目介紹 Dorisoy.POS 是一款基於 .NET 7 和 Angular 4 開發的新零售快消進銷存管理 ...
  • AbpHelper CLI積累與實戰分享
    ABP CLI常用的代碼分享 一、確保環境配置正確 安裝.NET CLI： ABP CLI是基於.NET Core或.NET 5/6/7等更高版本構建的，因此首先需要在你的開發環境中安裝.NET CLI。這可以通過訪問Microsoft官網下載並安裝相應版本的.NET SDK來實現。 安裝ABP ...
  • 記一次HttpClient使用問題分析
    問題 問題是這樣的：第三方的webapi，需要先調用登陸介面獲取Cookie，訪問其它介面時攜帶Cookie信息。 但使用HttpClient類調用登陸介面，返回的Headers中沒有找到Cookie信息。 分析 首先，使用Postman測試該登陸介面，正常返回Cookie信息，說明是HttpCli ...
  • .NET周刊【9月第3期 2024-09-15】
    國內文章 關於.NET在中國為什麼工資低的分析 https://www.cnblogs.com/thinkingmore/p/18406244 .NET在中國開發者的薪資偏低，主要因市場需求、技術棧選擇和企業文化等因素所致。歷史上，.NET曾因微軟的閉源策略發展受限，儘管後來推出了跨平臺的.NET ...
  • 我的網站集成ElasticSearch初體驗
    在WPF開發應用中，動畫不僅可以引起用戶的註意與興趣，而且還使軟體更加便於使用。前面幾篇文章講解了畫筆（Brush），形狀（Shape），幾何圖形（Geometry），變換（Transform）等相關內容，今天繼續講解動畫相關內容和知識點，僅供學習分享使用，如有不足之處，還請指正。 ...
  • 第23篇 委托的概述
    什麼是委托？ 委托可以說是把一個方法代入另一個方法執行，相當於指向函數的指針；事件就相當於保存委托的數組； 1.實例化委托的方式： 方式1：通過new創建實例： public delegate void ShowDelegate(); 或者 public delegate string ShowDe ...
所有分類