自定义Checkstyle检查嵌套失效：仅作用于顶级代码的问题求助

核心问题定位 #

你遇到的问题本质是自定义检查没有覆盖到所有需要校验的大括号令牌类型，默认只处理了类定义的大括号，漏掉了方法、构造器、代码块、条件语句等内部结构的大括号。

具体修复步骤 #

1. 覆盖所有目标令牌类型 #

在自定义检查类中，明确指定要处理的所有包含左大括号的AST节点类型，不能只局限于类定义：

@Override
public int[] getDefaultTokens() {
    // 覆盖所有需要校验的节点：类、接口、枚举、方法、构造器、代码块、分支/循环语句等
    return new int[] {
        TokenTypes.CLASS_DEF, TokenTypes.INTERFACE_DEF, TokenTypes.ENUM_DEF,
        TokenTypes.METHOD_DEF, TokenTypes.CTOR_DEF,
        TokenTypes.LITERAL_IF, TokenTypes.LITERAL_ELSE,
        TokenTypes.LITERAL_FOR, TokenTypes.LITERAL_WHILE,
        TokenTypes.LITERAL_DO, TokenTypes.STATIC_INIT, TokenTypes.INSTANCE_INIT,
        TokenTypes.LITERAL_SWITCH, TokenTypes.LITERAL_SYNCHRONIZED
    };
}

2. 准确校验左大括号后续行 #

在visitToken方法中，针对每个节点提取左大括号位置，检查下一行是否为空行：

@Override
public void visitToken(DetailAST ast) {
    // 获取当前节点的左大括号子节点
    DetailAST lbrace = ast.findFirstToken(TokenTypes.LBRACE);
    if (lbrace == null) {
        return;
    }
    
    int lbraceLine = lbrace.getLineNo();
    String[] lines = getLines(); // 通过AbstractCheck获取文件所有行
    
    // 避免越界：左大括号是文件最后一行无需校验
    if (lbraceLine >= lines.length) {
        return;
    }
    
    // 取出左大括号下一行，去除首尾空白后判断是否为空
    String nextLine = lines[lbraceLine].trim();
    if (!nextLine.isEmpty()) {
        log(lbraceLine + 1, "左大括号后必须跟一个空行");
    }
}

3. 配置文件正确设置 #

确保自定义检查放在TreeWalker模块下，无额外令牌过滤规则：

<module name="TreeWalker">
    <!-- 其他内置检查规则 -->
    <module name="com.yourpackage.BraceAfterEmptyLineCheck"/>
</module>

4. IntelliJ插件适配注意事项 #

• 在IntelliJ的Checkstyle插件设置中，指定自定义检查的JAR包路径
• 重启IDE后重新扫描代码，确保插件加载新规则

关键细节补充 #

• 避免误判注释或字符串中的大括号，可通过开启注释节点访问来过滤：

@Override
public boolean isCommentNodesRequired() {
    return true; // 允许访问注释节点，用于判断大括号是否在注释内
}

内容的提问来源于stack exchange，提问作者nulluser