소프트웨어 개발 프로젝트를 팀 단위로하게 되면 공통의 코드를 여러 사람이 개발하게 된다. 여러 개발자가 동일한 코드를 다룰 때, 코딩 컨벤션을 맞춰야한다. 코딩 컨벤션은 코딩 스타일에 대한 규약으로 소스코드를 일관된 스타일로 유지시켜 코드의 가독성을 높이기 위해 필요하다.
만약 코딩 컨벤션이 없다면 코드를 작성하는 프로그래머는 각자 자신의 스타일대로 코드를 작성하게 된다. 이럴 경우 소스코드의 부분마다 서로 다른 스타일의 코드가 모여있게 되고, 코드에 일관성이 없어져 가독성이 크게 저하된다. 이렇게 떨어진 가독성은 프로그램의 흐름을 이해하는데 어려움을 만들어내고 결국에는 버그가 생기기도 한다.
따라서 개발 팀원들은 코딩 스타일에 대한 합의를 하고 코딩 컨벤션에 대한 문서나 IDE의 코딩 스타일로 등록해둘 필요가 있다.
인텔리제이에서는 'CheckStyle-IDEA' 플러그인을 통해 코딩 스타일을 설정하고 체크할 수 있다.
목차
CheckStyle-IDEA 플러그인 설치
Settings > Plugins에서 CheckStyle-IDEA를 검색해 설치하자.
플러그인 설치가 완료되면 'Restart IDE' 버튼이 나타나고 인텔리제이를 재시작해야한다.
CheckStyle-IDEA 플러그인 설정
Settings > Tools > Checkstyle 메뉴를 따라가면 CheckStyle-IDEA 플러그인의 설정을 확인 및 변경할 수 있다.
현재 사용중인 CheckStyle 플러그인의 버전을 확인할 수 있다. 코딩 스타일 체크를 수행할 스캔 범위를 지정할 수 있는데, 테스트 케이스를 포함하거나 포함하지 않을 수 있다.
기본적으로 Sun Checks, Google Checks가 번들로 포함되어 있다. 이 두 코딩 컨벤션 이외에 별도의 코딩 스타일이 존재한다면 “Configuration File”에서 (+) 기호를 클릭해서 추가해주면 된다.
사용법 - 현재 파일, 모듈, 프로젝트 검사하기
별도의 스타일을 설정하는 방법에 대해서는 나중에 알아보고, CheckStyle 플러그인 사용법을 알아보자.
인텔리제이의 New UI를 사용하고 있는 모습이다. CheckStyle이 설치되면 인텔리제이의 기능 탭에 연필 모양 아이콘의 탭이 추가된다. 만약 이 아이콘이 보이지 않는다면, View > Tool Windows > CheckStyle 메뉴를 선택하자. Rules 옆에 있는 드랍 다운을 선택하면 어떤 스타일을 체크할지 고를 수 있다.
CheckStyle 탭에서 재생 모양의 녹색 버튼을 누르면 현재 활성화되어 있는 파일에 대한 스타일 체크를 한다.
그러면 이렇게 소스코드에 대한 스타일 체크 결과를 보여준다. (테스트용 코드는 Apache/Haddop의 소스코드 일부를 사용했다)
녹색 재생 버튼 아래에 있는 버튼은 모듈에 대한 스타일 체크를 진행하는 버튼이고, 그 아래에는 프로젝트 레벨에서 스타일을 체크하는 버튼이다. 프로젝트 레벨에서 스타일을 진행하면 시간이 오래걸리고 종종 인텔리제이가 뻗어버리기도 한다.;;;
그 아래에는 모든 수정된 파일들에 대해 스타일 체크를 진행하라는 버튼도 있다. 수정된 파일이 없으면 활성화되지 않는다.
체크를 진행하면 텍스틑 에디터에 스타일에 위배되는 코드 부분이 표시되고, 마우스를 가져가면 어떤 점이 잘못되었는지 알려준다.
코딩 스타일을 참고만 하고 싶은 경우 Settings > Editor > Inspections 에서 Checkstyle > Checkstyle real-tirr 를 체크해제해주면 된다. 이렇게 설정해두면 소스코드 에디터에서는 하이라이트 되지 않는다. (그렇지만 여전히 스타일 체크 기능으로는 검사가 가능하다)
사용법 - 커밋할 때 검사하기
가장 좋은 사용법은 소스코드를 고치고 커밋하기 전에 코딩 컨벤션에 어긋나는 내용이 있는지 확인해주는 것이다.
인텔리제이의 커밋 탭의 옵션을 선택하면 “Scan with Checkstyle”이라는 항목을 찾아볼 수 있다. 이를 선택하면 커밋할 때 파일의 스타일을 체크해준다.
댓글