PMD【 Java 代码检查工具】入门使用教程（超详细）

最新推荐文章于 2025-01-31 19:00:01 发布
最新推荐文章于 2025-01-31 19:00:01 发布
阅读量1k 收藏 13
点赞数 19
文章标签： java 开发语言
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/2401_89824927/article/details/145224761
版权

org.apache.maven.plugins

maven-pmd-plugin

3.14.0

mvn 命令执行

在项目目录打开cmd窗口，输入以下命令：

mvn pmd:pmd

在这里插入图片描述

分析结果为pmd.html文件，在项目的target下的site目录下：

在这里插入图片描述

在这里插入图片描述

分析结果显示内容：

在这里插入图片描述

3、pmd 命令行的方式

pmd -d 源代码路径 -f xml(结果输出格式) -r 结果保存所在目录及名称 -R rulesets/java/unusedcode.xml

例子：

在这里插入图片描述

结果存放在制定文件目录下，格式也为命令语句指定的：

在这里插入图片描述

检测结果内容：

在这里插入图片描述

4、Java API的方式 *

官方文档

需要先引入maven依赖

项目结构

在这里插入图片描述

测试代码

Test01：

package com.keafmd.test01;

/**

  • Keafmd

  • @ClassName: Test01

  • @Description: 测试1

  • @author: 牛哄哄的柯南

  • @Date: 2021-03-15 15:29

  • @Blog: https://keafmd.blog.youkuaiyun.com/

*/

public class Test01 {

public static void main(String[] args) {

int a =100;

int b=29;

String s =“abc”;

System.out.println(“hello!”);

}

}

Test02：

package com.keafmd.test02;

/**

  • Keafmd

  • @ClassName: Test02

  • @Description:

  • @author: 牛哄哄的柯南

  • @Date: 2021-03-15 15:30

  • @Blog: https://keafmd.blog.youkuaiyun.com/

*/

public class Test02 {

public static void main(String[] args) {

boolean flag=true;

while(flag){

flag=false;

}

System.out.println(“123”);

int a =100;

int b=29;

String s =“abc”;

System.out.println(“hello!”);

}

}

pmdArgs方式

**命令行接口的方式

最简单的方法是使用与命令行相同的接口调用PMD**

Example ：

package com.keafmd;

import net.sourceforge.pmd.PMD;

/**

  • Keafmd

  • @ClassName: Example

  • @Description:

  • @author: 牛哄哄的柯南

  • @Date: 2021-03-15 15:51

  • @Blog: https://keafmd.blog.youkuaiyun.com/

*/

public class Example {

public static void main(String[] args) {

String[] pmdArgs = {

“-d”, “D:/javaworkspace/pdm-test02/src”,

“-R”, “rulesets/java/quickstart.xml”,

“-f”, “xml”,

“-r”, “D:/pmdreport/pmd-report.xml”

};

PMD.main(pmdArgs);

}

}

PMDConfiguration方式

PmdExample：

package com.keafmd;

import net.sourceforge.pmd.PMD;

import net.sourceforge.pmd.PMDConfiguration;

/**

  • Keafmd

  • @ClassName: PmdExample

  • @Description:

  • @author: 牛哄哄的柯南

  • @Date: 2021-03-15 15:57

  • @Blog: https://keafmd.blog.youkuaiyun.com/

*/

public class PmdExample {

public static void main(String[] args) {

/*String fileName ;

// 重新生成文件名（根据具体情况生成对应文件名）

fileName = UUID.randomUUID()+“_”+“pmd-report.html”;

PMDConfiguration configuration = new PMDConfiguration();

configuration.setInputPaths(“D:/file”);

configuration.setRuleSets(“rulesets/java/quickstart.xml”);

configuration.setReportFormat(“html”);

configuration.setReportFile(“D:/pmdreport/”+fileName);

PMD.doPMD(configuration);*/

PMDConfiguration configuration = new PMDConfiguration();

configuration.setInputPaths(“D:/javaworkspace/pdm-test/src”);

configuration.setRuleSets(“rulesets/java/quickstart.xml”);

configuration.setReportFormat(“html”);

configuration.setReportFile(“D:/pmdreport/pmd-report.html”);

PMD.doPMD(configuration);

}

}

Programmatically（拓展）

这使您能够更好地控制处理哪些文件，但也会更加复杂。您还可以提供自己的侦听器和呈现器。

