API 개발 환경 설정

목적

• 코딩 컨벤션 통일
  • 가독성 향상으로 생산성 증가.

1. intellij formatter 적용

• formatter 다운로드
  • ooo formatter 파일 아래꺼 다운로드
  • • naver coding convention에서 아래 사항만 변경 또는 추가함.
      • 1) 포매팅 예외 파일 설정 : xml
      • 2) USE_TAB_CHARACTER 의 value를 false로 변경.
      • 3) RIGHT_MARGIN 을 120->160 으로 변경.
• Scheme 설정
  • InteliJ에서 File → Settings 메뉴를 연다. (Alt + Shift + S)
  • Editor → Code Style → Java 항목으로 이동한다.
  • Scheme 항목의 오른쪽에 있는 톱니바퀴 아이콘을 선택한다.
  • Import Scheme → InteliJ IDEA Code Style XML을 선택한다.
  • 다운로드한 naver_format.xml 파일을 선택한 후 OK 버튼을 누른다.
  • 그럼 To 항목에 이름을 정할 수 있는데, 디폴트 값으로 설정해도 상관 없지만, 포멧터를 커스터마이징 했거나 프로젝트마다 다른 포멧터 설정을 사용한다면 스키마의 이름을 유일성 있게 수정한다.
    • 이름은 아래 캡쳐 본 참고.

2 저장 시마다 코딩 컨벤션 자동 적용

1. File → Settings → Tools → Actions on Save 또는 Settings 검색창에 Save라고 검색해서 나온 항목을 선택한다.
2. 아래 3개옵션들을 체크합니다.
   1. Reformat code(저장 시 자동으로 포맷 적용)
   2. Optimize imports(저장 시 사용하지 않는 import 제거)
   3. Rearrange code(이 옵션은 코드의 구조를 더 읽기 쉽고 일관되게 만들기 위해 멤버 변수, 메소드 등을 지정된 규칙에 따라 재배치합니다.)를 체크한다.

3 Checkstyle 적용하기

Checkstyle이란 Java 소스 코드가 지정된 코딩 컨벤션을 준수하는지 확인하기 위한 정적 코드 분석 도구이다. 지정된 규칙에 어긋나는 경우 컴파일 시 경고나 에러를 띄워준다.

진행하기 전에 아래 링크에서 naver-checkstyle-rules.xml과 naver-checkstyle-suppressions.xml를 다운로드 한다.

https://github.com/naver/hackday-conventions-java/blob/master/rule-config/naver-checkstyle-rules.xml~~~~

1.2.1. 1. Checkstyle 플러그인 설치

1. File → Settings → Plugins 메뉴로 이동한다.
2. Marketplace에 CheckStyle을 검색하여 CheckStyle-IDEA 플러그인을 설치한다.
3. InteliJ를 재시작한다.

1.2.2. 2. Checkstyle 설정

1. File → Settings → Tools에서 Checkstyle 항목을 선택한다.
2. Scan scope를 All sources including tests로 설정한다.
3. Treat Checkstyle errors as warnings를 체크한다.
4. Configuration File에서 + 버튼을 클릭한다.
5. Description은 Naver Checkstyle Rules [버전] 으로 지정하는 것이 권장되지만 프로젝트별로 커스터마이징 했다면 프로젝트 이름 등을 붙인다.
6. Use a Local Checkstyle File을 선택하고 Browse 버튼을 눌러서 naver-checkstyle-rules.xml naver-checkstyle-rules_1.0.0.xml 를 지정하고 Next 버튼을 누른다.
7. suppressionFile 변수를 설정하라는 창이 뜨면 Value에 naver-checkstyle-suppressions.xml를 입력하고 Next 버튼을 누른다.
8. Naver Checkstyle Rules의 Active를 체크한다.

Ok 버튼을 눌러 설정을 완료하면, InteliJ 하단에 Check Style 탭이 생기고 좌측에서 Check Current File 또는 Check Module, Check Project 등을 선택하여 코딩 컨벤션 준수 여부를 확인할 수 있다.

변수명에 소문자 카멜 케이스를 적용해야 한다는 컨벤션을 지키지 않자 CheckStyle에서 경고를 띄워주는 모습을 확인할 수 있다.

4 커밋할 때 검사하기

왼쪽 사이드바 → commit 클릭 → 설정(톰니바퀴)선택 → 5개 옵션을 선택해둡니다.

참고자료

https://bestinu.tistory.com/64#article-1-2--checkstyle-%EC%A0%81%EC%9A%A9%ED%95%98%EA%B8%B0

https://hbase.tistory.com/443