PMD规则集ruleset.xml怎么定义 自定义PMD规则

大芳酱_3404

大芳酱_3404

2025-12-30

1026人浏览

原创

自定义PMD规则集是编写符合其XML Schema的ruleset.xml文件,用于声明启用/排除规则、调整参数及过滤路径;不写Java代码,仅通过XML结构化配置静态分析行为。

pmd规则集ruleset.xml怎么定义 自定义pmd规则

定义自定义 PMD 规则集(ruleset.xml)本质是编写一个符合 PMD XML Schema 的配置文件,用于声明启用哪些规则、排除哪些规则、调整参数、过滤文件路径。它不写 Java 代码,而是通过结构化 XML 精准控制静态分析行为。

基础结构:从最小可运行 ruleset 开始

每个 ruleset.xml 必须包含命名空间和版本声明,并提供描述。最简可用模板如下:


  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">
  聚焦可读性与健壮性的 Java 检查集
  

注意:name 属性必须唯一且有意义;schemaLocation 链接确保 IDE 和 PMD 能校验语法正确性。

规则引用:按需组合内置规则

PMD 自带大量分类规则(如 codestyle、errorprone、design),推荐优先复用而非重写。两种主流方式:

  • 单规则引用:精准启用某一条,适合重点管控项
    java/errorprone.xml/EmptyCatchBlock"/>
  • 整类引用 + 排除特例:高效引入一整套,再剔除不适用的

      
      

推荐使用后者管理风格类规则,既保持一致性又保留灵活性。

JavaStoryDevelop
JavaStoryDevelop

你接手一个需求时,是不是经常这样:"改一个小字段 → 结果把不相关的代码也改了"、"需求说得很模糊 → 做着做着发现跑偏了"、"数据库加个字段 → 上线才发现漏了数据兼容"、"做了个新功能 → 一个月后自己都忘了当时怎么设计的"、"写到一半被中断 → 再回来不知道从哪继续";这个 Skill 就是专门解决这些问题的。 它会自动探测你的项目环境(JDK、Spring Boot、ORM、数据库、前端框架),记在

下载

规则微调:修改阈值或行为参数

许多规则支持属性(properties)定制。例如控制圈复杂度告警门槛:


  
    
  

常见可调属性包括:threshold、violationSuppressRegex、allowCommentedBlocks 等。具体字段需查阅对应规则文档或源码中的 @Property 注解。

文件范围控制:exclude-pattern 与 include-pattern

避免对测试、生成代码、第三方库误报。在 <ruleset></ruleset> 根节点下直接声明:

  • 全局排除测试目录:.*/test/.*
  • 排除自动生成代码:.*/generated/.*
  • 白名单特例(即使在排除路径中也检查):.*/test/important/.*

匹配基于正则表达式,路径为相对于项目根的完整路径(含包名),建议用 .* 做前缀后缀通配更稳妥。

相关文章

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

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

下载

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

相关专题

更多
js正则表达式
js正则表达式

php中文网为大家提供各种js正则表达式语法大全以及各种js正则表达式使用的方法,还有更多js正则表达式的相关文章、相关下载、相关课程,供大家免费下载体验。

2023.06.20

4516

8

正则表达式不包含
正则表达式不包含

正则表达式,又称规则表达式,,是一种文本模式,包括普通字符和特殊字符,是计算机科学的一个概念。正则表达式使用单个字符串来描述、匹配一系列匹配某个句法规则的字符串,通常被用来检索、替换那些符合某个模式的文本。php中文网给大家带来了有关正则表达式的相关教程以及文章,希望对大家能有所帮助。

2023.07.05

3041

4

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

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

2023.07.05

8402

9

java正则表达式匹配字符串
java正则表达式匹配字符串

在Java中,我们可以使用正则表达式来匹配字符串。本专题为大家带来java正则表达式匹配字符串的相关内容,帮助大家解决问题。

2023.08.11

812

5

正则表达式空格
正则表达式空格

正则表达式空格可以用“\s”来表示,它是一个特殊的元字符,用于匹配任意空白字符,包括空格、制表符、换行符等。本专题为大家提供正则表达式相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.31

520

5

Python爬虫获取数据的方法
Python爬虫获取数据的方法

Python爬虫可以通过请求库发送HTTP请求、解析库解析HTML、正则表达式提取数据,或使用数据抓取框架来获取数据。更多关于Python爬虫相关知识。详情阅读本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

693

12

正则表达式空格如何表示
正则表达式空格如何表示

正则表达式空格可以用“\s”来表示,它是一个特殊的元字符,用于匹配任意空白字符,包括空格、制表符、换行符等。想了解更多正则表达式空格怎么表示的内容,可以访问下面的文章。

2023.11.17

406

3

正则表达式中如何匹配数字
正则表达式中如何匹配数字

正则表达式中可以通过匹配单个数字、匹配多个数字、匹配固定长度的数字、匹配整数和小数、匹配负数和匹配科学计数法表示的数字的方法匹配数字。更多关于正则表达式的相关知识详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.12.06

719

7

php正则表达式有哪些
php正则表达式有哪些

php正则表达式有"/pattern/"、"^"、"$"、"."、"[]"、"[^]"、"[a-z]"、"[A-Z]"、"[0-9]"、"\d"、"\D"、"\w"、"\W"、&a

2024.02.23

312

5

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习