[Spring] checkstyle 적용하기

📒 왜?

◼ 팀프로젝트를 진행하면서, 코딩 컨벤션을 구성하고 잘 지키는 것이 협업의 기본이라고 생각한다.

◼ 코드 리뷰 시, 통일된 코드 구성의 가독성과 로직 이해에 도움이 될 것 같아서 lint 설정을 알아보게 되었다. 

 

💬 sonarlint vs checkstyle

sonarlint는 IDE 플러그인으로 코딩 컨벤션을 제공해 주기 때문에, 개인이 설정 파일을 설정해주어야 하고, 이러한 설정 파일을 팀원들과 공유하면서 사용해야 한다. 또한, 해당 방식은 코딩 컨벤션에 어긋난 상태로 pull-request를 등록해도 자동으로 merge를 강제할 수 있는 방법이 없다.

반면, checkstyle은 gradle build를 진행할 때, 등록한 코딩 컨벤션에 맞게 코딩 컨벤션을 체크할 수 있으며, 프로젝트에 파일을 등로록하기만 하면 코딩 컨벤션 공유가 완료된다. 또한, 코딩 컨벤션에 어긋났을 경우 pull-request의 merge를 자동으로 강제할 수 있다. 

 

💥 쉬운 코딩 컨벤션 공유와 코딩 컨벤션에 맞게 코드를 작성해야 pull-request의 merge를 진행할 수 있도록 강제할 수 있어 checkstyle을 프로젝트에 적용해보고자 한다.

---

📒 .editorconfig 파일 설정

◼ editorconfig는 여러 개발자가 하나의 프로젝트에서 작업을 진행할 때, 동일한 코드 스타일을 유지할 수 있도록 도와준다.

◼ 프로젝트 최상단에 .editorconfig라는 이름으로 저장하면 되고, IntelliJ는 별도의 플러그인 설치가 필요 없으며, 이클립스는 플러그인 설치가 추가로 요구된다.

💥 개인 IDE에 설정이 제각각으로 되어 있어도, .editorconfig 파일이 존재하면 해당 설정이 적용되어 코드 작성이 이루어진다.

✔ 다음은 가장 많이 사용되는 파일 설정이다.

root = true

[*]
# [encoding-utf8]
charset = utf-8

# [newline-lf]
end_of_line = lf

# [newline-eof]
insert_final_newline = true

[*.bat]
end_of_line = crlf

[*.java]
# [indentation-tab]
indent_style = tab

# [4-spaces-tab]
indent_size = 4
tab_width = 4

# [no-trailing-spaces]
trim_trailing_whitespace = true

[line-length-120]
max_line_length = 120

 

✔ 빌드 시, editorconfig 체크

plugins {
    id 'org.ec4j.editorconfig' version '0.0.3'
}

editorconfig {
    excludes = ['build']
}

check.dependsOn editorconfigCheck // checkstyle이 설정 되어 있을 시, editorconfigCheck 후 checkstyle 진행

◼ .editorconfig 파일만 존재한다면, IDE의 코드 스타일 설정이 .editorconfig 파일에 따라서 적용된다. gradle build 시, 별다른 체크는 하지 않는다.

◼ 위 코드를 build.gradle에 세팅하면, gradle build 시 editorconfig 규칙을 검사하고, checkstyle 규칙을 검사한다. 

---

📒 Spring 프로젝트에 Checkstyle 적용하기

✔ build.gradle 설정 추가

plugins {
    id 'java'
    id 'checkstyle'
}

checkstyle {
    maxWarnings = 0
    configFile = file("${rootDir}/config/naver-checkstyle-rules.xml")
    configProperties = ["suppressionFile": "${rootDir}/config/naver-checkstyle-suppressions.xml"]
    toolVersion = "8.42"
}

compileJava.options.encoding = 'UTF-8'
compileTestJava.options.encoding = 'UTF-8'

 

✔ configFile, configProperties 파일 다운 받아 프로젝트에 추가

