3.1. Google Java Format の適用

すべての Java ソースコードは Google Java Format でフォーマットしなければなりません。手動フォーマットは許可されず、ツールによる自動フォーマットのみ認められます。

3.1.1. VSCode 拡張機能の設定

google-java-format-for-vs-code 拡張機能をインストールし、.vscode/settings.json に以下を含めます。

{
  "[java]": {
    "editor.defaultFormatter": "josevseb.google-java-format-for-vs-code",
    "editor.formatOnSave": true
  }
}

3.1.2. Maven プラグイン設定

ビルド時のフォーマット検証を自動化するために spotless-maven-plugin を使用します。

<plugin>
  <groupId>com.diffplug.spotless</groupId>
  <artifactId>spotless-maven-plugin</artifactId>
  <version>2.44.0</version>
  <configuration>
    <java>
      <googleJavaFormat>
        <version>1.25.2</version>
        <style>GOOGLE</style>
      </googleJavaFormat>
    </java>
  </configuration>
  <executions>
    <execution>
      <goals>
        <goal>check</goal>
      </goals>
      <phase>validate</phase>
    </execution>
  </executions>
</plugin>

3.1.3. CI フォーマット検証

CI パイプラインで以下のコマンドによりフォーマット違反を検出します。

mvn spotless:check

フォーマット違反が検出された場合、ビルドが失敗します。ローカルで自動修正するには以下を実行します。

mvn spotless:apply