Java 代码检查工具之PMD入门使用详细教程

介绍

PMD是一个静态源代码分析器。它发现了常见的编程缺陷,如未使用的变量、空捕获块、不必要的对象创建等等。

官网:点这里
官方文档:点这里

使用方式

1、使用插件的方式

下载:File -> Settings -> Plugins -> Marketplace 搜索 “PMDPlugin” ,下载插件。

使用方法:在代码编辑框或Project 窗口的文件夹、包、文件右键,选择“Run PMD”->“Pre Defined”->“All”,对指定的文件夹、包、文件进行分析,分析结果在控制台输出。

2、maven项目引入依赖的方式

pom.xml:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 <modelVersion>4.0.0</modelVersion>

 <groupId>com.keafmd</groupId>
 <artifactId>pdm-test01</artifactId>
 <version>1.0-SNAPSHOT</version>

 <!--<dependencies>
 <dependency>
 <groupId>org.apache.maven.plugins</groupId>
 <artifactId>maven-pmd-plugin</artifactId>
 <version>3.14.0</version>
 <type>maven-plugin</type>
 </dependency>

 </dependencies>-->

 <!-- 用于生成错误到代码内容的链接 -->
 <reporting>
 <plugins>
 <plugin>
 <groupId>org.apache.maven.plugins</groupId>
 <artifactId>maven-pmd-plugin</artifactId>
 <version>3.14.0</version>

 </plugin>
 </plugins>
 </reporting>

</project>

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.csdn.net/
 */
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.csdn.net/
 */
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.csdn.net/
 */
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.csdn.net/
 */

public class PmdExample {

