如何使用pmd检查代码规范

顺天gie

已于 2023-02-16 17:33:31 修改

阅读量737

点赞数

分类专栏：代码规范文章标签：代码规范 intellij-idea maven

于 2023-02-16 17:28:29 首次发布

本文链接：https://blog.youkuaiyun.com/win9413/article/details/129066051

版权

代码规范专栏收录该内容

1 篇文章

订阅专栏

文章介绍了如何在IDEA中集成PMD进行代码质量检查。推荐使用IDEA的ExternalTools方式进行配置，需要下载PMD的bin包并按照步骤设置。另外提到了通过MavenPMDPlugin的方式，但需要手动编写代码和添加依赖，相对较不推荐。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

https://pmd.sourceforge.io/pmd-6.32.0/pmd_userdocs_tools_maven.html

官网介绍了这几种方式，由于我是用的idea maven开发。所以只看了下面几种方式。

1、idea插件的方式，不推荐，不知道是不是打开姿势不对，在控制台输出的不知道是个啥

2、idea的External Tools方式，推荐。

pmd官网：https://pmd.sourceforge.io/pmd-6.32.0/pmd_userdocs_tools.html#idea

需要先下载pmd的bin压缩包，需要使用到里面的pmd.bat（可以官网下载，也可以csdn下载：链接）

然后按官网的操作步骤操作，如下图就添加成功了。在文件或者目录右键就能使用。

3、Maven PMD Plugin方式，比较不推荐。需要手动写代码，引入依赖。

pom.xml依赖

<dependencies>
    <dependency>
        <groupId>net.sourceforge.pmd</groupId>
        <artifactId>pmd-java</artifactId>
        <version>6.29.0</version>
    </dependency>

</dependencies>

写代码

package org.example;

import net.sourceforge.pmd.PMD;
import net.sourceforge.pmd.PMDConfiguration;

/**
 * @DESCRIPTION:
 * @USER: chen.shuntian
 * @DATE: 2023/2/13 11:09
 */
public class Pmd {

    public static void main(String[] args) {
        PMDConfiguration configuration = new PMDConfiguration();
        configuration.setInputPaths("F:\\cctv_dev\\vsap-midend\\SourceCode\\vsap-business\\vsap-business-asset\\src\\main\\java\\com\\iwhalecloud\\vsap\\business\\asset\\repository\\es");
        configuration.setRuleSets("F:\\cctv_dev\\pmd_test\\src\\main\\resources\\pmd4.0-ruleset-base.xml");
        configuration.setReportFormat("html");
        configuration.setReportFile("C:\\Users\\Administrator\\Desktop\\pmd-report.html");

        PMD.doPMD(configuration);
    }
}