IntelliJ CheckStyle 설정 가이드: Google Style Formatter로 코드 품질 높이기

작성자:

혼자 코딩할 때는 크게 신경 쓰지 않았던 문제들이 팀 프로젝트를 시작하면 수면 위로 떠오릅니다. 그중 가장 대표적인 것이 바로 ‘코드 스타일’입니다. 괄호의 위치, 들여쓰기 간격, Import 순서 등 사소해 보이는 차이가 코드 리뷰 시간을 잡아먹고 가독성을 떨어뜨리는 주범이 되곤 합니다.

오늘은 Java 개발자들이 가장 많이 사용하는 IDE인 Intellij IDEA에서 IntelliJ CheckStyle 설정과 Google Style Formatter를 적용하여, 팀원 모두가 숨 쉬듯 자연스럽게 코드 컨벤션을 지키는 환경을 만드는 방법을 상세히 알아보겠습니다.

왜 CheckStyle과 Google Style을 사용해야 할까요?

설정 방법에 앞서, 왜 이 귀찮은(?) 작업을 해야 하는지 짚고 넘어가겠습니다. 단순히 “보기에 좋아서”만은 아닙니다.

  1. 일관된 코드 품질 유지: Google Style Formatter를 사용하면 누가 작성했든 마치 한 사람이 짠 코드처럼 통일감을 줍니다.
  2. 오류 사전 방지: CheckStyle 플러그인은 코드가 컴파일되기 전에 스타일 오류를 실시간으로 잡아줍니다.
  3. 생산성 향상: 코드 리뷰 시간에 “여기 들여쓰기 안 맞네요” 같은 소모적인 논쟁 대신, 로직과 아키텍처에 집중할 수 있게 해 주어 개발 생산성을 높여줍니다.

1. IntelliJ IDEA에 CheckStyle 플러그인 설정하기

가장 먼저 할 일은 스타일 검사를 도와줄 CheckStyle-IDEA 플러그인을 설치하는 것입니다.

1.1. 플러그인 설치

  1. IntelliJ IDEA를 실행합니다.
  2. Windows/Linux: File → Settings, Mac: IntelliJ IDEA → Settings (단축키 Cmd + ,)로 진입합니다.
  3. 좌측 메뉴에서 Plugins(플러그인)을 선택합니다.
  4. 상단 탭을 Marketplace(마켓플레이스)**로 변경하고 검색창에 CheckStyle-IDEA를 입력합니다.
  5. 검색 결과에 나온 플러그인의 Install(설치) 버튼을 클릭합니다.
  6. 설치가 완료되면 Restart IDE(재시작) 버튼을 눌러 변경 사항을 반영합니다.

1.2. CheckStyle 세부 설정

플러그인이 설치되었다면, 이제 어떤 규칙으로 검사할지 알려줘야 합니다. 우리는 가장 널리 쓰이는 Google Style을 기준으로 설정하겠습니다.

  1. 설정 창(Settings)을 다시 엽니다.
  2. Tools(도구) → CheckStyle 메뉴로 이동합니다.
  3. Scan Scope(스캔 범위)를 Only Java Sources (including tests)로 변경합니다. 불필요한 파일까지 검사하는 것을 막아 속도를 높여줍니다.
  4. Configuration file(설정 파일) 목록에서 Google Checks 항목을 찾아 체크박스(Active)를 활성화합니다. (기본 내장되어 있어 별도 파일이 필요 없습니다.)

1.3. Git Commit 시 자동 검사 설정

코드를 커밋하기 전에 스타일 위반 사항이 있다면 커밋을 막아주는 안전장치를 걸어봅시다.

  1. 설정 창에서 Version Control(버전 관리) → Commit으로 이동합니다.
  2. Commit Checks 섹션에서 Scan with CheckStyle 옵션을 찾아 활성화합니다.
  3. 이제 컨벤션을 지키지 않은 코드는 커밋 단계에서 경고가 발생하여 실수를 원천 차단할 수 있습니다.

2. Google Style 기반 Formatter 설정하기

CheckStyle이 “틀린 그림 찾기”라면, Formatter는 “자동 정렬 기계”입니다. 코드를 저장할 때마다 자동으로 Google Style에 맞춰 정렬되도록 설정해 보겠습니다.

2.1. Formatter 설정 파일 준비

먼저 Google에서 제공하는 공식 스타일 정의 파일이 필요합니다.

2.2. IntelliJ에 설정 파일 가져오기

  1. 설정 창(Settings)에서 Editor(편집기) → Code Style(코드 스타일) → Java로 이동합니다.
  2. 설정 창 상단의 Scheme 옆에 있는 톱니바퀴 아이콘(설정)을 클릭합니다.
  3. Import Scheme(구성 가져오기) → Intellij IDEA Code Style XML을 선택합니다.
  4. 방금 다운로드한 intellij-java-google-style.xml 파일을 선택하고 OK를 누릅니다.
  5. Scheme 이름(예: GoogleStyle)을 확인하고 적용(Apply)합니다.

3. 저장 시 자동 포맷팅 (Actions on Save)

매번 단축키를 눌러 정렬하는 것은 번거롭습니다. 파일 저장(Ctrl + S 또는 Cmd + S)만 해도 알아서 정렬되도록 설정하는 것이 IntelliJ CheckStyle 설정의 화룡점정입니다.

  1. 설정 창에서 Tools(도구) → Actions on Save(저장 시 액션)로 이동합니다.
  2. 다음 두 가지 옵션을 반드시 체크합니다.
    • Reformat code (코드 서식 다시 지정): 줄 바꿈, 들여쓰기 등을 자동 교정합니다.
    • Optimize imports (Import문 최적화): 사용하지 않는 Import를 제거하고 순서를 정리합니다.

이렇게 설정해두면 코드를 작성하고 저장하는 순간, 마법처럼 코드가 깔끔하게 정리되는 것을 볼 수 있습니다.

4. 작업 중 유의사항 및 팁

이제 완벽한 환경이 구축되었습니다. 하지만 실제 개발 시 몇 가지 알아두면 좋은 점들이 있습니다.

  • 수동 포맷 단축키: 가끔 저장하기 전에 특정 파일만 즉시 정리하고 싶다면 포맷팅 단축키를 활용하세요.
    • Mac: Cmd + Opt + L
    • Windows: Ctrl + Alt + L
  • CheckStyle 에러 해결: 코드를 작성하다가 에디터 우측이나 하단에 빨간색 CheckStyle 경고가 뜬다면, 해당 부분에 마우스를 올려 어떤 규칙을 위반했는지 확인하고 수정하세요.
  • 팀 공유: 이 설정 과정이 복잡하다면, settings.zip으로 설정을 내보내어 팀원들에게 공유하는 것도 좋은 방법입니다.

마무리

지금까지 IntelliJ CheckStyle 설정과 Google Formatter를 통한 자동화 환경 구축 방법에 대해 알아보았습니다. 처음에는 설정 과정이 다소 번거롭게 느껴질 수 있지만, 한 번 세팅해 두면 프로젝트 내내 코드 리뷰 피로도가 확연히 줄어드는 것을 경험하실 수 있습니다.

댓글 남기기