코드의 품질을 높이기 위해서 많이 사용되는 것이 코드에 대한 정적분석을 통해서 코드의 품질을 평가하는 것이다.

코드정적분석에 사용되는 도구로는 checkstyle, findbugs, PMD 등 이 있다. 그레들gradle에 checkstyle, PM 를 추가하는 방법을 설명한다.

1. checkstyle

1.1. 사용방법

1.1.1. gradle's checkstyle 플러그인 추가

apply plugind: 'checkstyle'

build.gradle 파일에 플러그인을 추가한다.

1.1.2. checkstyle.xml 작성

1.1.3. build.gradle 파일에 checkstyle 태스크를 정의한다.

checkstyle {
  ignoreFailures = true // 분석결과 예외가 발생하면 빌드실패 발생시키는 것을 제외
    configFile = file("checkstyle.xml") // 1.1.2 에서 작성한 checkstyle 파일 지정
    reportsDir = file("${buildDir}/checkstyle-output") // 리포트 파일이 위치할 디렉토리 지정
}
 
checkstyleMain {
    reports {
        xml.destination = file("${checkstyle.reportsDir}/checkstyle-report.xml") // 리포트 파일의 위치 및 파일명 지정
    }
}

1.1.4. checkstyle 실행

$ gradle check

checkstyle 플러그인을 추가하면 그레들의 check 태스크를 수정하여 checkstyle 의 checkstyleMain, checkstyleTest 들을 실행시킨다.

1.2. 태스크Tasks

Task nameDepends onTypeDescription
checkstyleMainclassesCheckstyleRuns Checkstyle against the production Java source files.
checkstyleTesttestClassesCheckstyleRuns Checkstyle against the test Java source files.
checkstyleSourceSetsourceSetClassesCheckstyleRuns Checkstyle against the given source set's Java source files.

1.3. checkstyle.xml 기본구조

<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
          "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
          "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
 
<module name="Checker">
    <property name="charset" value="UTF-8" />
    <property name="severity" value="warning" />
    <property name="fileExtensions" value="java, properties, xml" />
 
    <module name="TreeWalker">
        <!-- 사용되는 모듈과 모듈속성을 정의-->
    </module>
</module>

2. PMD

2.1. 사용방법

2.1.1. gradle's pmd 플러그인 추가

apply plugind: 'pmd'

build.gradle 파일에 플러그인을 추가한다.

2.1.2. pmd 태스크의 속성을 정의한다.

pmd {
  ignoreFailures = true // 분석결과 예외가 발생하면 빌드실패 발생시키는 것을 제외
    reportsDir = file("${buildDir}/pmd-output")
}
 
pmdMain {
    reports {
        xml.destination = file("${pmd.reportsDir}/pmd-report.xml")
        xml.enabled = true
    }
}

2.1.3. 실행

$ gradle check

PMD 플러그인이 check 태스크에 의존성을 추가한다.

2.2. 태스크Tasks

태스크명의존유형설명
pmdMain-Pmd출시 소스파일을 대상으로 PMD 실행
pmdTest-Pmd테스트 소스파일을 대상으로 PMD 실행
pmdSourceSet-Pmd지정된 소스셋SourceSet을 대상으로 PMD 실행

3. 정리

checkstyle과 pmd 에서 생성한 XML 보고서는 JENKINS에서 사용하기 위한 분석데이터로 사용된다.

JENKINS에서 checkstyle, pmd 플러그인을 설치한 후 report.xml 경로를 지정한 후



빌드가 정상적으로 진행되면서 분석문서가 생기면 다음과 같은 항목들이 왼쪽 메뉴에 추가가 되고,



각각의 결과를 확인할 수 있다.




○ 참고문헌


스프링 등 다양한 라이브러리에서 Groovy DSL을 지원하고, 그레들gradle 사용도 늘어나면서 그루비Groovy(http://groovy.codehaus.org/)를 학습해야겠다는 생각에 프로젝트를 생성했다.

  • rocking-the-groovy - github
    gradle init --type groovy-library
    
    로 생성한 프로젝트를 이클립스에 import 하고 실행하려고 해도 정상적으로 인식이 안되는 문제에 봉착했다(지금 생각하면 매우 간단한 문제였는데… 역시 기초는 중요하다).

수동으로 환경설정을 하면 어찌어찌 실행할 수 있게 되기는 했는데 왜 그랬는지 풀 수 있는 방법을 알고 싶었다.

그러다가 문득…

‘eclipse’ 플러그인을 넣었던가?

하는 생각이 스쳐지나간다. .gitignore 내에는 이클립스와 인텔리제이에서 생성하는 생성물들에 대한 목록은 추가시켜놓고, 정작 build.gradle 에다가 이클립스 플러그인을 넣었던가? ㅡ_-)?


