Profile

Google Java Style Guide

1. Google Java Style Guide 적용

Google Java Style Guide는 Google에서 제공하는 Java 코드 스타일 가이드로, 많은 개발자와 팀에서 널리 사용됩니다. IntelliJ IDEA에서 Google Java Style Guide를 적용하는 방법은 다음과 같습니다.

2. IntelliJ IDEA에 Google Java Style Guide 적용

  1. Google Java Style Guide XML 다운로드

    먼저 Google Java Style Guide XML 파일을 다운로드해야 합니다. Google Java Style Guide XML 링크를 클릭하여 XML 파일을 다운로드하세요.

  2. IntelliJ IDEA 설정

    IntelliJ IDEA에서 Google Java Style Guide를 적용하려면 다음 단계를 따릅니다.

    • File > Settings (macOS는 IntelliJ IDEA > Preferences)로 이동합니다.

    • Editor > Code Style > Java를 선택합니다.

    • 오른쪽 상단의 Scheme 드롭다운 메뉴에서 Import Scheme을 선택하고 IntelliJ IDEA code style XML을 선택합니다.

    • 다운로드한 Google Java Style Guide XML 파일을 선택하여 불러옵니다.

    • Scheme 이름을 적절히 지정하고 OK를 클릭합니다.

  3. 자동 포맷팅 설정

    저장할 때 자동으로 코드 포맷팅을 적용하려면 다음 단계를 따릅니다.

    • File > Settings (macOS는 IntelliJ IDEA > Preferences)로 이동합니다.

    • Tools > Actions on Save로 이동합니다.

    • Reformat code 옵션을 체크합니다.

    • Optimize imports 옵션도 체크하여 불필요한 import 문을 자동으로 제거할 수 있습니다.

3. 구체적인 코드 스타일 설정

Google Java Style Guide를 적용한 후에도 특정 설정을 커스터마이즈할 수 있습니다. 예를 들어, 다음과 같은 설정을 확인하고 필요에 따라 조정할 수 있습니다.

  • Line Length: 한 줄의 최대 길이를 설정합니다. 기본값은 100자입니다.

  • Indentation: 들여쓰기 수준을 설정합니다. 기본값은 2입니다.

  • Blank Lines: 클래스, 메서드, 필드 간의 빈 줄 수를 설정합니다.

이와 같은 설정은 Editor > Code Style > Java에서 각각의 탭 (Tabs and Indents, Wrapping and Braces, Blank Lines 등)을 통해 설정할 수 있습니다.

4. 체크스타일 플러그인 사용

코드 스타일을 자동으로 검사하고 규칙을 준수하도록 돕기 위해 IntelliJ IDEA에서 Checkstyle 플러그인을 사용할 수 있습니다. Checkstyle은 코드 스타일을 자동으로 검토하고 위반 사항을 알려주는 도구입니다.

  1. Checkstyle 플러그인 설치

    • File > Settings (macOS는 IntelliJ IDEA > Preferences)로 이동합니다.

    • Plugins를 선택하고 Marketplace 탭에서 Checkstyle-IDEA를 검색하여 설치합니다.

    • IntelliJ IDEA를 재시작합니다.

  2. Checkstyle 설정

    • File > Settings (macOS는 IntelliJ IDEA > Preferences)로 이동합니다.

    • Tools > Checkstyle을 선택합니다.

    • Configuration File 섹션에서 + 버튼을 클릭하고 Use a local Checkstyle file을 선택합니다.

    • Google Checkstyle XML 파일을 다운로드하여 설정합니다.

5. Prettier와 ESLint와 유사한 포맷팅 도구

JavaScript/TypeScript에서 널리 사용되는 Prettier와 ESLint와 유사하게 Java에서는 Spotless와 Checkstyle을 사용할 수 있습니다.

  • Spotless: 코드 포맷팅을 자동화하는 도구로 Gradle 및 Maven에서 사용할 수 있습니다.

  • Checkstyle: 코드 스타일 검사를 수행하는 도구로, 위반 사항을 알려줍니다.

PreviousJava LibrariesNextCloud

Last updated