API 분석 Ant 태스크

목적

이 태스크는 기준선에 상대적인 API 프로파일의 전체 API 분석을 실행합니다 - API 사용, 2진 호환성 및 번들 버전 번호 유효성 검증 포함. 프로파일은 개발 중인 제품의 현재 상태입니다. 프로파일은 2진 호환성(보통 제품의 이전 릴리스)을 위해 API 기준선과 비교됩니다.

2진 클래스 파일에서 모든 검증이 수행되면 태그 유효성 검증 @이후 분석은 포함하지 않습니다(소스가 분석되지 않습니다).

사용법

설명

Ant 태스크의 이름은 apitooling.analysis입니다. 사용하려면 jar 파일 apitooling-ant.jar이 Ant 클래스 경로에 있어야 합니다.

<apitooling.analysis
	baseline="..."
	profile="..."
	report="..."
	filters="..."
	excludelist="..."
	includelist="..."
	preferences="..."
	debug="..."
		eefile="..."
/>

매개변수

속성 설명 필수
기준선 이 속성은 참조 기준선의 위치를 지정합니다.

.zip, .jar, .tgz, .tar.gz 파일이거나, Eclipse 설치 폴더에 해당하는 디렉토리일 수 있습니다. 이것은 Eclipse 실행 파일을 찾을 수 있는 디렉토리입니다.

절대 경로를 사용하여 위치가 지정됩니다.
예
프로파일 이 속성은 참조 기준선에 대해 비교하려는 현재 제품이나 프로파일의 위치를 지정합니다.

.zip, .jar, .tgz, .tar.gz 파일이거나, Eclipse 설치 폴더에 해당하는 디렉토리일 수 있습니다. 이것은 Eclipse 실행 파일을 찾을 수 있는 디렉토리입니다.

절대 경로를 사용하여 위치가 지정됩니다.
예
보고서 보고서가 생성될 출력 위치를 설정합니다.

태스크가 완료되면, 필터 루트와 유사한 구조를 사용하는 이 디렉토리에서 보고서가 사용 가능합니다. 보고되는 문제점이 있는 각 컴포넌트마다 서브폴더가 작성됩니다. 각 서브폴더는 "report.xml"이라는 파일을 포함합니다.

"allNonApiBundles"이라는 특수 폴더도 "report.xml"이라는 파일도 포함하는 이 폴더에 작성됩니다. 이 파일은 API 도구 네이처를 사용하지 않는 모든 번들을 나열합니다.

발견된 문제점의 요약을 포함하는 보고서 디렉토리에 작성된 "counts.xml" 파일도 있습니다.

절대 경로를 사용하여 위치가 지정됩니다.
예
필터 분석 동안 사용할 API 필터의 루트 디렉토리를 설정합니다.

인수는 API 도구 분석으로 작성된 잠재적 문제점을 필터링하는 데 사용해야 하는 .api_filters 파일의 루트 디렉토리입니다.
절대 경로를 사용하여 루트가 지정됩니다.
다음 구조를 포함하려면 루트가 필요합니다.
 root
  |
  +-- component name (i.e. org.eclipse.jface)
         |
         +--- .api_filters
아니오
excludelist 제외 목록 위치를 설정합니다.

제외 목록 위치는 분석에서 제외할 번들을 나열하는 텍스트 파일을 지정합니다. 기본적으로, 프로파일의 모든 번들이 분석됩니다. 포함 및 제외 목록 속성을 사용하여 번들을 선택적으로 포함 및 제외할 수 있습니다. 포함 목록은 번들 세트가 분석되도록 하고(생략 시 모든 번들이 포함됨), 그런 다음 제외 목록이 적용됩니다. 파일의 각 행은 다음 중 하나를 지정합니다.
  • 특정 번들 이름
  • 번들 이름에 대해 일치 여부를 확인하는 정규식("R:"로 시작하는 행)
  • 주석('#'으로 시작하는 행)

절대 경로를 사용하여 위치가 지정됩니다.
다음은 제외 목록 예제입니다.
 # DOC BUNDLES
 org.eclipse.jdt.doc.isv
 org.eclipse.jdt.doc.user
 org.eclipse.pde.doc.user
 org.eclipse.platform.doc.isv
 org.eclipse.platform.doc.user
 # NON-ECLIPSE BUNDLES
 com.ibm.icu
 com.jcraft.jsch
 R:javax\..*
 ...
아니오
includelist 포함 목록 위치를 설정합니다.

