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

胖墨小哥_6924

胖墨小哥_6924

2025-12-14

429人浏览

原创

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
  java/bestpractices.xml/UnusedLocalVariable" />
  
    
      
    

  

关键操作有这些:

Pandas 配置文件报告生成器
Pandas 配置文件报告生成器

使用ydata-profiling(前身为pandas-profiling)生成全面的数据质量报告,包含相关性分析、缺失值模式和基数检测。导出交互式HTML仪表板和JSON摘要。

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

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<rule ref="./ruleset-core.xml"></rule> 引入,清晰又易维护
基本上就这些。不复杂但容易忽略细节——重点是路径别写错、property 名别拼错、XML 格式要合法。改完跑一次真实代码,比看十遍文档都管用。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

java idea eclipse 配置文件

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
eclipse教程
eclipse教程

php中文网为大家带来eclipse教程合集,eclipse是一个开放源代码的、基于Java的可扩展开发平台。就其本身而言,它只是一个框架和一组服务,用于通过插件组件构建开发环境。php中文网还为大家带来eclipse的相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.14

530

5

eclipse怎么设置中文
eclipse怎么设置中文

eclipse设置中文的方法:除了设置界面为中文外,你还可以为Eclipse添加中文插件,以便更好地支持中文编程。例如,你可以安装EBNF插件来支持中文变量名,或安装Chinese Helper来提供中文帮助文档。本专题为大家提供eclipse设置中文相关的各种文章、以及下载和课程。

2023.07.24

4406

6

c语言编程软件有哪些
c语言编程软件有哪些

c语言编程软件有GCC、Clang、Microsoft Visual Studio、Eclipse、NetBeans、Dev-C++、Code::Blocks、KDevelop、Sublime Text和Atom。更多关于c语言编程软件的问题详情请看本专题的文章。php中文网欢迎大家前来学习。

2023.11.02

6639

18

Eclipse版本号有哪些区别
Eclipse版本号有哪些区别

区别:1、Eclipse 3.x系列:Eclipse的早期版本,包括3.0、3.1、3.2等;2、Eclipse 4.x系列:Eclipse的最新版本,包括4.0、4.1、4.2等;3、Eclipse IDE for Java Developers等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.02.23

2564

5

eclipse和idea有什么区别
eclipse和idea有什么区别

eclipse和idea的区别:1、平台支持;2、内存占用;3、插件系统;4、智能代码提示;5、界面设计;6、调试功能;7、学习曲线。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.02.23

622

5

eclipse设置中文全教程
eclipse设置中文全教程

本专题整合了eclipse设置中文相关教程,阅读专题下面的文章了解更多详细操作。

2025.10.10

2826

11

eclipse字体放大教程
eclipse字体放大教程

本专题整合了eclipse字体放大教程,阅读专题下面的文章了解更多详细内容。

2025.10.10

2845

12

eclipse左边栏不见了解决方法
eclipse左边栏不见了解决方法

本专题整合了eclipse左边栏相关教程,阅读专题下面的文章了解更多详细内容。

2025.10.15

388

3

eclipse字体相关教程
eclipse字体相关教程

本专题整合了eclipse字体设置相关教程,阅读专题下面的文章了解更多详细内容。

2025.11.26

814

12

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习