세상에는 많은 자바프로그래머들이 Eclipse 라는 훌륭한 툴을 이용.. 보다 더 간편하게.
더 깔끔하게 프로젝트를 완수하고 있는 실정이다.
이 휼륭한 툴에 보다 많은 기능을 추가해주는 Plug-In이라는 기능은 다들 알고 있을거라 생각

이 카테고리에서는 내가 써본..플러그인..중..쓸만한 녀석들에 대해 애기하면서..
처음 소개할 녀석은..

Checkstyle

그 단어 뜻 그대로. 스타일체크 를 자동으로 해주는 훌륭한 플러그인..
프로젝트 완료후..유지보수시 많은 여러가지 문제가 있지만.. 그 문제중 하나
프로그래머들이 여러명이니,, 각각 프로그래머의 취향? 에 따라.
변수명 , 메소드명 작성법 등이 다른관계로..많은 문제가 발생한다.
그동안 모. 헝가리안 표기법 이라던지..
프로젝트 시작전..책1권 분량의  코드명명법 을 읽어보고 작업에 들어간다.

 물론 프로젝트 초창기에는 이러한 코드명명규칙 이 잘 지켜지지만 ,
세상일은 그렇게 쉽게 되지는 않는 법 ㅡㅡ 빠듯한 일정에 쫓겨가다 보면,
이런 명명규칙 지키는것은 쉽지 않다.. <- 암울한 현실

그래서 어느 훌륭한 사람이 만들어낸 것이 바로 이 Checkstyle
홈페이지 가보면 알겠지만..꼭 플러그인 형태로 ,
꼭..이클립스뿐만 아니라
Borland JBuilder , NetBeans 등의 다른 IDE Tool부터
Maven 같은 Build tools 까지 ~
입맛대로 고르는 재미도 있다 >.<;

중요한것은..이클립스에 쓰는것이니깐..

일단 다운로드 해보자.

Eclipse Plug-In Download

이클립스 자체 업데이트 기능을 써도 당연히 된다ㅡㅡ;

 2006.09.28 일 조사? 결과
최신 버전은 4.12 인듯 하지만 플러그인 버전은  4.11 인듯한데..
모 ㅡㅡ 크게 문제 없을듯.
이클립스 관련 플러그인 홈페이지는 여기.



홈페이지에 정말..자세히..친절하게 쓰여 있다는 ㅡ.ㅡ;
그래도..귀차니즘과..영어의 압박도..있으니깐.. 간단하게 사용해봅시다 ..

이 밑에 부터는..안봐도..상관없을까나...
--------------------------------------------------------------------------------------------------

그림이 잘 안보이면 클릭해서 보는 센스 필요

플러그인 설치 후
일단...적용할 프로젝트를 하나 만들어 보자..


만든프로젝트에..

불성실한 이름으로 클래스 , 변수 , 메서드를 만들어 보자;

아무..문제도 없는 클래스..파일.
그러나..변수명도..그냥  AA 이고 , 메소드명도..보통은 소문자 를 쓴다..( <- 나는 소문자로 쓴다. )

여기에 스타일체크 를 적용 해보자

적용 시에는 PackageExplorer 에서 해당 프로젝트에서 마우스 오른쪽 클릭
Propertites 클릭해서 하면 된다

CheckStyle active for this project 라는 항목을 체크해야지만 적용된다
기본적으로 Sun Check(Global) 라는 환경파일 이 제공되면..이 설정파일을 적용해보자!

멀쩡하던 소스에 Warning 이 무려9개나..
본인의 컴터가 일본어 인 관계로 ㅡㅡ;  일본어로 나오는듯;

암튼..간다니 설명하면 Javadoc 코멘트 없음;
메소드명 경고, 변수명 경고등..
다양하게 나온다.

그러면..이런 명명규칙을 만들어보자!! ..쿠쿵

Windows->Preference 이동
Checkstyple 탭에서 New 를 클릭!

여러타입이 있지만..여기서는 간단하게 Internnal Configuration  으로 생성.

 
 만들어진..설정 파일..음..아무것도 적용된것이 없으므로..
