Spring Boot项目如何配置类似ESLint、Prettier的代码风格强制工具？

Java生态里要实现类似ESLint+Prettier的代码风格管控，核心用Checkstyle（规范校验） + Spotless（自动格式化），配合IDE自动触发和Git钩子拦截，就能做到团队代码风格统一且强制落地。

具体操作步骤 #

1. 项目依赖配置（Maven为例） #

在pom.xml中添加以下插件，一站式搞定代码校验与格式化：

<build>
    <plugins>
        <!-- Spotless：自动格式化代码，支持多种主流风格 -->
        <plugin>
            <groupId>com.diffplug.spotless</groupId>
            <artifactId>spotless-maven-plugin</artifactId>
            <version>2.42.0</version>
            <configuration>
                <java>
                    <!-- 采用Google Java风格指南，也可替换为Oracle或自定义规则 -->
                    <googleJavaFormat>
                        <version>1.17.0</version>
                        <style>AOSP</style> <!-- 适配普通Java项目的风格变体 -->
                    </googleJavaFormat>
                    <formatAnnotations>true</formatAnnotations> <!-- 优化注解排版 -->
                </java>
            </configuration>
            <!-- 打包前自动校验，不通过则终止构建 -->
            <executions>
                <execution>
                    <goals>
                        <goal>check</goal>
                    </goals>
                    <phase>verify</phase>
                </execution>
            </executions>
        </plugin>

        <!-- Checkstyle：代码规范校验，与Spotless规则对齐避免冲突 -->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-checkstyle-plugin</artifactId>
            <version>3.3.0</version>
            <configuration>
                <configLocation>google_checks.xml</configLocation> <!-- 复用Google官方规则 -->
                <failOnError>true</failOnError> <!-- 校验失败直接终止流程 -->
            </configuration>
            <executions>
                <execution>
                    <goals>
                        <goal>check</goal>
                    </goals>
                    <phase>verify</phase>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

2. 自定义规则（按需调整） #

如果Google风格不符合团队习惯，比如你示例中要求的方法参数换行逻辑，可创建自定义checkstyle.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">
        <!-- 强制方法参数超过3个时自动换行 -->
        <module name="ParameterNumber">
            <property name="max" value="3"/>
            <property name="tokens" value="METHOD_DEF, CTOR_DEF"/>
        </module>
        <!-- 可添加其他自定义规则，比如变量命名、空行规范等 -->
    </module>
</module>

同时调整Spotless配置，确保格式化规则与Checkstyle校验规则一致，避免出现“格式化后仍不通过校验”的矛盾。

3. IDE集成（IntelliJ IDEA） #

让开发者在编码阶段自动格式化，减少后续整改成本：

• 安装Google Java Format插件
• 打开Settings → Tools → Google Java Format，勾选启用
• 配置保存时自动格式化：Settings → Tools → Actions on Save，勾选Reformat code
• 绑定快捷键：将Reformat Code绑定到Ctrl+Alt+L（默认快捷键），方便手动触发

4. Git钩子强制拦截 #

防止未格式化、不符合规范的代码提交到仓库：

1. 在项目根目录的.git/hooks下创建pre-commit文件，内容如下：

#!/bin/sh
# 先自动格式化代码
mvn spotless:apply
# 再执行规范校验
mvn checkstyle:check

# 校验失败则阻止提交
if [ $? -ne 0 ]; then
    echo "代码风格不达标，请修复后再提交！"
    exit 1
fi

2. 给文件添加执行权限：chmod +x .git/hooks/pre-commit

效果验证 #

执行mvn spotless:apply后，你提供的示例代码会自动被格式化为符合要求的样式：

格式化前：

@GetMapping()
public ResponseEntity<byte[]> getJson(@RequestHeader("Accept") String acceptHeader, @RequestParam(required = false) Optional<String> msisdn, @RequestParam(required = false) Optional<LocalDate> startDate, @RequestParam(required = false) Optional<LocalDate> endDate, @RequestParam(required = false) Optional<BlockStatusEnum> status, @RequestParam(required = false) Optional<Integer> pageSize, @RequestParam(required = false) Optional<Integer> pageNumber) throws IOException {

格式化后：

@GetMapping()
public ResponseEntity<byte[]> get(
        @RequestHeader("Accept") String acceptHeader,
        @RequestParam(required = false) Optional<String> msisdn,
        @RequestParam(required = false) Optional<LocalDate> startDate,
        @RequestParam(required = false) Optional<LocalDate> endDate,
        @RequestParam(required = false) Optional<BlockStatusEnum> status,
        @RequestParam(required = false) Optional<Integer> pageSize,
        @RequestParam(required = false) Optional<Integer> pageNumber)
        throws IOException {

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