코드 컨벤션 설정: Formatter, CheckStyle 적용(intelliJ)

미니 프로젝트를 하면서 코드를 깔끔하게 작성하고싶다는 생각을 했다.

여러가지 방법을 찾아보다가 코드 컨벤션과 관련해 formatter와 checkstyle을 적용할 수 있다는 것을 발견했다.

 

코드 컨벤션이란 소프트웨어 개발에서 사용되는 코드를 작성할 때 적용되는 일정한 규칙과 가이드라인을 말한다.

코드 가독성을 향상시키고 협업과 유지보수를 용이하게 하며, 일관성 있는 코드 작성을 돕는다.

코드 컨벤션은 팀 또는 프로젝트에 따라 달라질 수 있다.

 

그중 대표적으로 사용되는 자바 코드 컨벤션은 Google Java Style Guide 이다.

 

매번 코드 컨벤션 문서를 보고 해당 내용을 직접 적용하기에는 비효율적인 부분이 있다.

formatter와 checkstyle을 사용해 자동으로 코드 컨벤션을 적용할 수 있다.

1. Formatter  적용

formatter는 들여쓰기, 줄바꿈, 공백, 중괄호 위치 등 코드 레이아웃을 자동으로 재정렬해준다. 

 

먼저 google styleguide formatter(https://github.com/google/styleguide)를 다운받는다.

IntellliJ용 xml 파일을 사용하였다.

 

세팅 -> 에디터 -> 코드스타일 -> 구성표(Scheme)옆의 설정 버튼을 통해 해당 xml 파일을 선택한다.

이후 코드 정리를 하면 설정된 formatter의 형식으로 정리되는것을 확인할 수 있다.

2. CheckStyle 적용

체크스타일은 포맷터와 구분되며 코드 컨벤션을 준수하는지 확인(검사)해주는 플러그인이다.

 

설정의 플러그인에서 CheckStyle을 다운받고 설정할 스타일을 선택한다. 필요한 경우 추가할 수 있다.

 

CheckStyle은 크게 두가지 방법으로 사용할 수 있다. 현재 열린 파일을 바로 검사할 수도 있고 커밋할때 검사할수도 있다.

우선 현재 열려있는 파일에서 검사를 진행해보았다.

 

인텔리제이 하단부에서 CheckStyle을 선택하고 검사를 수행하면 스타일에 일치하지 않는 부분이 경고로 표시된다.

좌측의 재생 버튼을 누르면 검사가 수행된다.

현재 진행중인 솔로 프로젝트에서 검사를 수행하니 아래와 같이 한개의 경고가 나타났다.

해당 내용을 임시로 수정하고 다시 검사하니 경고가 사라진 것을 확인할 수 있었다.

 

위 두가지 방법을 적용하면 코드를 조금 더 일관성 있고 깔끔하게 작성할 수 있다.

 

참고자료

코드 컨벤션 설정 checkstyle과 formatter 깔끔하게 정리하기(feat. intelliJ)

[Intellij] google code 포매터 적용