ECLIPSE 에서 PMD 적용해보기

 

 

PMD란 : 정의된 규칙(Rule)을 기반으로 개발자가 작성한 소스 코드를 검사하여, 오류 및 위험 요인을 식별하여 알려 주는 기능을 제공한다.

 

위험이 있는 소스를 분석하기 위한 도구 PMD 입니다.

설치는 Help - Eclipse Marketplace 에서 pmd 로 검색하면 나오는 것중 eclipse-pmd 를 install 해줍니다~

 

아래의 경로에 설치방법을 따라서 설치 합니다~

 

그럼 소스분석사항인 룰셋을 pmd 에 적용해 보겠습니다.

 

전자정부프레임워크 표준 룰셋으로 하는것이 좋겠네요~

아래의 경로에 설명과 설치방법이 있으니 따라서 설치해 봅니다.

http://www.egovframe.go.kr/wiki/doku.php?id=egovframework:dev2:imp:inspection#전자정부_표준프레임워크_표준_inspection_룰셋_적용하기

 

첫번째로 위 URL 에 따라 룰셋 압축파일을 받아서 설치해 봅니다.(개발환경에 따라 파일을 받습니다.)

이클립스3.1 버전이니 2.7이상 버전을 받아봤습니다.

egovinspectionrules-2.7.zip

 

아래은 가이드에 나와있는 방식 입니다. pmd 설치 버전에 따라 조금 다를수 있습니다.

1. Window > Preferences

 

2. Preferences 창의 왼쪽 메뉴 구조에서, PMD > Rules Configuration 선택

 

3. Preferences 창에서, 오른쪽 중앙의 Clear all 버튼 클릭

 

4. PMD Confirmation 대화창에서, OK 버튼 클릭으로 모든 룰 삭제

 

5. PMD Plugin 대화창에서, Browse… 버튼을 클릭하여 앞서 압축해제한 룰셋 파일 중 한글판인  EgovInspectionRules_kor.xml 파일을 선택

(CSV 파일 REPORT 파일의 한글깨짐으로 EgovInspectionRules_eng.xml 파일로 다시 세팅 하였습니다~ 한글깨짐 해결방안은 찾아보아야 할듯 합니다. 해결하였습니다. 아래의 방법으로 하니 잘 되네요~)

!!!!! 위처럼 한글 csv 파일을 열었을경우 한글이 깨진다면 해결방법입니다. 이경우는 엑셀의 기본인코딩인 EUC-KR 이 아닌 UTF-8 파일인 경우에 깨져버린다고 합니다.

해결방법은 csv 확장자를 txt 로 바꾼후에 열게되면 인코딩과 열 구분자를 묻는 창이 나오고 창에서 인코딩을 UTF-8 로 선택하면 정상적으로 한글이 나옵니다~ 요건 이렇게 해결합니다.(엑셀프로그램을 먼져 실행하고 파일>열기 에서 열어줍니다)

 

6. Import by Copy 항목 선택하고 OK 버튼을 클릭

7. Preferences 창의 Rules 그리드 목록에서 방금 들여온 룰 확인

 

OK 버튼 클릭 설치 끝 입니다.^^

 

@ PMD 검사 시작

이제 소스에서 오른쪽 마우스 클릭해 보면 PMD > Check Code 를 실행합니다.

 

@ PMD 결과 Report 파일 다운로드

1. 이것을 Report 로 다운받으려면

Window > Preferences > PMD > Reports 에서 다운받을 형식을 선택합니다.(복수설정 가능)

 

2. 소스에서 오른쪽 마우스 클릭하여

PMD > Generate Reports 를 클릭해 줍니다~

 

@ 39개 룰셋 수정처리 가이드

아래의 URL 에서 어떻게 처리해야 하는지 확인하여 수정하여 줍니다~

http://www.egovframe.go.kr/wiki/doku.php?id=egovframework:dev2:imp:inspection:usetool#전자정부_표준_inspection_룰셋

 

reports 파일위치는 프로젝트 하위에 reports 밑에 생성됩니다.

 

 

 

캡처는 없습니다~  나중에 시간되면 캡처도 넣겠습니다~ 끝~