이녀석을 다시 프로젝트에 적용해봤자..아무 소용 없는것은 당연한 일!!

설정파일 을 설정으로 고고!!

만든 설정화일을 클릭후  Configure 클릭하면 다음과 같은 화면이 보일것이다.
우선 보아야 할것은 가장 왼쪽탭 Known modules  보면 알겠지만,
여러가지 상황? 에 따라..분류되어 있다. 그중 일단 보아야 할것은 ,

Naming Convertions

클래스 이름 , 로컬변수 이름등에 관한 환경을 설정할수 있다.
그중에서 멤버변수 에 관해서 한번 수정해 보겠다.

Naming Convertions -> Member Names 더블클릭



 위에 그림과 같이 Member Names(지역변수) 에 대한 명명규칙을 정할수 있다.
Comment 탭은..그냥 간단한 설명을 적을 수 있다. 
 <-- 처음에는 여기 Comment 탭에 적는 메세지가 경고로 나오는줄 알았다는..ㅡ.ㅡ;

 format 탭은 명명규칙에 대한 설정란이다
그 규칙은 정규식 으로 설정이 가능하다..( <- 오옷 훌륭해!! )

Properties 탭은 좀더 세부적으로 이 명명규칙 을 어는 멤버 변수 에 적용할것인가..라는 항목이다
예를들면 private 멤버변수는 무조건 소문자 , public 멤버변수는 무조건 대문자 이런식으로도 설정가능하다는 말!
물론 이럴경우 설정을 따로 한번 더 해주어야 한다.
그리고 가장 멋진 기능은 Severity 레벨설정 기능
보는것첨 4가지를 지원하며 디폴트로 waring 으로 되어 있다.
보통 프로젝트 에서도 다들 waring 로 쓸듯하다..
그런데 이 Severity 레벨을 error 로 설정하는 경우에는..
컴파일이 되지 않도록 가능하다.. (waring 말그대로 경고..컴파일 , 실행에는 문제없음 );

규칙을 지키는 않는 코딩은 컴파일 자격도 없다!

일단.. waring 으로 하고.정규식도..디폴트 정규식을 사용하자 ㅡ.ㅡ;
정규식에 대해서는..다들..안다고 믿고...패스.. 나도..잘 --;
일단 위의 정규식은 첫문자를 a-z 즉 소문자로 시작하고
다음 문자는 a-z A-Z 그리고 0-9 까지의 숫자만 허용하겠다는 뜻이다.


이제 하나 만들어 보았으니..OK 버튼을 누르면 이것을 적용할것이라고
친절하게 물어보며  OK 라고 하면 친절하게 다시 컴파일을 한다.


멤버변수 명이 AA 즉..처음문자가 대문자로 만들었기 때문에 Waring  메세지가 뜬다.
물론 자바Doc , 메소드 명관련 경고가 뜨지 않는다..아직 적용 안했기..때문;
명명규칙에 따라서 만들어보자
strName 으로 ㅡ.ㅡ;
다음은 실행결과


경고없는 완벽한(?) 클래스 파일이 생성되었다.

한번쯤 테스트해봐야 할것

Severity 레벨을 error  로 바꾸어서 테스트 해보자..
정말 컴파일 안되는가 ㅡㅡ;
하는 방법은 위에 다 있기 때문에 생략..하고
한번 하는것이 도움이 되는것은 당연할듯.

정리

혼자하는 프로그램이 아닌이상.. 클래스 , 변수 , 메소드 에 대한 명명 규칙은
프로젝트 수행시에 반듯이 필요한 것이다. 이런한 명명규칙을..
보다 효율적으로 관리, 지원해주는 Checkstyle 은 참으로..고맙고..
유용한 유틸리티 가 아닐런지..
한번 만들어놓은..설정파일을 두고두고..써먹을수도 있으니..얼마나 좋은가!
기본적으로 지원하는 Sun Checks 설정파일만 써도 충분할듯 하지만..
고객의 요구에 따라 뭐든지 해야되는것이 우리 프로그래머의 숙명이니깐...
한번쯤..설정파일 건드려 보는것도 좋을듯!