【工利其器】必會工具之（八）PMD篇——代碼分析工具基本使用

       轉載請申明，轉載自【https://www.cnblogs.com/andy-songwei/p/11830812.html】，謝謝！

       如今，使用代碼分析工具來代替人工進行代碼審查，已經是大勢所趨了。用於Java代碼檢測的工具中，不乏許許多多的佼佼者，其中PMD就是其中一款。PMD既可以獨立運行，也可以以命令行的形式運行，還可以作為插件在IDE中運行，本文將基於在Android Studio中的使用來介紹PMD的基本使用。

 

一、PMD簡介

       對於PMD名稱含義，有個有趣的現象，PMD不存在一個准確的名稱，在官網上你可以發現很有有趣的名稱 ，比如：Pretty Much Done，Project Meets Deadline等。PMD是一款程序代碼檢查工具（可以支持多種語言，以Java為例），通過靜態分析Java源文件來獲知代碼錯誤，也就是說在不運行不編譯Java程序的情況下直接掃描Java源文件，報告錯誤 。該軟件功能強大，掃描效率高，是Java程序員debug的好幫手。它附帶了許多可以直接使用的規則，利用這些規則可以找出Java源程序的許多問題，比如：

• 可能的 Bugs：檢查潛在代碼錯誤，如空 try/catch/finally/switch 語句
• 未使用代碼（Dead code）：檢查未使用的變量，參數，方法
• 復雜的表達式：檢查不必要的 if 語句，可被 while 替代的 for 循環
• 重復的代碼：檢查重復的代碼
• 循環體創建新對象：檢查在循環體內實例化新對象
• 資源關閉：檢查 Connect，Result，Statement 等資源使用之后是否被關閉掉

       用戶還可以自己定義規則，檢查Java代碼是否符合某些特定的編碼規范。例如，你可以編寫一個規則，要求PMD找出所有創建Thread對象的操作。

       PMD支持的編輯器包括：JDeveloper、Eclipse、JEdit、JBuilder、BlueJ、CodeGuide、NetBeans/Sun Java Studio Enterprise/Creator、IntelliJ IDEA（Android Studio是基於此編輯器）、TextPad、Maven、Ant、Gel、JCreator和Emacs。

 

二、PMD的安裝 

       通過File > Settings > Plugins > Browse repositories 搜索 “PMD”，找到“PMDPlugin”這一項，按照提示進行安裝，然后重啟即可。

 

三、使用PMD檢測代碼

  1、啟動PMD檢測功能

    （1）從Tools菜單中啟動

       通過Tools > Run PMD可以看到如下的界面。從運行結果來看，如果通過該方式啟動，掃描的范圍就是整個個項目中的文件了。

        Pre Defined：表示預定義的規則，也就是該插件自帶的檢測規則。后面展開的列表中列處了所有的規則列表，想掃描哪一種類型的問題，點擊即可。其中“All”表示使用所有的規則。

        Custom Rules：自定的檢測規則。該插件允許用戶根據自己的需要自定義檢查規則，默認這里是不可點擊的，需要在設置中導入自定義規則文件后方可選擇。

    （2）從右鍵菜單中啟動

       在文件或者編輯器中點擊右鍵，也可以看到“Run PMD”選項，和從“Tools”菜單中啟動一樣，這里不贅述了。通過該方式啟動， 檢測范圍取決於鼠標或光標當前所選中的區域。

  2、運行結果

       運行后會出現如下面板：

   

       左邊工具欄，鼠標停留在上面會提示其功能，比較簡單就不啰嗦了。右邊顯示了檢測結果，這里顯示的結果類別取決於我們運行的時候在“Pre Defined”中選擇的規則類型，因為前面選擇的“All”，所以所有的規則都顯示了。當點擊具體某一問題項時，會跳轉到對應的源碼中。

 

四、配置檢測規則

       通過File > Settings > Other Settings > PMD可以打開檢測規則的設置界面：

        在“RuleSets（規則設置）”界面可以管理自定義的檢測規則。因為在實際工作中，可能有些團隊需要根據實際情況自定義檢測規則，就可以通過這里導入。如果要使用它，需要在啟動PMD進行檢測時選擇該自定義規則。

       點擊“Options”選項卡，在其中可以配置一些檢測規則選項

其中重點需要留意的是“Skip TestSource”這一項，因為在項目中有不少Android Studio自動生成的測試代碼，如下所示，選擇上述選項后可以將其過濾掉。

 

五、PMD的高級使用

       本文主要介紹PMD的基本使用，同時限於筆者的水平有限，這里僅簡單介紹一下它的高級使用。

       PMD功能非常強大，僅僅是針對Java的檢測就附帶了讓人眾多的規則，這里提供一份《PMD插件分析代碼規則（中文）.xls》文檔，有興趣的可以下載深入了解：

       鏈接：https://pan.baidu.com/s/189OTD_k-RbEX4ABJbAMlIg

       提取碼：90f4

       對於自定義規則，這里提供一個自定義模板(pmd_custom_rule.xml，可以直接導入使用)，可以通過這個模板學習一下PMD的規則定義：

<?xml version="1.0"?>
<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="Android Application Rules"
    xmlns="http://pmd.sf.net/ruleset/1.0.0"
    xsi:noNamespaceSchemaLocation="http://pmd.sf.net/ruleset_xml_schema.xsd"
    xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0 http://pmd.sf.net/ruleset_xml_schema.xsd">
 
    <description>Custom ruleset for ribot Android application</description>
 
    <exclude-pattern>.*/R.java</exclude-pattern>
    <exclude-pattern>.*/gen/.*</exclude-pattern>
 
    <rule ref="rulesets/java/android.xml" />
    <rule ref="rulesets/java/clone.xml" />
    <rule ref="rulesets/java/finalizers.xml" />
    <rule ref="rulesets/java/imports.xml">
        <!-- Espresso is designed this way !-->
        <exclude name="TooManyStaticImports" />
    </rule>
    <rule ref="rulesets/java/logging-java.xml">
        <!-- This rule wasn't working properly and given errors in every var call info -->
        <exclude name="GuardLogStatementJavaUtil" />
    </rule>
    <rule ref="rulesets/java/braces.xml">
        <!-- We allow single line if's without braces -->
        <exclude name="IfStmtsMustUseBraces" />
    </rule>
    <rule ref="rulesets/java/strings.xml" >
        <!-- Exclude because causes problems with SQL Strings that usually require duplication -->
        <exclude name="AvoidDuplicateLiterals"/>
    </rule>
    <rule ref="rulesets/java/basic.xml" />
    <rule ref="rulesets/java/naming.xml">
        <exclude name="AbstractNaming" />
        <exclude name="LongVariable" />
        <exclude name="ShortMethodName" />
        <exclude name="ShortVariable" />
        <exclude name="ShortClassName" />
        <exclude name="VariableNamingConventions" />
    </rule>
</ruleset>

 

友情鏈接：

       PMD Java rules官方文檔介紹：https://pmd.github.io/pmd-6.19.0/pmd_rules_java.html

       PMD 官網：https://pmd.github.io