如何用Spotless Java代码格式化工具强制使用this关键字？

报错原因 #

你之前的自定义正则匹配范围过于宽泛，误将类名、关键字以外的大量标识符（比如类定义中的类名）替换为this.xxx，导致代码语法完全错误，google-java-format无法解析，从而抛出格式化异常。

解决方案 #

正则无法准确区分局部变量、实例成员和类级元素，建议使用基于语法分析的Checkstyle规则来实现需求，避免破坏代码结构。

步骤1：修改Spotless Gradle配置 #

在原配置中添加Checkstyle规则，替换掉错误的自定义正则：

spotless {
    java {
        importOrder('emu.grasscutter', '', 'java', 'javax', '\#java', '\#')
        googleJavaFormat('1.15.0')
        formatAnnotations()
        endWithNewline()
        indentWithTabs(2); indentWithSpaces(4)
        toggleOffOn()
        
        // 引入Checkstyle规则强制使用this
        checkstyle {
            configFile file('config/checkstyle/require-this.xml')
        }
    }
}

步骤2：创建Checkstyle配置文件 #

在项目根目录下创建config/checkstyle/require-this.xml，内容如下：

<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
        "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
        "https://checkstyle.org/dtds/configuration_1_3.dtd">
<module name="Checker">
    <module name="TreeWalker">
        <!-- 强制实例方法调用前添加this -->
        <module name="RequireThis">
            <property name="checkMethods" value="true"/>
            <!-- 强制实例字段访问前添加this -->
            <property name="checkFields" value="true"/>
            <!-- 可选：是否检查构造器中的this调用，默认true，这里设为false避免干扰 -->
            <property name="checkConstructors" value="false"/>
        </module>
    </module>
</module>

可选：正则方案（仅作参考，不推荐） #

如果坚持使用正则，需要大幅缩小匹配范围，仅针对实例方法/字段调用，避免误匹配类名、局部变量等：

custom('this-keyword', {
    it.replaceAll(/(?<!\w|\.)\b(?!super|this|public|private|protected|static|class|interface|enum|return)(\w+)(?=\.|\()/, 'this.$1')
})

注意：该正则仍可能存在误匹配（比如局部变量名和实例字段名重名时），无法完全替代语法分析方案。

验证 #

重新运行Spotless格式化命令：

./gradlew spotlessApply

此时会自动给所有实例方法调用和字段访问添加this.前缀，且不会破坏代码语法，google-java-format能正常完成格式化。

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