https://github.com/naver/hackday-conventions-java/tree/master/rule-config

GitHub - naver/hackday-conventions-java: 캠퍼스 핵데이 Java 코딩 컨벤션

◼ 위 링크에서 naver-checkstyle-rules.xml 파일과 naver-checkstyle-suppressions.xml 파일을 다운로드한다. 

◼ 위 링크에서 다운 받은 코딩 컨벤션은 네이버 캠퍼스 핵데이 Java 코딩 컨벤션에 따른다.

 

◼ 위와 같이 루트 프로젝트/config 폴더 아래 다운로드한 xml 파일을 넣는다.

 

◼ 인텔리제이 CheckStyle-IDEA 플러그인을 설치한다.

 

 

◼ Settings -> Checkstyle로 이동하여 위와 같이 설정한다.

◼ Checkstyle version은 최신 버전이며, test 포함하여 모든 파일을 체크하고 체크 스타일 위반 시 warning으로 띄어 준다.

 

◼ 위 설정과 이어서, Configuration File의 + 버튼을 누른 뒤, Description 설정, 이전에 받았던 naver-checkstyle-rules.xml 파일을 설정한다.

 

◼ Next를 누르면 위와 같은 창이 뜨고, 프로퍼티 설정의 Value 부분을 이전에 받았던 naver-checkstyle-suppressions.xml로 작성한다. 해당 부분을 작성하지 않으면, naver-checkstyle-rules.xml 파일의 변수 값으로 들어가지 않아 에러가 발생한다.

 

◼ 만들어진 Configuration을 Active하고 완료한다.

 

 

◼ 인텔리제이 하단을 보면 CheckStyle 탭이 있고, 해당 부분을 클릭하면 위와 같이 나온다.

◼ Rules를 이전에 설정했던 파일로 맞춰주고, 왼쪽에 Start 아이콘을 클릭하면 CheckStyle이 진행된다.

 

💬 위의 인텔리제이 설정은 안해도 터미널에서 ./gradlew clean build 시 CheckStyle이 진행되고 잘못된 부분이 있으면 build가 실패된다.

 

✔ 인텔리제이에서 파일 Save 시, 컨벤션에 맞게 코드 변경하기

◼ Editor -> Code Style -> Java에서 IntelliJ IDEA code style XML을 클릭한다.

 

◼ 위 깃허브 링크에서 naver-intellij-formatter.xml 파일을 다운로드한 뒤 설정한다.

 

◼ Save Actions 플러그인을 설치한다.

 

◼ Settings -> Other Settings -> Save Actions에서 위와 같이 체크한다.

◼ 이렇게 설정하면, 코드 작성 후 Save 시 컨벤션에 맞게 코드가 변경된다.

 

✔ 프로젝트에서 컨벤션에 맞게 한 번에 코드 변경시키기

◼ 루트 프로젝트 우클릭 후, Reformat Code를 선택한다.

 

◼ Optimize imports를 선택하고 Run을 누르면 컨벤션에 맞게 프로젝트 내, 모든 코드가 변경된다.

---

📒 .gitattributes 파일 설정

* text=auto

*.png binary
*.jpg binary
*.jpeg binary
*.gif binary
*.bat text merge=union eol=crlf

◼ .gitattributes 설정을 통해 git 저장 시, 텍스트 및 지정 파일의 형식을 알맞게 자동으로 변경하자.

💬 LF와 CRLF 차이점

◼ LF(Line Feed)는 줄 바꿈에 있어, 커서의 위치 이동은 제외하고, 줄 바꿈만 되는 문자이다.

◼ CRLF(Carriage Return Line Feed)는 커서의 위치 이동과 줄 바꿈이 합쳐져서 시행되는 문자이다.

💥 CRLF는 Windows에서 LF는 Unix 계열에서 기본 개행 문자로 사용한다.

 

 

 

 

✨ Reference

https://creampuffy.tistory.com/128