1. 首先，我们创建一个PMDConfiguration。目前，这是指定规则集的唯一方法：

PMDConfiguration configuration = new PMDConfiguration();

configuration.setMinimumPriority(RulePriority.MEDIUM);

configuration.setRuleSets(“rulesets/java/quickstart.xml”);

2. 为了支持类型解析，PMD还需要访问已编译的类和依赖项。这被称为“生长素路径”，并且在这里也进行了配置。注意：您可以指定由:关于Unix系统或;在Windows下。

configuration.prependClasspath(“/home/workspace/target/classes:/home/.m2/repository/my/dependency.jar”);

3. 那我们需要一个规则工厂。这是使用配置创建的，同时考虑到最低优先级：

RuleSetFactory ruleSetFactory = RulesetsFactoryUtils.createFactory(configuration);

4. PMD操作于DataSource。您可以收集自己的列表FileDataSource.

List files = Arrays.asList(new FileDataSource(new File(“/path/to/src/MyClass.java”)));

5. 对于报告，您可以使用内置渲染器。XMLRenderer。注意，必须通过设置适当的Writer打电话start()。在pmd运行之后，您需要调用end()和flush()。那么你的作者应该收到所有的输出。

StringWriter rendererOutput = new StringWriter();

Renderer xmlRenderer = new XMLRenderer(“UTF-8”);

xmlRenderer.setWriter(rendererOutput);

xmlRenderer.start();

6. 创建一个RuleContext。这是上下文实例，在规则实现中是可用的。注意：当在多线程模式下运行时(这是默认的)，规则上下文实例将被克隆到每个线程。

RuleContext ctx = new RuleContext();

7. 可以选择注册报表侦听器。这样你就可以对发现的违规行为立即做出反应。您也可以使用这样的侦听器来实现您自己的呈现器。侦听器必须实现接口。ThreadSafeReportListener并且可以通过ctx.getReport().addListener(...).