아니나 다를까…
추가하고 다시 프로젝트를 임포트 하니 정상적으로 동작한다.
하아. 머리가 나쁘면 몸이 고생한다더니...

Class 파일로 컴파일된 자바 클래스파일을 다시 소스 파일로 만들어주는 프로그램.

원본 소스와 똑같이 만들어주지는 못하지만, 같은 기능을 구현하는 소스로 구성을 해준다.

 

관련링크 : http://en.wikipedia.org/wiki/JAD(JAva_Decompiler)

관련링크 : http://www.varaneckas.com/jad

Jad 다운로드

관련링크 : http://jadclipse.sourceforge.net/wiki/index.php/Main_Page

JadClipse for Eclipse plugin

관련링크 : http://blog.bagesoft.com/954

Java Decomplier JAD와 JadEclipse 설치 및 활용하기

 

괜찮다~ >ㅅ<)

이 글은 스프링노트에서 작성되었습니다.

작성자 : 김지헌

작성일 : 2009. 11. 29.

 

Windows 시스템에서 Android SDK 설치하는 과정을 설명하도록 하겠다.

  1. http://developer.android.com/sdk/index.html

    android_sdk_r3-windows.zip 다운로드하기

    android_sdk_01.png

     

  2. android_sdk_r3-windwos.zip 을 특정 위치에서 압축을 푼다.
    android_sdk_02.png

    폴더 내에 보이는 SDK Setup는 안드로이드 SDK와 AVM(안드로이드 가상머신)의 설정을 할 수 있도록 해주는 프로그램이다.

    예 : C:\Program Files 폴더 안에

    C:\Program Files\android-sdk-windows
    폴더로 압축을 해제했다.

     

  3. C:\Program Files\android-sdk-windows 경로를 컴퓨터에서 Path로 설정해주어야 한다.

    C:\Program Files\android-sdk-windows\tools 를 컴퓨터의 Path 마지막에 추가해주어야 한다.

    android_sdk_03.png

    내 컴퓨터 -> 속성 -> 고급 -> 환경변수 -> Path 항목에 C:\Program Files\android-sdk-windows\tools 을 추가한다.

     

  4. http://honeydeveloper.springnote.com/pages/4429375 를 참조하여 Eclipse 에 ADT plug-in을 설치한다.

    android_sdk_04.png

     

  5. Develop tools에 체크를 하고 플러그인을 다운로드 받은 후 이클립스를 다시 시작한다.
  6. 이클립스가 실행되면 다음과 같은 창이 뜰 것이다. 환경설정에서 안드로이드와 관련된 설정을 하라는 내용이다.

    android_sdk_05.png

  7. Preferences -> Android 에서 SDK의 경로를 설정해줘야 한다. 아까 설치했던 경로를 결정한 후 Apply > OK를 누른다.

    android_sdk_06.png

  8. 그후 Windwo > Android SDK and AVM Manger를 선택한다. Available Packages 를 선택한다.

    android_sdk_07.png

    아래에 있는 항목들을 모두 체크하거나, 필요에 따라서 개별적으로 선택을 한다.

  9. Accept All 을 선택하고 Install Accepted를 클릭하여 다운로드를 진행하도록 한다.

    android_sdk_08.png

    android_sdk_09.png

    다운로드가 진행되고 있다.

  10. 다운로드가 완료되면 , Virtual Devices 에서 [New...] 버튼을 클릭한 후에 사용하려고 하는 AVD를 설정해서 생성을 해주면 되겠다.

    android_sdk_11.png

  11. 그런 후에 이클립스에서 Android Project를 생성해주면 안드로이드 애플리케이션을 개발하기 위한 환경을 구축하는 과정은 끝이난다.

이 글은 스프링노트에서 작성되었습니다.

가끔 쌩뚱맞게 개발환경을 처음부터 다시 설치해야 할때가 있습니다. 아름아름 찾아서 각각 다운받아서 설치하는데, 플러그인 설치시 이클립스가 버전업 되면서 해당 URL로 바뀌는 경우가 있는데, 이를 하나 하나 찾아다니기 귀찮아서 여기에 백업용으로 기록합니다.

아래는 이번에 새로 설치할때 설치한 플러그인 환경 입니다. 플러그인 설치 순서는 차례대로 하는것이 충돌 또는 선 요구사항 플러그인 규칙에 어긋나지 않습니다.  베스트한 케이스는 아니고, 그냥 무난히 쓰는 정도인데, 추가적인 것들은 그때 그때 프로젝트 마다 필요할때마다 설치하곤 합니다.
기타 프로젝트 옵션으로 Trac 관련된 플러그인을 설치 했습니다.


이렇게 설치된 이클립스 로드 속도 정말 빠릅니다. 아마도 링크된 프로젝트가 없기 때문인듯 합니다. 아무튼 깨끗한 상태에서 다시 시작한다는 마음으로 시작하는것 같아서 좋습니다. ^^*




+ Recent posts