 public static void main(String[] args) {
 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<DataSource> 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<DataSource> 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<DataSource> determineFiles(String basePath) throws IOException {
 Path dirPath = FileSystems.getDefault().getPath(basePath);
 PathMatcher matcher = FileSystems.getDefault().getPathMatcher("glob:*.java");

 List<DataSource> files = new ArrayList<>();

 Files.walkFileTree(dirPath, new SimpleFileVisitor<Path>() {
 @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:

public class KeepingItSerious {

 Delegator keafmd; // FieldDeclaration

 public void method() {
 String keafmd; // LocalVariableDeclaration
 }

}

导出的自定义规则:

<rule name="myrule"
 language="java"
 message="不能有变量为keafmd的String类型的变量"
 class="net.sourceforge.pmd.lang.rule.XPathRule">
 <description>
	自定义规则
 </description>
 <priority>3</priority>
 <properties>
 <property name="version" value="2.0"/>
 <property name="xpath">
 <value>
<![CDATA[
//VariableDeclaratorId[@Image = "keafmd" and ../../Type[@TypeImage = "String"]]
]]>
 </value>
 </property>
 </properties>
</rule>

到此这篇关于Java 代码检查工具之PMD入门使用详细教程的文章就介绍到这了,更多相关Java 代码检查工具PMD内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们!

(0)

相关推荐

  • java检查服务器的连通两种方法代码分享

    首先要了解一下ping的内容. 概述 PING (Packet Internet Groper),因特网包探索器,用于测试网络连接量的程序.Ping发送一个ICMP(Internet Control Messages Protocol)即因特网信报控制协议:回声请求消息给目的地并报告是否收到所希望的ICMPecho (ICMP回声应答).它是用来检查网络是否通畅或者网络连接速度的命令.作为一个生活在网络上的管理员或者黑客来说,ping命令是第一个必须掌握的DOS命令,它所利用的原理是这样的:利用

  • java双重检查锁定的实现代码

    在Java程序中,有时候可能需要推迟一些高开销的对象初始化操作,并且只有在使用这些对象时才进行初始化 .这称为延迟初始化或懒加载 看一个不安全的延迟初始化: A线程执行1后,发现对象instance为null,准备对其new,而B线程却先new了,这造成了错误 我们可以利用同步锁,保证正确: 但是对整个方法进行同步开销太大,人们想出了双重检查锁定: 最小范围所用同步锁,利用双重检查看似实现了目的,但这出现了一个问题:当A线程4执行时,线程B的7还未执行完成,而线程A判定instance != n

  • Java的静态类型检查示例代码详解

    关于静态类型检查和动态类型检查的解释: 静态类型检查:基于程序的源代码来验证类型安全的过程: 动态类型检查:在程序运行期间验证类型安全的过程: Java使用静态类型检查在编译期间分析程序,确保没有类型错误.基本的思想是不要让类型错误在运行期间发生. 在各色各样的编程语言中,总共存在着两个类型检查机制:静态类型检查和动态类型检查. 静态类型检查是指通过对应用程序的源码进行分析,在编译期间就保证程序的类型安全. 动态类型检查是在程序的运行过程中,验证程序的类型安全.在Java中,编译期间使用静态类型

  • 使用Gradle做Java代码质量检查的方法示例

    Maven --> Gradle 首先安装gradle: Mac安装 brew install gradle Ubuntu安装 apt install gradle Maven项目切换Gradle项目,再Maven根目录下运行: gradle init --type pom 运行成功之后运行命令gradle build,成功之后删除pom.xml即可. 使用jacoco分析单元测试 jacoco是一个分析单元测试覆盖率的工具,使用它运行单元测试后,可以给出代码中那些部分被单元测试到,哪些部分没有

  • Java 代码检查工具之PMD入门使用详细教程

    介绍 PMD是一个静态源代码分析器.它发现了常见的编程缺陷,如未使用的变量.空捕获块.不必要的对象创建等等. 官网:点这里 官方文档:点这里 使用方式 1.使用插件的方式 下载:File -> Settings -> Plugins -> Marketplace 搜索 "PMDPlugin" ,下载插件. 使用方法:在代码编辑框或Project 窗口的文件夹.包.文件右键,选择"Run PMD"->"Pre Defined"

  • JS代码检查工具ESLint介绍与使用方法

    ESLint不但提供一些默认的规则,也提供用户自定义规则来约束所写的JavaScript代码. 发展历史 Douglas Crockford大神根据自己的理念用JavaScript写了一个JavaScript代码规范检查工具,这就是JSLint.后来非常流行,也的确帮助了广大的JavaScript程序员.但是,大神对于自己的代码规范不做丝毫的妥协,对开源社区的反馈的回应也不礼貌.于是,JSLint从一个帮助程序员规范代码,避免Bug的工具,变成了一个让代码像Crockford的工具.在最不信神的

  • 在React项目中使用Eslint代码检查工具及常见问题

    背景 最近使用 create-react-app 创建了一个项目.但是众所周知的是,这个脚手架创建的项目并没有默认加入 Eslint 等 lint 插件来规范代码. 考虑到项目中很多项目没有使用类似的代码检查工具,为了规范开发.这次有必要记录一下流程. 使用 Eslint 流程 1. 安装 Eslint 首先,先安装 Eslint 到项目本地(全局安装亦可). npm --save-dev install eslint 安装完成之后,我们先创建基础的 .eslintrc.yml (建议使用 .y

  • CSS代码检查工具stylelint的使用方法详解

    CSS不能算是严格意义的编程语言,但是在前端体系中却不能小觑. CSS 是以描述为主的样式表,如果描述得混乱.没有规则,对于其他开发者一定是一个定时炸弹,特别是有强迫症的人群.CSS 看似简单,想要写出漂亮的 CSS 还是相当困难.所以校验 CSS 规则的行动迫在眉睫.stylelint是一个强大的现代 CSS 检测器,可以让开发者在样式表中遵循一致的约定和避免错误.本文将详细介绍CSS代码检查工具stylelint 概述 stylelint拥有超过150条的规则,包括捕捉错误.最佳实践.控制可

  • 引入代码检查工具stylelint实战问题经验总结分享

    目录 前言 正文 1. 安装stylelint 2. 配置文件 3. 使用stylelint 踩坑点1: 4. 配置规则 5. 忽略lint文件 6. 自动格式化 6.1 stylelint vs-code 插件 6.3 插件踩坑集锦 7. commit检测 前言 团队合作时,当每个人的代码都拥有自定义的格式化方式时,在提交merge的时候往往要解决很多冲突,此时我们可以使用eslint+stylelint来对团队的代码进行约束. 正文 stylelint是一个强大的,现代的代码检查工具,可以帮

  • SpringBoot整合mybatis-plus快速入门超详细教程

    目录 前言 mybatis-plus 简介 mybatis-plus 优点 相关链接 mybatis-plus实例 1.示例项目结构 2.数据库准备 3.pom.xml: 4.application.yml 5.User.java 6.UserMapper.java 7.UserServiceImpl.java 8.测试类 mybatis-plus的crud: 1.insert操作: 2.select操作: 3.update操作: 4.delete操作: 总结 前言 mybatis-plus 简

  • Tomcat服务器入门超详细教程

    目录 一,Tomcat的一些概念 –1,服务器 –2,web服务器 –3,Tomcat服务器 二,使用Tomcat –1,下载安装 –2,启动&关闭 –3,测试 三,Tomcat目录结构 –1,核心目录 –2,修改默认端口号8080 四,访问自己的项目资源 –1,在webapps中添加自己简单的项目 –2,测试 –3,一个完整的web应用结构 五,在IDEA中整合Tomcat –1,操作如下图 –2,测试 一,Tomcat的一些概念 –1,服务器 服务器:分为服务器硬件和服务器软件.在硬件服务器

  • C/C++ 开发神器CLion使用入门超详细教程

    CLion是Jetbrains公司旗下新推出的一款专为开发C/C++所设计的跨平台IDE,它是以IntelliJ为基础设计的,同时还包含了许多智能功能来提高开发人员的生产力. Clion2020.2.x最新激活码破解版附安装教程(Mac Linux Windows) https://www.jb51.net/article/200548.htm 同样支持python哦,相信使用过IntelliJ idea开发过java的盆友都很清楚该IDE的强大,所以做为Jetbrains旗下的c/c++开发工

  • 使用Java 压缩文件打包tar.gz 包的详细教程

    一.背景 最近,小哈主要在负责日志中台的开发工作, 等等,啥是日志中台? 俺只知道中台概念,这段时间的确很火,但是日志中台又是用来干啥的? 这里小哈尽量地通俗的说下日志中台的职责,再说日志中台之前,我们先扯点别的? 相信大家对集中式日志平台 ELK 都知道一些,生产环境中, 稍复杂的架构,服务一般都是集群部署,这样,日志就会分散在每台服务器上,一旦发生问题,想要查看日志就会非常繁琐,你需要登录每台服务器找日志,因为你不确定请求被打到哪个节点上.另外,任由开发人员登录服务器查看日志本身就存在安全隐

  • 使用idea将工具类打包使用的详细教程

    IDEA-java工具类打JAR包: File -> Project Structure -> Artifacts -> + -> JAR -> Empty -> 给jar包起名 -> 在左侧Artifacts列表栏中,点击新创建的那个Artifacts,然后设置Output Directory -> Output Layout -> + -> Directory Content -> 在弹出的路径中选要打包的java 对应的.class文

随机推荐