공통컴포넌트를 최초로 사용하는 사람을 위해 공통컴포넌트의 설치 부분과 실행 부분으로 나눠서 따라하기 형태로 진행할 수 있도록 설명을 제공한다.
전자정부 표준프레임워크는 공통컴포넌트의 설치를 위해 Eclipse 개발환경에서 제공하는 Wizard 기능을 이용하여 원하는 컴포넌트를 선택적으로 설치하는 방법과 전자정부 표준프레임워크 포털에서 제공하는 배포 파일을 이용하여 설치하는 두 가지의 방법을 지원한다.
1. 전자정부 표준프레임워크 포털 사이트에 접속해서 공통컴포넌트를 다운로드 받는다.
2. Search 옵션을 제목으로 선택하고 다운 받고자 하는 공통컴포넌트를 검색한 후 v2.0 버전을 다운 받는다.
1. 전자정부 표준프레임워크 개발 환경인 Eclipse(Helios 기준으로 설명)를 실행한 후 상단 메뉴의 FILE>NEW>eGovFrame Web Project를 선택하여 새로운 프로젝트를 생성한다.
2. 프로젝트 생성 위자드가 실행되면 Project name과 Group Id를 입력한다. 공통컴포넌트에서 사용되는 jsp-api를 사용하기 위해 Target Runtime을 Apache Tomcat v6.0을 추가로 선택한다. Apache Tomcat v6.0외에도 JSP2.1, Servlet 2.5 스펙을 지원하는 다른 Server를 선택할 수 있으며, 설정된 Server가 없을 경우 New버튼을 통해서 새로운 서버를 설정할 수 있다.
(전자정부 표준프레임워크 개발환경 2.5버전 이상에서는 Eclipse Juno 버전을 사용할 때 Target Runtime을 Apache Tomcat v6.0을 선택 할 필요가 없다. 다만 Target Runtime을 설정하고자 할 때에는 pom.xml에서 javax.servlet.jsp 관련 라이브러리를 주석처리 하여야 한다.)
3. Next버튼을 누른 후 Generate Example 버튼을 선택하지 않고 Finish버튼을 클릭한다.(샘플 프로젝트가 존재 할 경우 스프링관련 설정이 충돌하므로 별도의 수정작업이 필요함)
4. 새로생성된 프로젝트를 선택한후 오른쪽 버튼을 클릭한후 Import메뉴를 선택한다.
5. General탭의 Archive File을 선택한 후 Browse버튼을 클릭하여 표준프레임워크 포털 사이트에서 다운받은 공통컴포넌트를 선택한다.
6. 위자드에서 Import하고자하는 파일을 선택할 수 있다. 신규프로젝트를 생성 하였으므로 모든 파일을 Import받기 위해 별도의 설정 변경없이 Finish버튼을 클릭한다. pom.xml이 이미 존재하므로 overwrite를 하겠냐고 물어보게 된다. 신규 프로젝트 이므로 Yes To All을 선택한다. (신규프로젝트가 아닌 경우에는 overwrite하지 않고 별도로 pom.xml 및 스프링 설정 파일을 병합해야 한다.)
1. 공통컴포넌트의 환경설정을 프로젝트에 적용하기 위해 프로젝트를 선택한 후 마우스 오륵쪽 버튼을 클릭한다. 표시되는 메뉴 중에 Maven메뉴의 Update Project Configuration 버튼을 클릭하여 pom.xml의 maven설정을 프로젝트에 반영한다. 공통컴포넌트에서 참조하는 jar파일이 없어서 x표시 되는 문제가 없어지는 것을 볼 수 있다.
2. Maven Dependencies에 설정된 jar파일이 WTP플러그인의 Server로 배포될 수 있도록 설정을 진행해야 한다. 우선 프로젝트를 마우스 오른쪽 버튼으로 클릭한 후 Properties탭을 선택한다. Deployment Assembly탭을 선택한 후에 오른쪽 창의 Add버튼을 클릭한다. (Eclipse Helios버전에만 해당되는 내용이며 Juno, Ganymede 버전에서는 수행할 필요가 없다.)
3. Directive Type을 Java Build Path Entries를 선택한 후 Maven Dependencies를 선택한 후 Finish를 클릭한다. (Eclipse Helios버전에만 해당되는 내용이며 Juno, Ganymede 버전에서는 수행할 필요가 없다.)
4. 공통컴포넌트를 실행시키기 위한 DB 스크립트를 실행한다. src/script 폴더 아래에는 각 DB별로 DDL/DML 파일이 해당 패키지 이름으로 존재한다. SQL문을 사용하고자 하는 데이터베이스에서 실행시켜 테이블 생성 및 기초데이터를 입력한다. 디폴트로 mysql 데이터베이스가 설정 되어 있으므로 데이터베이스 변경을 위해서는 globals.properties(src/main/resources/egovframework/egovProps/globals.properties)파일의 DbType을 사용하고자하는 데이터베이스로 변경하면 된다. 자세한 설정은 공통컴포넌트 환경설정(context-egovuserdetailshelper.xml, web.xml, datasource)의 datasource 설정을 참고한다.
단, 오라클의 데이터베이스에서는 NLS_LENGTH_SEMANTICS 파라미터 설정이 byte로 되어 있는 경우 한글 데이터 저장시 최대길이가 3배 늘어나게 되어 최대길이를 초과하게 되므로 char로 변경하여 테이블을 생성해야 올바르게 동작한다.
5. 기본적인 설정은 위와 같으며 각 컴포넌트마다 추가되는 설정은 각 컴포넌트 가이드를 참고한다.
1. 기본 설정 및 추가 설정이 완료되면 공통컴포넌트를 서버 플러그인에 등록 및 기동하여 공통컴포넌트가 실행되는 것을 확인 할 수 있다. 공통컴포넌트를 서버에 등록하여 실행하는 위해서는 우선 서버를 등록 하여야한다. 이번 예제에서는 Tomcat6.0를 사용하여 공통컴포넌트를 실행하며 Tomcat6.0을 서버에 추가하기 위해 Server탭에서 마우스 오른쪽을 클릭하여 New>Server 를 클릭한다. 화면에 보이는 이용가능한 서버 중 Tomcat6.0을 선택한다. Tomcat을 선택하면 프로젝트를 등록하는 화면을 볼 수 있는데 여기서 공통컴포넌트를 Import한 프로젝트를 선택하면 된다.
2. 마지막으로 프로젝트를 서버에서 기동시키기 위해서 프로젝트를 마우스 오른쪽 버튼으로 클릭 후 Run As탭의 Run On Server를 클릭하여 공통컴포넌트가 실행되는 화면을 볼 수 있다.
3. 공통컴포넌트가 성공적으로 Deploy되면 아래와 같은 화면을 볼 수 있다. 각 컴포넌트는 기본적으로 더미 사용자를 이용하도록 배포되어 있으므로 로그인 관련 설정은 공통컴포넌트 환경설정(web.xml, context-egovuserdetailshelper.xml, datasource)을 참조한다.