Skip to content

3.1. Google Java Format 적용

모든 Java 소스코드는 Google Java Format을 통해 포매팅해야 합니다. 수동 포매팅은 허용하지 않으며, 도구를 통한 자동 포매팅만 인정합니다.

3.1.1. VSCode 확장 설정

google-java-format-for-vs-code 확장을 설치하고, .vscode/settings.json에 다음을 포함합니다.

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

3.1.2. Maven 플러그인 설정

빌드 시 포맷 검증을 자동화하기 위해 spotless-maven-plugin을 사용합니다.

xml
<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 파이프라인에서 다음 명령으로 포맷 위반을 검출합니다.

bash
mvn spotless:check

포맷 위반이 발견되면 빌드가 실패합니다. 로컬에서 자동 수정하려면 다음을 실행합니다.

bash
mvn spotless:apply

TIENIPIA QUALIFIED STANDARD