代码风格

这一课你将能做到

1. 用 Checkstyle / Spotless / ESLint 把风格问题拦截在 Review 之前
2. 识别「风格争议」和「真正的代码异味」之间的区别
3. 在团队内推动「机器管风格，人管设计」的分工

为什么要学

Code Review 最浪费时间的事，就是人工争论「这里该不该加空格」「import 顺序对不对」。这些应该全部交给机器。人审的精力留给真正需要判断的事：设计、语义、边界。

人话：让 linter 当坏人，reviewer 当导师。机器卡格式，人来看思路。

先建立图像

Review 时间分配
┌────────────────────────────────────────┐
│ 风格问题（空格/换行/import 顺序）        │
│ → 100% 交给 Lint 工具                  │
│   Checkstyle / Spotless / ESLint       │
│   Reviewer 看到 = Lint 配置不全        │
├────────────────────────────────────────┤
│ 命名 / 函数长度 / 嵌套深度              │
│ → Lint 管一部分（规则化）              │
│ → Reviewer 管一部分（需要语境判断）    │
├────────────────────────────────────────┤
│ 设计 / 抽象 / 边界 / 语义              │
│ → 100% 人来审                          │
└────────────────────────────────────────┘

跟着做

步骤 1：配置 Checkstyle（Java 后端）

pom.xml：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-checkstyle-plugin</artifactId>
    <version>3.4.0</version>
    <configuration>
        <configLocation>google_checks.xml</configLocation>
        <consoleOutput>true</consoleOutput>
        <failsOnError>true</failsOnError>
    </configuration>
    <executions>
        <execution>
            <phase>validate</phase>
            <goals><goal>check</goal></goals>
        </execution>
    </executions>
</plugin>

效果：mvn compile 时自动检查，风格不达标直接编译失败。

步骤 2：配置 Spotless（自动格式化）

<plugin>
    <groupId>com.diffplug.spotless</groupId>
    <artifactId>spotless-maven-plugin</artifactId>
    <version>2.43.0</version>
    <configuration>
        <java>
            <googleJavaFormat>
                <version>1.22.0</version>
                <style>GOOGLE</style>
            </googleJavaFormat>
            <removeUnusedImports/>
            <trimTrailingWhitespace/>
            <endWithNewline/>
        </java>
    </configuration>
</plugin>

mvn spotless:apply   # 一键格式化整个项目

配合 pre-commit hook，提交前自动跑。

步骤 3：配置 ESLint + Prettier（前端）

// .eslintrc.json
{
  "extends": [
    "next/core-web-vitals",
    "plugin:@typescript-eslint/recommended",
    "prettier"
  ],
  "rules": {
    "@typescript-eslint/no-unused-vars": "error",
    "@typescript-eslint/consistent-type-imports": "error",
    "no-console": ["warn", { "allow": ["warn", "error"] }],
    "react-hooks/exhaustive-deps": "error"
  }
}