ctx.getReport().addListener(new ThreadSafeReportListener() {

public void ruleViolationAdded(RuleViolation ruleViolation) {

}

public void metricAdded(Metric metric) {

}

8. 现在，所有的准备工作都完成了，PMD可以执行了。这是通过调用PMD.processFiles(...)。此方法调用接受配置、规则集工厂、要处理的文件、规则上下文和呈现器列表。如果不想使用任何渲染器，请提供一个空列表。注意：需要显式关闭辅助路径。否则，类或JAR文件可能会保持打开状态，并且文件资源会泄漏。

try {

PMD.processFiles(configuration, ruleSetFactory, files, ctx,

Collections.singletonList(renderer));

} finally {

ClassLoader auxiliaryClassLoader = configuration.getClassLoader();

if (auxiliaryClassLoader instanceof ClasspathClassLoader) {

((ClasspathClassLoader) auxiliaryClassLoader).close();

}

}

9. 呼叫后，您需要完成渲染器end()和flush()。然后，您可以检查呈现的输出。

renderer.end();

renderer.flush();

System.out.println(“Rendered Report:”);

System.out.println(rendererOutput.toString());

下面是一个完整的例子：

import java.io.IOException;

import java.io.StringWriter;

import java.io.Writer;

import java.nio.file.FileSystems;

import java.nio.file.FileVisitResult;

import java.nio.file.Files;

import java.nio.file.Path;

import java.nio.file.PathMatcher;

import java.nio.file.SimpleFileVisitor;

import java.nio.file.attribute.BasicFileAttributes;

import java.util.ArrayList;

import java.util.Collections;

import java.util.List;

import net.sourceforge.pmd.PMD;

import net.sourceforge.pmd.PMDConfiguration;

import net.sourceforge.pmd.RuleContext;

import net.sourceforge.pmd.RulePriority;

import net.sourceforge.pmd.RuleSetFactory;

import net.sourceforge.pmd.RuleViolation;

import net.sourceforge.pmd.RulesetsFactoryUtils;

import net.sourceforge.pmd.ThreadSafeReportListener;

import net.sourceforge.pmd.renderers.Renderer;

import net.sourceforge.pmd.renderers.XMLRenderer;

import net.sourceforge.pmd.stat.Metric;

import net.sourceforge.pmd.util.ClasspathClassLoader;

import net.sourceforge.pmd.util.datasource.DataSource;

import net.sourceforge.pmd.util.datasource.FileDataSource;

public class PmdExample2 {

public static void main(String[] args) throws IOException {

PMDConfiguration configuration = new PMDConfiguration();

configuration.setMinimumPriority(RulePriority.MEDIUM);

configuration.setRuleSets(“rulesets/java/quickstart.xml”);

configuration.prependClasspath(“/home/workspace/target/classes”);

RuleSetFactory ruleSetFactory = RulesetsFactoryUtils.createFactory(configuration);

List files = determineFiles(“/home/workspace/src/main/java/code”);

Writer rendererOutput = new StringWriter();

Renderer renderer = createRenderer(rendererOutput);

renderer.start();

RuleContext ctx = new RuleContext();

ctx.getReport().addListener(createReportListener()); // alternative way to collect violations

try {

PMD.processFiles(configuration, ruleSetFactory, files, ctx,

Collections.singletonList(renderer));

} finally {

ClassLoader auxiliaryClassLoader = configuration.getClassLoader();

if (auxiliaryClassLoader instanceof ClasspathClassLoader) {

((ClasspathClassLoader) auxiliaryClassLoader).close();

}

}

renderer.end();

renderer.flush();

System.out.println(“Rendered Report:”);

System.out.println(rendererOutput.toString());

}

private static ThreadSafeReportListener createReportListener() {

return new ThreadSafeReportListener() {

@Override

public void ruleViolationAdded(RuleViolation ruleViolation) {

System.out.printf(“%-20s:%d %s%n”, ruleViolation.getFilename(),

ruleViolation.getBeginLine(), ruleViolation.getDescription());

}

@Override

public void metricAdded(Metric metric) {

// ignored

}

};

}

private static Renderer createRenderer(Writer writer) {

XMLRenderer xml = new XMLRenderer(“UTF-8”);

xml.setWriter(writer);

return xml;

}

private static List determineFiles(String basePath) throws IOException {

Path dirPath = FileSystems.getDefault().getPath(basePath);

PathMatcher matcher = FileSystems.getDefault().getPathMatcher(“glob:*.java”);

List files = new ArrayList<>();

Files.walkFileTree(dirPath, new SimpleFileVisitor () {

@Override

public FileVisitResult visitFile(Path path, BasicFileAttributes attrs) throws IOException {

if (matcher.matches(path.getFileName())) {

System.out.printf(“Using %s%n”, path);

files.add(new FileDataSource(path.toFile()));

} else {

System.out.printf(“Ignoring %s%n”, path);

}

return super.visitFile(path, attrs);

}

});

System.out.printf(“Analyzing %d files in %s%n”, files.size(), basePath);

return files;

}

}

分析结果

分析结果会根据指定格式输出在指定文件目录下。

图形界面

==============================================================

检测

D:\MyFile\Tool\pmd-bin-6.32.0\bin 目录下打开cmd窗口输入：

cpdgui.bat

在这里插入图片描述

自定义规则

在这里插入图片描述

D:\MyFile\Tool\pmd-bin-6.32.0\bin 目录下打开cmd窗口输入：

designer.bat

在这里插入图片描述

**自定义规则：**不能有变量为keafmd的String类型的变量

String keafmd； //这样就是不合法的。

Source：

PMD工具使用说明中文版
03-01
PMD工具使用说明中文版 非常好用的java检查代码的工具
静态代码检查工具PMD安装、使用
听海边涛声
08-31 4440
静态代码检查工具PMD安装、使用
5分钟学会PMD
weixin_68419854的博客
01-31 854
5分钟快速入门PMD静态代码分析，与maven构建流程集成，提供笔者常用的静态代码分析规则
PMD规则开发实战：打造自己的代码质量检测工具
BASK2311的博客
05-22 2455
PMD是一款开源的静态代码分析工具，用于检查Java、JavaScript、PLSQL和其他语言的代码中的潜在问题，如未使用的变量、未使用的方法、无效的if语句等。PMD通过解析代码，并应用各种规则来检查代码中的潜在问题。这些规则可以根据代码质量标准进行配置，并且可以自定义规则集合。PMD提供了多种输出格式，包括控制台输出、HTML、XML和JSON格式，方便用户进行代码分析和结果处理。
静态分析工具PMD使用说明
热门推荐
黄金屋颜如玉
11-16 2万+
静态分析工具PMD使用说明 目录 静态分析工具PMD使用说明... 1 目录... 2 1.           编写目的... 3 2.           PMD简介... 4 3.           PMD的安装和运行... 4 3.1安装并从命令行运行PMD. 4 3.2在Eclipse中安装PMD插件运行方式... 6 3.3 使用Ant进行调用... 8
Java开发工具使用指南
10-30
总结来说，Java开发工具使用指南为Java初学者和开发者提供了一个全面的入门教程，涵盖了Java SE的下载、安装、配置以及Eclipse集成开发环境的安装和基本使用。掌握这些基础知识点，能够帮助开发者快速搭建起一个良好...
Java-Java资源
最新发布
02-11
"pmd-exclude.properties"文件可能是用于配置PMD代码静态分析工具忽略某些特定规则的文件，有助于开发者专注于关键代码质量检查。"readme.txt"则可能是项目的简单介绍或说明文件。 这个压缩包中包含的文件类型多样...
关于Java的eclipse入门教程
07-28
通过安装插件，你可以扩展Eclipse的功能，例如安装Mylyn用于任务管理，或是PMD插件进行代码质量检查。 ### 9. 版本控制集成 Eclipse可以与各种版本控制系统（如Git、SVN）集成，方便团队协作。你可以在Eclipse中...
my java practice
04-14
同时，为了确保代码质量，开发者可能运用了静态代码分析工具，如Checkstyle或PMD，来检查代码风格和潜在问题。还有可能他们使用了JUnit进行单元测试，确保代码的正确性。test*.java文件中可能包含了一些测试类，用于...
java 环境搭建
04-09
6. **工具**：在开发过程中，还会用到各种辅助工具，如Maven或Gradle用于项目管理和构建，Junit进行单元测试，JProfiler进行性能分析，以及各种代码质量检查工具（如Checkstyle、PMD）等。了解并掌握这些工具的使用...
java静态分析_PMD-Java代码静态分析工具使用
weixin_39963534的博客
02-12 987
如今，使用代码分析工具来代替人工进行代码审查，已经是大势所趋了。用于Java代码检测的工具中，不乏许许多多的佼佼者，其中PMD就是其中一款。PMD既可以独立运行，也可以以命令行的形式运行，还可以作为插件在IDE中运行，本文将基于在Android Studio中的使用来介绍PMD的基本使用。一、PMD简介对于PMD名称含义，有个有趣的现象，PMD不存在一个准确的名称，在官网上你可以发现很有有趣的名称...
几款Java源码扫描工具(FindBugs、PMD、SonarQube、Fortify、WebInspect)
没刮胡子的程序员专栏
11-23 1万+
几款Java源码扫描工具FindBugs、PMD、SonarQube、Fortify、WebInspect
PMD详细介绍
武天旭的博客
10-06 3070
一、PMD概述 1.1、工具说明 PMD是一个代码检查工具，它用于分析Java源代码，找出潜在的问题。 PMD的核心是JavaCC解析器生成器。PMD附带了16个可以直接使用的规则信，利用这些规则可以找出Java源程序的许多问题；此外，PMD规则是可以定制的，可以添加新规则：通过编写Java代码并重新编译PDM，或者更简单些，编写XPath表
PMD代码规范检测
chan_gan_的博客
03-29 632
PMD是一种开源分析Java代码错误的工具，通过静态分析获知代码错误。
如何使用pmd检查代码规范
win9413的博客
02-16 735
本文介绍如何使用pmd检查代码规范。
编码规范(三)----静态分析工具PMD
fendo
12-18 1万+
一、简介 PMD是一款采用BSD协议发布的Java程序代码检查工具。该工具可以做到检查Java代码中是否含有未使用的变量、是否含有空的抓取块、是否含有不必要的对象等。该软件功能强大，扫描效率高，是Java程序员debug的好帮手。 - 与其他分析工具不同的是，PMD通过静态分析获知代码错误。也就是说在不运行Java程序的情况下，报告错误。 - PMD附带了许多可以直接使用的规
测试工具PMD使用
linuxstuding
09-24 825
一、基础知识 　　PMD是一种分析Java代码错误的工具。与其他分析工具不同的是，PMD通过静态分析获知代码错误。也就是说，在不运行Java程序的情况下报告错误。PMD附带了许多可以直接使用的规则，利用这些规则可以找出Java源程序的许多问题，例如没有用到的变量、多余的变量创建操作、空的catch块，等等。此外，用户还可以自己定义规则，检查Java代码是否符合某些特定的编码规范。 PM...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值