0

0

PMD代码检查的ruleset.xml怎么自定义

畫卷琴夢

畫卷琴夢

发布时间:2025-12-14 21:17:41

|

409人浏览过

|

来源于php中文网

原创

PMD 的 ruleset.xml 是定义代码检查规则的核心配置文件,需基于官方模板修改,通过 启用规则、 排除路径、 调参,并本地验证生效。

pmd代码检查的ruleset.xml怎么自定义

PMD 的 `ruleset.xml` 是用来定义代码检查规则的核心配置文件。自定义它,本质上就是告诉 PMD:**要启用哪些规则、禁用哪些规则、是否调整规则参数、是否按需分组或分级**。下面直接说清楚怎么操作:

1. 从官方 ruleset 模板开始

别从零手写。去 PMD 官方规则文档 找对应语言(比如 Java)的推荐 ruleset,点击“Download”下载一个标准 XML(如 pmd-java-ruleset.xml)。这是最稳妥的起点。

2. 修改 ruleset.xml 的常见方式

打开 XML 后,你会看到类似这样的结构:


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">
  Custom rules for my project
  gory/java/bestpractices.xml/UnusedLocalVariable" />
  
    
      
    

  

关键操作有这些:

Runway
Runway

Runway是一个AI创意工具平台,它提供了一系列强大的功能,旨在帮助用户在视觉内容创作、设计和开发过程中提高效率和创新能力。

下载
  • 启用规则:用 引入单条规则,或整类规则(如 category/java/bestpractices.xml
  • 禁用规则:加 languagemessage 属性,或直接删掉对应
  • 调参:在 内嵌 ,填上规则支持的 property 名(查官方文档确认)
  • 排除路径:在 ruleset 根节点下加 .*Test\.java$ 跳过测试类

3. 验证和调试 ruleset 是否生效

别改完就扔进 CI。本地先验证:

  • 命令行运行:pmd -d src/main/java -f text -R ruleset.xml
  • 如果报错,大概率是 XML 格式错误或规则路径写错(注意大小写、斜杠方向、文件是否存在)
  • -debug 参数看 PMD 加载了哪些规则,确认你的 rule 是否被识别
  • IDEA 或 Eclipse 插件里手动指定这个 ruleset,看实时提示是否符合预期

4. 进阶:模块化与复用

大项目建议拆分:

  • ruleset-core.xml(基础必检项)
  • ruleset-test.xml(仅对 test 目录启用的规则)
  • ruleset.xml 引入,清晰又易维护
基本上就这些。不复杂但容易忽略细节——重点是路径别写错、property 名别拼错、XML 格式要合法。改完跑一次真实代码,比看十遍文档都管用。

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

837

2023.06.15

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

741

2023.07.05

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

737

2023.07.31

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

397

2023.08.01

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

399

2023.08.02

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

446

2023.08.02

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

430

2023.08.02

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

16926

2023.08.03

PHP WebSocket 实时通信开发
PHP WebSocket 实时通信开发

本专题系统讲解 PHP 在实时通信与长连接场景中的应用实践,涵盖 WebSocket 协议原理、服务端连接管理、消息推送机制、心跳检测、断线重连以及与前端的实时交互实现。通过聊天系统、实时通知等案例,帮助开发者掌握 使用 PHP 构建实时通信与推送服务的完整开发流程,适用于即时消息与高互动性应用场景。

11

2026.01.19

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Kotlin 教程
Kotlin 教程

共23课时 | 2.7万人学习

C# 教程
C# 教程

共94课时 | 7万人学习

Java 教程
Java 教程

共578课时 | 47.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号