sonarlint, klint, checkstyle과 같은 것들이 있으나 해당 글에서는 자바 위주의 정적분석 , lint 도구 중에서 checkstyle에 대해 기술해보려고 합니다.
이는 gradle을 통해 설정해줄 수 있으며 파일설정에서 config 디렉토리에 xml파일을 추가하고 주로 많이 활용하는 구글 java 컨벤션을 사용하여 indent는 2나 4로- 팀마다 다른 환경 적용
적용하겠습니다.
체크스타일에 대한 xml 파일을 통해
예를 들자면 google-check.xml
메소드명, 클래스명, import 순서나 지정하고자 하는 많은 내용을 컨벤션으로 지정할 수 있으며
한글 메소드 명이나 라인 길이, import 순서등을 지정하는 부분에서 컨벤션을 적절히 지정하거나, 지정해주지 않는 것을 선택해야 합니다.
파일 끝의 개행, 2줄이상 공백라인 금지등도 추가의 예가 될 수 있습니다.
intelij의 preferences의 코드스타일, java에서
default대신 해당 xml파일을 설정할 수 있으며
./gradlew 로 빌드 나 사이드바의 check메소드의 실행을 통해 적용을 테스트해볼 수 있습니다.
이전 회사에서는 pre-commit이나 git action, 혹은 코틀린의 경우는 lint를 적용해서 PR전 린트를 적용하는 것을 팀내에서 권장하도록 하였는데
팀의 규모나 환경에 따라 적절히 선택하면 될 부분일 것 같습니다.
'Java' 카테고리의 다른 글
| 자바 record란 (0) | 2024.07.08 |
|---|