포함 목록 위치는 분석에 포함할 번들을 나열하는 텍스트 파일을 지정합니다. 기본적으로, 프로파일의 모든 번들이 분석됩니다. 포함 및 제외 목록 속성을 사용하여 번들을 선택적으로 포함 및 제외할 수 있습니다. 포함 목록은 번들 세트가 분석되도록 하고(생략 시 모든 번들이 포함됨), 그런 다음 제외 목록이 적용됩니다. 파일의 각 행은 다음 중 하나를 지정합니다.
  • 특정 번들 이름
  • 번들 이름에 대해 일치 여부를 확인하는 정규식("R:"로 시작하는 행)
  • 주석('#'으로 시작하는 행)

절대 경로를 사용하여 위치가 지정됩니다.
다음은 포함 목록 예제입니다.
 # DOC BUNDLES
 org.eclipse.jdt.doc.isv
 org.eclipse.jdt.doc.user
 org.eclipse.pde.doc.user
 R:org.eclipse.platform.doc.*
 # NON-ECLIPSE BUNDLES
 com.ibm.icu
 com.jcraft.jsch
 R:javax\..*
 ...
아니오
환경 설정 태스크의 환경 설정을 설정합니다.

문제점 심각도를 구성하기 위해 환경 설정이 사용됩니다. 문제점 심각도의 세 가지 가능한 값은 무시, 경고 또는 오류입니다. 발견된 문제점 세트는 API 도구에서 해당하는 문제점 환경 설정 키로 정의됩니다.
절대 경로를 사용하여 위치가 지정됩니다. 제공된 위치가 없는 경우, 환경 설정은 설정되지 않습니다.
'#'로 시작하는 행은 무시됩니다. 환경 설정 파일의 형식은 다음과 같습니다.
 #Thu Nov 20 17:35:06 EST 2008
 ANNOTATION_ELEMENT_TYPE_ADDED_METHOD_WITHOUT_DEFAULT_VALUE=Ignore
 ANNOTATION_ELEMENT_TYPE_CHANGED_TYPE_CONVERSION=Ignore
 ANNOTATION_ELEMENT_TYPE_REMOVED_FIELD=Ignore
 ANNOTATION_ELEMENT_TYPE_REMOVED_METHOD=Ignore
 ANNOTATION_ELEMENT_TYPE_REMOVED_TYPE_MEMBER=Warning
 API_COMPONENT_ELEMENT_TYPE_REMOVED_API_TYPE=Ignore
 API_COMPONENT_ELEMENT_TYPE_REMOVED_TYPE=Ignore
 CLASS_ELEMENT_TYPE_ADDED_METHOD=Error
 CLASS_ELEMENT_TYPE_ADDED_RESTRICTIONS=Ignore
 CLASS_ELEMENT_TYPE_ADDED_TYPE_PARAMETER=Ignore
 CLASS_ELEMENT_TYPE_CHANGED_CONTRACTED_SUPERINTERFACES_SET=Ignore
 ...
키는 org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblemTypes에서 찾을 수 있습니다.
아니오
디버그 디버그 값을 설정합니다.

가능한 값: true, false
기본값은 false입니다.
아니오
eefile 사용할 실행 환경 파일을 설정합니다.

기본값으로, JavaSE-1.6 실행 환경에 해당하는 실행 환경 파일이 사용됩니다.

파일의 형식은 이 wiki 페이지에서 설명됩니다.

절대 경로를 사용하여 파일이 지정됩니다.
아니오

예제

	<apitooling.analysis
		baseline="D:\eclipse\3.4.1\eclipse"
		profile="D:\eclipse-SDK-I20081118-0800-linux-gtk.tar.gz"
		report="D:\reports\xml"
		filters="D:\filters"
		excludelist="D:\exclude_list_external.txt"
		preferences="D:\tests_api\org.eclipse.pde.api.tools.prefs"
		debug="true"
	/>

이것은 D:\reports\xml 폴더 내에서 report.xml 파일을 작성하는 태스크를 실행합니다. D:\exclude_list_external.txt 및 D:\filters에 있는 .api_filter 파일 및 제외 목록을 사용하여 보고할 문제점 수를 줄입니다.

D:\tests_api\org.eclipse.pde.api.tools.prefs에서 지정한 대로 문제점 심각도가 생성됩니다.

디버그가 사용 가능하므로, 일부 디버그 추적이 Ant 콘솔에 표시됩니다.

관련 참조

API 정지 Ant 태스크
파일 생성 Ant 태스크
API 사용 Ant 태스크
분석 보고서 변환 Ant 태스크
API 정지 보고서 변환 Ant 태스크
API 사용 보고서 변환 Ant 태스크
API 비지원 Ant 태스크
API 비지원 보고서 변환 Ant 태스크