使用SuppressionXpathFilter屏蔽Lombok val的Checkstyle检查

问题描述 #

使用Lombok的val定义局部变量时，Checkstyle的FinalLocalVariable规则会将这些变量标记为非最终变量。尝试通过自定义suppress.xml屏蔽该规则对val变量的检查，但配置后仍持续报错。

当前的suppress.xml配置：

<?xml version="1.0"?>
<!DOCTYPE suppressions PUBLIC
    "-//Checkstyle//DTD SuppressionXpathFilter Experimental Configuration 1.2//EN"
    "https://checkstyle.org/dtds/suppressions_1_2_xpath_experimental.dtd">
 <suppressions>
<suppress-xpath 
        checks="FinalLocalVariable" query="//VARIABLE_DEF[./TYPE/IDENT[@text='val']]"/
</suppressions>

对应的AST树片段：

`--SLIST -> { [32:96]
    |       |--VARIABLE_DEF -> VARIABLE_DEF [33:4]
    |       |   |--MODIFIERS -> MODIFIERS [33:4]
    |       |   |--TYPE -> TYPE [33:4]
    |       |   |   `--IDENT -> val [33:4]

解决方案 #

1. 修复XML语法错误 #

你的suppress-xpath标签存在语法问题：末尾的/后缺少闭合的>，导致XML解析失败。修正后的完整标签如下：

<suppress-xpath 
        checks="FinalLocalVariable" query="//VARIABLE_DEF[./TYPE/IDENT[@text='val']]"/>

2. 优化XPath表达式（可选） #

如果修复语法后仍不生效，可尝试使用更精准的XPath路径，确保匹配到所有val类型的变量定义：

<suppress-xpath 
        checks="FinalLocalVariable" query="//VARIABLE_DEF/TYPE/IDENT[@text='val']/parent::*/parent::*"/>

该表达式通过向上遍历父节点，精准定位到包含val类型声明的VARIABLE_DEF节点。

3. 使用Checkstyle Lombok扩展（推荐） #

直接使用官方支持的Checkstyle Lombok插件，无需手动编写抑制规则，插件会自动识别Lombok的val、var及各类注解，从根源避免误报。

以Maven为例，先添加依赖：

<dependency>
    <groupId>com.puppycrawl.tools</groupId>
    <artifactId>checkstyle-lombok</artifactId>
    <version>最新版本</version>
    <scope>test</scope>
</dependency>

再在Checkstyle配置文件中启用插件：

<module name="Checker">
    <module name="TreeWalker">
        <module name="com.puppycrawl.tools.checkstyle.checks.lombok.LombokExtension"/>
    </module>
</module>

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