如何自定义 Checkstyle 规则:强制左花括号后必须紧跟空行

轻伟同学_3644

轻伟同学_3644

2026-11-03

612人浏览

原创

如何自定义 Checkstyle 规则:强制左花括号后必须紧跟空行

本文详解如何基于 Checkstyle 的 LeftCurlyCheck 扩展实现自定义检查——要求 Java 中每个 { 后必须紧随一个空白行,支持类、方法、if/for 等任意嵌套层级,解决常见“仅校验顶层结构”的局限性。

本文详解如何基于 checkstyle 的 `leftcurlycheck` 扩展实现自定义检查——要求 java 中每个 `{` 后必须紧随一个空白行,支持类、方法、if/for 等任意嵌套层级,解决常见“仅校验顶层结构”的局限性。

Checkstyle 默认的 LeftCurly 检查(如 nl 风格)仅关注左花括号的位置(换行/同行),但不校验其后一行是否为空白行。要实现“{ 后必须是空行”这一严格格式规范,最稳健的方式是继承并扩展官方 LeftCurlyCheck,而非从零遍历 token 或解析原始文件内容——后者易受 AST 层级限制(如仅触发 CLASS_DEF 而忽略 METHOD_DEF),且难以精准定位物理行号与上下文关系。

✅ 正确实现路径:复用并增强 LeftCurlyCheck

  1. 继承 LeftCurlyCheck 类(而非 AbstractCheck),复用其成熟的 brace 定位逻辑和 AST 遍历机制;
  2. 重写 verifyBrace 方法,在已知 { token 位置的基础上,获取其所在行的下一行内容进行空白判断;
  3. 通过 getLine() 获取源码行,避免手动计算行号偏移错误。

以下是核心代码示例(兼容 Checkstyle 8.x–10.x):

getLines()
  • 编译生成 JAR 后,在 IntelliJ 的 Checkstyle 插件设置中指定该 JAR 路径;
  • checkstyle.xml 示例片段:
    <module name="TreeWalker"><module name="BlankLineAfterLeftCurlyCheck"></module></module>
  • 若遇 ClassNotFoundException,请确认 JAR 包含 module-info.class(Checkstyle 10+)或已正确打包依赖(推荐使用 maven-shade-plugin 合并)。

✅ 总结

绕过低层 token 遍历或文件行扫描的“捷径”,转而深度复用 Checkstyle 原生检查器的设计范式,是开发健壮、可维护、全层级生效的自定义规则的关键。本方案不仅满足“{ 后空行”的业务需求,更具备良好的可扩展性——例如后续可增加白名单(如 if (x) { 允许单行)、或支持跳过注释块等高级策略。

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

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

下载

相关标签:

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

相关专题

更多
java
java

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

2023.06.15

11797

6

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

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

2023.07.05

8882

9

java自学难吗
java自学难吗

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

2023.07.31

7632

8

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

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

2023.08.01

1244

3

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

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

2023.08.02

1008

3

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

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

2023.08.02

1496

5

java有什么用
java有什么用

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

2023.08.02

3089

5

java在线网站
java在线网站

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

2023.08.03

20351

3

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

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1355

8

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 134.1万人学习