위젯 개발 및 배포 빠른 시작 안내서
사용자 정의 위젯을 작성하고 배포하는 방법
 |
이 안내서에서는 위젯 개발을 위한 일반적인 힌트를 제공합니다. 구체적인 요구 사항과 사용 중인 Codebeamer 버전과의 호환성을 확인하는 것이 좋습니다.
|
전제 조건
시작하기 전에 다음 항목이 설치되어 있는지 확인합니다.
• Java JDK 1.8 이상(Oracle 또는 OpenJDK)
• Eclipse IDE, 이 안내서에서는 Eclipse Luna를 사용합니다. Eclipse 설치에 Eclipse Maven Integration이 포함되어 있는지 확인합니다.
• cb.jar 파일을 CODEBEAMER_HOME/tomcat/webapps/cb/WEB-INF/lib/cb.jar에서 폴더로 복사합니다.
개발 환경 설정
단계 1. 프로젝트 가져오기
Eclipse를 열고 > 메뉴 옵션을 선택합니다.
'Existing Maven Projects'를 선택하고 추출한 프로젝트를 선택합니다.
가져오기에 성공하면 가져온 프로젝트가 왼쪽에 나타납니다.
단계 2. cb.jar의 경로 다시 쓰기
Maven 빌드 프로세스는 모든 종속성을 다운로드하지만 cb.jar에 대한 경로는 수동으로 설정해야 합니다. 표준 위치는 CODEBEAMER_HOME/tomcat/webapps/cb/WEB-INF/lib/cb.jar입니다.
코드 작성
이 예제 프로젝트에는 필드가 하나인 간단한 위젯이 포함되어 있습니다.
이 필드를 텍스트로 렌더링합니다.
pom.xml 파일을 마우스 오른쪽 버튼으로 클릭하고 > 를 선택합니다.
Goals 필드에 "clean install"을 입력하고 Run을 클릭합니다.
콘솔 탭에는 다음과 같이 표시되어야 합니다.
target 디렉터리에 컴파일된 jar 파일이 포함되어 있습니다.
위젯 배포
단계 1. 실행 중인 Codebeamer 인스턴스 중지
Codebeamer 시작/중지을 참조하십시오.
단계 2. 위젯 jar 파일 복사
Maven 빌드 프로세스(demo-widget-0.0.1.jar)에서 작성된 jar 파일을 CODEBEAMER_HOME/tomcat/webapps/cb/WEB-INF/lib에 복사합니다.
단계 3. Codebeamer 인스턴스 시작
참조: Codebeamer 시작/중지
단계 4. 위젯이 배포되었는지 확인
올바르게 배포하면 위젯이 위젯 브라우저의 적절한 범주에 표시됩니다.
문제 해결 및 중요 참고 사항
레이블의 i18n
제대로 렌더링하려면 모든 위젯에는 레이블 두 개가 필요합니다. 이 레이블은 src/main/resources 폴더 내 my-ApplicationResources.properties 파일에서 지정해야 합니다. 자세한 내용은 위젯 개발 설명서를 참조하십시오.
권장되는 이름 및 설명 형식:
• dashboard.X.widget.name - 위젯 브라우저에 표시되는 위젯의 이름 레이블입니다.
• dashboard.X.widget.short.description - 위젯 브라우저에 표시되는 위젯의 설명입니다.
속성 레이블의 필수 형식:
• widget.editor.field.label.X
my-ApplicationResources.properties 파일이 이미 다른 용도로 사용 중인 경우 위젯 관련 레이블을 해당 파일로 병합합니다! (예상 위치: CODEBEAMER_HOME/tomcat/webapps/cb/WEB-INF/lclasses)
위젯을 인식할 수 없음
Codebeamer 응용 프로그램은 Spring 주석을 사용하여 위젯을 검색합니다. 위젯이 위젯 브라우저에 표시되지 않는 경우 다음 사항을 다시 확인하십시오.
• Widget 클래스 그리고 Widget 클래스의 제조자에 데모 프로젝트에서와 같이 Jackson 주석이 있습니다.
• WidgetInformation 클래스에 @Component 주석이 있습니다.
• Renderer 클래스에 @Component 주석과 고유한 @Qualifier가 있습니다.
• Renderer 클래스의 제조자에 @Autowired 주석이 있습니다.
• WidgetFactory 클래스에 @Component 주석과 고유한 @Qualifier가 있습니다.
• Renderer 클래스의 제조자에 @Autowired 주석이 있습니다. Renderer 매개 변수가 올바른 @Qualifiers를 참조합니다.
• WidgetFactory 클래스의 getInjectableValues 메소드가 Widget 생성자의 @JacksonInject 주석과 동일한 식별자를 사용합니다.
위젯을 사용할 수 없음
| | Codebeamer용 사용자 정의 위젯은 현재 Codebeamer X에서 지원되지 않습니다. |
대시보드에 시스템에 없는 위젯이 포함되어 있는 경우 Codebeamer에는 다음 오류가 표시됩니다.
CODEBEAMER_HOME/tomcat/webapps/cb/WEB-INF/lib에 올바른 jar 파일이 있는지 다시 한번 확인하십시오.