설명된 IDE는 Intellij IDEA이며, 코드 컨벤션 준수를 위해 CheckStyle 및 Google Style 기반 Formatter를 설정합니다.
아래는 설정 및 적용 방법에 대한 상세 가이드입니다.
사용하는 이유?
Google Style 기반 코드 컨벤션을 쉽게 준수할 수 있고, CheckStyle 플러그인으로 코드 스타일 오류를 사전에 방지하고, Google Style Formatter를 통해 일관된 코드 품질을 유지할 수 있음.
>>> 이를 통해 팀 내 개발 생산성과 코드 일관성을 동시에 확보할 수 있습니다.
1. Intellij IDEA에 CheckStyle 플러그인 설정
1.1. 플러그인 설치
1. Intellij IDEA를 실행합니다.
2. 상단 메뉴에서 Settings(설정) → **Plugins(플러그인)**으로 이동합니다.
3. 오른쪽 상단 Marketplace(마켓플레이스) 탭에서 CheckStyle-IDEA를 검색합니다.
4. Install(설치) 버튼을 클릭하여 설치합니다.
5. 설치 후 Restart IDE(재시작)를 선택하여 변경 사항을 반영합니다.
1.2. CheckStyle 플러그인 설정
1. 설정(Settings) → Tools(도구) → CheckStyle로 이동합니다.
2. 아래 항목을 설정합니다:
• Scan Scope(스캔 범위): Only Java Sources (including tests) 선택.
• Configuration file(설정 파일): Google Checks를 선택하고 활성화(체크)합니다.
1.3. Git Commit 시 CheckStyle 적용
1. Git 커밋 시 CheckStyle 스캔 결과를 확인하여 코드 컨벤션 위반 시 커밋이 차단되도록 설정합니다:
• 설정(Settings) → Version Control(버전 관리) → Commit로 이동합니다.
• Scan with CheckStyle 옵션을 활성화합니다.
2. Google Style 기반 Formatter 설정
2.1. Formatter 설정 파일 다운로드
1. Google Style Guide GitHub 저장소에서 intellij-java-google-style.xml 파일을 다운로드합니다.
2.2. Formatter 설정 파일 가져오기
1. 설정(Settings) → Editor(편집기) → Code Style(코드 스타일) → Java로 이동합니다.
2. 오른쪽 상단 설정 (톱니바퀴)를 클릭한 후, Import Scheme(구성 가져오기) → Intellij IDEA Code Style XML을 선택합니다.
3. 다운로드한 intellij-java-google-style.xml 파일을 가져옵니다.
2.3. Formatter 자동 적용
• 저장 시 코드 포맷이 자동으로 적용되도록 설정
1. 설정(Settings) → Tools(도구) → **Actions on Save(저장 시 액션)**로 이동합니다.
2. 아래 두 가지 옵션을 체크합니다:
• Reformat code(코드 서식 다시 지정)
• Optimize imports(Import문 최적화)
• 수동 포맷 단축키: 파일 단위로 포맷을 적용하려면 cmd + opt + L (Mac) 또는 ctrl + alt + L (Windows)를 사용하세요.
3. 작업 중 유의사항
• CheckStyle 및 Formatter를 통해 팀 컨벤션에 맞는 코드 스타일을 유지할 수 있습니다.
• 저장 시 포맷이 자동으로 적용되지 않을 경우, 수동 단축키를 사용하거나 설정을 다시 확인하세요.
• 커밋 시 코드 스캔에서 에러가 발생하면, 수정 후 다시 커밋을 시도하세요.
