本文详解如何基于 Checkstyle 内置 LeftCurlyCheck 扩展实现自定义检查——要求 Java 中每个 { 后必须紧跟一个空行，支持类、方法、if/for 等任意嵌套层级的结构。
本文详解如何基于 checkstyle 内置 `leftcurlycheck` 扩展实现自定义检查——要求 java 中每个 `{` 后必须紧跟一个空行，支持类、方法、if/for 等任意嵌套层级的结构。
要实现“左花括号 { 后必须为一行空白”的严格格式约束，直接遍历 TokenTypes.LCURLY 并检查下一行是否为空是可行路径，但关键难点在于：默认 visitToken(LCURLY) 仅触发于 AST 树中匹配的节点，而 Checkstyle 的 TreeWalker 模块天然支持全层级遍历（包括嵌套的类、方法、控制语句等）——问题不在于“无法访问深层结构”，而在于检查逻辑未正确处理行内容边界与空白判定。
✅ 正确做法是复用 Checkstyle 成熟的 LeftCurlyCheck 基础架构，而非从零实现 token 遍历。该检查已完整覆盖 CLASS_DEF, METHOD_DEF, LITERAL_IF, LITERAL_FOR, LITERAL_WHILE, LITERAL_DO, LITERAL_SWITCH, LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, STATIC_INIT, INSTANCE_INIT, ANNOTATION_DEF, ENUM_DEF, RECORD_DEF 等全部需校验 { 位置的 AST 节点类型，天然支持嵌套。
以下是推荐的实现步骤：
1. 继承并扩展 LeftCurlyCheck
public class BlankLineAfterLeftCurlyCheck extends LeftCurlyCheck {
@Override
protected void verifyBrace(DetailAST ast, int braceLineNo, int braceColNo) {
final String[] lines = getLines(); // 获取文件所有行（0-indexed）
final int nextLineIndex = braceLineNo; // 注意：Checkstyle 行号从 0 开始，且 braceLineNo 指的是 `{` 所在行号
// 安全检查：确保下一行存在
if (nextLineIndex + 1 >= lines.length) {
return;
}
final String nextLine = lines[nextLineIndex + 1].trim();
if (!nextLine.isEmpty()) {
log(ast, "left.curly.blank.line.required",
"Left curly brace '{' must be followed by a blank line.");
}
}
}
⚠️ 注意：
braceLineNo是{所在行的索引（从 0 开始），因此下一行是lines[braceLineNo + 1]；getLines()返回的是原始源码按\n分割的字符串数组，保留原始空白。
2. 注册自定义检查（checkstyle.xml）
<module name="Checker"><module name="TreeWalker"><!-- 替换或补充原有 LeftCurly --><module name="com.yourcompany.checks.BlankLineAfterLeftCurlyCheck"><property name="severity" value="error"></property></module></module></module>
3. IntelliJ 集成注意事项
- 确保自定义 JAR 已添加至 IntelliJ Checkstyle 插件的 Configuration file → Classpath；
- 使用
Checkstyle-IDEA插件 v5.69.0+，它支持动态加载自定义检查类； - 若遇
ClassNotFoundException，请确认类名与包路径完全匹配，且 JAR 中包含META-INF/MANIFEST.MF（非必需但建议声明Class-Path）。
✅ 为什么此方案能解决“仅检查顶层”问题？
因为 LeftCurlyCheck 的 getDefaultTokens() 显式返回了全部相关 AST token 类型（如 TokenTypes.METHOD_DEF），TreeWalker 会为每个匹配节点调用 visitToken() —— 这意味着类体 {、方法体 {、if 块 { 等所有层级的左花括号都会被独立捕获并验证，无需手动递归或解析嵌套结构。
? 补充建议
- 如需兼容性更强，可新增布尔属性（如
requireBlankLineAfterLeftCurly）并继承原LeftCurlyCheck，避免重复维护； - 生产环境建议增加日志上下文（如打印违规行号和代码片段），便于快速定位；
- 测试时务必覆盖多层嵌套场景（如
class → method → if → for → {），验证每级{均被检查。
通过复用 Checkstyle 官方检查的设计范式，你不仅获得开箱即用的嵌套支持，还规避了手动解析 AST 或文件行号映射带来的常见陷阱，让定制规则既健壮又可持续演进。
