env를 통해 환경 변수 정보가 설정된 command 창에서 프로젝트 생성을 위해 다음 command를 입력한다. 프로젝트가 생성되는 위치는 command의 옵션에 의해 변경될 수 있다. 여기서는 default인 Gen Home 하위의 applications 폴더에 프로젝트를 생성한다.

다음의 프로젝트 생성 command를 입력한다.

gen create-project [-options]

프로젝트 생성이 정상적으로 되었는지 확인한다. Web 타입 프로젝트일 경우 dynamic 웹 프로젝트로 생성되고, Service 타입 프로젝트일 경우 자바 프로젝트로 생성된다.

Web 타입 프로젝트가 생성되면 eclipse 프로젝트 관련 파일들(.project, .classpath)과 Anyframe Foundation 샘플 및 테스트 코드, 빌드 파일(build.xml), 프로젝트 설정 파일(build.properties), 설치된 Anyframe 플러그인 관련 폴더(.metadata) 등이 생성된다.

Service 타입 프로젝트가 생성되면 eclipse 프로젝트 관련 파일들(.project, .classpath)과 Anyframe Foundation 라이브러리 및 Aspect등 공통 클래스, 설정 파일, 빌드 파일(build.xml), 프로젝트 설정 파일(build.properties), 설치된 Anyframe 플러그인 관련 폴더(.metadata) 등이 생성된다.

생성된 프로젝트 설정 파일(Properties)을 수정하면, 이후 Domain 클래스 생성 및 CRUD 소스코드 생성 등의 기능에서 수정된 설정 값을 통해 생성되도록 할 수 있다. 아래 표에 설명된 항목별 내용을 보고 DAO Framework, Template type 설정을 비롯하여 다양한 공통 속성 값을 변경시킬 수 있다. DB 관련한 설정 파일 설명에 대해서는 [DB 정보 변경]에 상세하게 설명되어 있다.

Domain Class 생성 command를 입력한다.

gen create-model [-options]

Domain Class 가 정상적으로 생성되었는지 확인한다.

Domain Class 생성 시 지정한 -basepackage 값에 해당하는 패키지에 -table 값에 해당하는 Domain Class가 있으면 정상이다. 아래는 생성된 Board.java 코드의 일부분이다.

@Entity
@Table(name = "BOARD", schema = "PUBLIC")
public class Board implements Serializable {
    private BoardId id;
    private BoardMaster boardMaster;
    private String boardName;
    중략...
    public BoardId getId() {
        return this.id;
    }
    public void setId(BoardId id) {
        this.id = id;
    }
    @ManyToOne(fetch = FetchType.LAZY)
    @JoinColumn(name = "BOARD_MASTER_ID", nullable = false, 
                insertable = false, updatable = false)
    public BoardMaster getBoardMaster() {
        return this.boardMaster;
    }
    public void setBoardMaster(BoardMaster boardMaster) {
        this.boardMaster = boardMaster;
    }
    @Column(name = "BOARD_NAME", nullable = false, length = 150)
    public String getBoardName() {
        return this.boardName;
    }
    public void setBoardName(String boardName) {
        this.boardName = boardName;
    }	  
}

build.properties파일(생성한 프로젝트 폴더 하위에 위치)을 열어 DB 설정 정보를 수정한다.

DB 변경 command를 입력한다. build.properties 파일의 DB 정보를 참조로 하여 DB 설정 내용을 반영한다.

gen change-db

DB 정보가 정상적으로 변경되었는지 확인한다.

프로젝트 코드 내 DataSource Service 설정 정보 및 Hibernate, Query Service 관련 정보들이 변경되었는지 확인한다. (ex. src/main/resources/spring/context-datasource.xml)

프로젝트가 생성된 폴더 하위로 이동한다. (예를 들어, myproject 라는 프로젝트를 생성시켰다면 myproject 폴더 하위에서 command를 실행시키도록 한다.)

다음의 어플리케이션 빌드 command를 입력한다.

gen build [-options]

빌드 대상 프로젝트 폴더 하위로 이동한다. (예를 들어, myproject 라는 프로젝트를 생성시켰다면 myproject 폴더 하위에서 command를 실행시키도록 한다.)

ant를 실행하기 위한 build.xml, build.properties 파일이 있는지 확인한다.

다음의 프로젝트 빌드 command를 입력한다.

ant [targets]

프로젝트가 생성된 폴더 하위로 이동한다. (예를 들어, myproject 라는 프로젝트를 생성시켰다면 myproject 폴더 하위에서 command를 실행시키도록 한다.)

다음의 어플리케이션 빌드 및 웹 어플리케이션 실행 command를 입력한다.

gen run [-options]

웹 어플리케이션 실행 결과를 웹 브라우저를 띄워서 확인하도록 한다. 요청 URL에서 Port 정보가 8090 인 것에 유의하도록 한다. (Jetty의 기본 Port 정보가 8090임)

예제의 경우 요청 URL은 http://localhost:8090/myproject 가 되며, 이 때, 설치된 플러그인 목록이 조회된다. http://localhost:8090/myproject/index.jsp 로 접속하면 Gen 을 통해 생성한 메뉴를 확인할 수 있다.

Jetty 폴더를 확인한다.

프로젝트 dist 폴더 하위에 jetty-temp라는 폴더가 생성되어 Jetty가 구동되게 된다. 배포 이후에 클래스나 JAR 파일, JSP 파일 등을 반영하고 Jetty로 재확인하고 싶다면 이 폴더의 해당 위치에 배포하도록 한다.

Anyframe Gen 플러그인 설치는 Anyframe Plugin Update Site를 통해서 설치할 수 있다. 외부 인터넷 연결이 안되거나 네트웍에 문제가 있는 경우 아래의 노트 [Update Site를 이용하지 않고 Anyframe Gen Eclipse Plugin 설치하기] 내용을 참고하여 설치하도록 한다.

"Help > About Eclipse Platform (또는 About Eclipse SDK) > Plug-in Details"를 통해 정상적으로 설치되었는 지 확인한다.

☞ About Eclipse Platform (또는 About Eclipse SDK) 메뉴는 Windows용 Eclipse의 경우 Help 메뉴에서, Mac OS X용 Eclipse의 경우 Eclipse 메뉴에서 확인할 수 있다.

☞ Eclipse 루트 폴더 하위의 plugins 폴더 내로 anyframe.common.eclipse.core_xxx.jar와 anyframe.gen.eclipse.core_xxx.jar 파일이 설치되어있는지 확인해볼 수 있다.

Anyframe Gen 플러그인을 포함한 전체 Anyframe Gen의 설치가 완료되었다. Anyframe Gen의 기능을 사용하여 개발하기 이전에 반드시 [Preferences] 내용을 참고하여 환경 설정을 모두 끝마치도록 한다.

File >> New >> Other.. >> Anyframe >> Project 을 선택

열린 창에서 프로젝트 생성을 위해 다음과 같은 내용을 입력한다. 아래 항목을 문제없이 기입하는 경우 Next 버튼과 Finish 버튼이 활성화 되며, Next 버튼을 클릭하면 DB정보를 구성할 수 있는 화면으로 연결된다.

DB정보를 구성하기 위해 위 화면에서 Next 버튼을 클릭하였다면 다음과 같은 JDBC Configuration 화면이 제공된다.

Finish 버튼을 누르면 프로젝트가 생성된다.

프로젝트 생성이 완료되면 Eclipse 내에 프로젝트가 정상적으로 생성되어 Import 되었는지 확인해본다. Web 타입 프로젝트일 경우 dynamic 웹 프로젝트로 생성되고, Service 타입 프로젝트일 경우 자바 프로젝트로 생성된다.

서버를 실행하여 프로젝트를 실행해본다.

프로젝트 내 build.xml 확인

프로젝트 내부로 자동 생성되어진 build.xml 파일이 존재한다. 빌드 스크립트 내에는 빌드 수행을 위한 compile, test, package등 공통적으로 사용되는 빌드 타겟들이 존재한다. 실제 구동 내역을 가지고 있는 공통 스크립트는 [Gen Home]\cli\scripts\project-build.xml 파일 내에 작성되어 있다. 프로젝트 별로 변경해야 하는 일이 생기면 공통 스크립트를 수정하면 된다. 또한 각 프로젝트 단위 별로 공통 빌드 내역 외에 특화된 빌드 내용을 추가해야 하는 경우에는 해당 빌드 타겟을 확장하여 추가해 넣을 수 있다.

다음은 Web 타입 프로젝트에 생성된 build.xml 의 일부분이다.

<project name="Build module" default="default" basedir=".">		
    <property file = "build.properties"/>
    <import file = "${gen.home}/cli/scripts/project-build.xml"/>
	
    <target name="clean" depends = "shared:clean" />
    <target name="init" depends = "shared:init" />
    <target name="resources" depends = "shared:resources" />
    <target name="compile" depends = "shared:compile" />
    <target name="test-resources" depends = "shared:test-resources" />
    <target name="test-compile" depends = "shared:test-compile" />
    <target name="package" depends = "shared:package" />
    <target name="extract" depends = "shared:extract" />
    <target name="emma-jars" depends = "shared:emma-jars" />
    <target name="test" depends = "shared:test" />
    <target name="report" depends = "shared:report" />

    <target name = "default" depends = "init, resources, compile, package"/>
    <target name = "deploy" depends = "default, extract"/>
    <target name = "all" depends = "clean, init, resources, compile, 
               test-resources, test-compile, package, emma-jars, test, report"/>
</project>

프로젝트 내 build.xml 선택 후 >> Run As >> Ant Build 을 선택

디폴트 타겟이 수행되어 다음과 같은 빌드 프로세스를 거치게 된다. 최종 결과물인 프로젝트 바이너리 파일은 repo 폴더 하위에 존재하게 된다.

init -> resources -> compile -> package -> deploy

프로젝트 내 build.xml 선택 후 >> Run As >> Ant Build... 을 선택

디폴트 타겟이 아닌 리포팅 결과물을 생성해내는 타겟을 실행시켜 본다. 빌드 시 코드 분석 리포트, 테스트 수행 결과 리포트, 코드 커버리지 리포트 등을 생성시킨다. 리포트 결과물은 프로젝트 내 output 폴더에 생성되므로 빌드가 모두 완료된 뒤 확인해보도록 한다.

clean -> init -> resources -> test-resources -> test-compile -> package -> emma-jars -> test -> report

Anyframe source code repository(Subversion)으로부터 anyframe.gen.archetype.singleconfig 프로젝트(SVN URL:http://dev.anyframejava.org/subv/anyframe-opensource/gen/tags/gen-1.2.0/dev/archetype/anyframe.gen.archetype.singleconfig)를 내려받는다. Subversion에 Access하는 자세한 방법은 이곳(Subversion 연결) 을 참고하도록 한다.

Eclipse에 anyframe.gen.archetype.singleconfig 프로젝트를 Import한 후, 프로젝트 명을 변경시킨다. 이때 이름은 반드시 anyframe.gen.archetype.singleconfig로 시작 하는 이름이어야 한다.

예를 들어, anyframe.gen.archetype.singleconfig.ext로 프로젝트 명을 변경시켜보자.

anyframe.gen.archetype.singleconfig.ext 프로젝트 하위의 src/main/resources/archetype-resources 폴더 내 파일들을 변경 및 추가할 수 있다.

샘플 코드 혹은 빌드 스크립트 파일을 변경할 수 있다. 샘플 코드는 src/main/resources/archetype-resources/src 폴더 하위에, 빌드 스크립트 파일(build.xml)은 src/main/resources/archetype-resources/pjt 폴더 하위에 위치하고 있다.

신규 message resource 파일을 추가하여, 프로젝트 생성 시 나타나도록 message-ext.properties 파일을 추가한다.

그러므로 src/main/resources/archetype-resources/src/main/resources/message 폴더 하위에 message-ext.properties 파일을 추가한다.

수정 및 추가한 정보에 의해 부가적으로 변경되어야 하는 파일이 존재하는 경우, 함께 수정하도록 한다.

message resource 파일이 추가되면, spring messageSource bean에 properties 파일을 추가 설정해주도록 한다. 즉, src/main/resources/archetype-resources/src/main/resources/spring/context-common.xml 파일에 다음과 같이 value 태그를 추가해넣는다.

<bean id="messageSource" 
	class="org.springframework.context.support.ResourceBundleMessageSource">	
	<property name="basenames">
		<list>
			<value>message/message-ext</value>					
			<value>message/message-generation</value>					
			<value>message/message-productmgmt</value>
			<value>anyframe/core/properties/messages/properties</value>
			중략...							
		</list>
	</property>
</bean>

확장된 anyframe.gen.archetype.singleconfig.ext 프로젝트를 패키징한다.

Maven으로 프로젝트를 빌드하여 jar 파일로 패키징하도록 한다. Maven 빌드를 하기 위해서는 Maven을 먼저 설치해야 하는데 이는 Anyframe 매뉴얼 중 Maven 설치 및 환경 설정 부분을 참고하도록 한다. Maven 설치 및 환경 설정 한 이 후 "mvn package" command를 수행시킨다. 그 결과 패키지 파일은 anyframe.gen.archetype.singleconfig.ext 프로젝트 하위의 target 폴더에 anyframe.gen.archetype.singleconfig.ext-1.0.0.jar 파일로 생성된다.

mvn package

확장된 anyframe.gen.archetype.singleconfig.ext 배포 파일을 [Gen Home] 폴더 하위의 templates 폴더에 위치시키는데 이때, 새로운 템플릿으로 명명하여 사용할 것이므로 templates 폴더 하위에 ext와 같이 템플릿명을 나타내는 폴더를 생성한 뒤 다음과 같이 ext 폴더 하위로 project 폴더를 두고, anyframe.gen.archetype.singleconfig.ext-1.0.0.jar 파일을 배포한다.

즉, [Gen Home]/templates/default 폴더 전체를 복사하여 [Gen Home]/templates/ext 폴더에 위치시킨 후 기존의 anyframe.gen.archetype.singleconfig-1.0.0.jar 파일을 project 폴더에서 삭제하고 새로 패키징한 anyframe.gen.archetype.singleconfig.ext-1.0.0.jar 파일을 위치시킨다.

Web 타입 프로젝트 생성 기능을 수행시켜서 위에서 추가한 message-ext.properties 파일이 자동생성되어 구성되는지 확인해보도록 한다.

CLI상에서 Web 타입 프로젝트 생성 시 build.properties 파일의 template_type 항목의 값을 ext로 변경하고 생성하도록 한다. Eclipse Plugin을 이용하여 Web 타입 프로젝트 생성 시에는 AnyframeGen Editor의 Configuration Tab 내에서 template을 ext로 변경하고 생성하도록 한다.

Anyframe source code repository(Subversion)으로부터 archetype 프로젝트를 내려받도록 한다. (SVN URL은 다음 표를 참조한다.) Subversion에 Access하는 자세한 방법은 이곳(Subversion 연결) 을 참고하도록 한다.

Eclipse에 archetype 프로젝트를 Import한 후, 프로젝트 명을 변경시킨다. 이때 이름은 반드시 anyframe.gen.archetype.service로 시작 하는 이름이어야 한다.

예를 들어, anyframe.gen.archetype.service.annotation.ext로 프로젝트 명을 변경시켜보자.

anyframe.gen.archetype.service.annotation.ext 프로젝트 하위의 src/main/resources/archetype-resources 폴더 내 파일들을 변경 및 추가할 수 있다.

샘플 코드 혹은 빌드 스크립트 파일을 변경할 수 있다. 샘플 코드는 src/main/resources/archetype-resources/src 폴더 하위에, 빌드 스크립트 파일(build.xml)은 src/main/resources/archetype-resources/pjt 폴더 하위에 위치하고 있다.

LoggingAspect 클래스에 afterLogging 메소드를 추가한다.

아래와 같이 src/main/java/common/aspect/LoggingAspect.java 파일을 열어서 afterLogging 메소드를 추가해넣는다. 메소드 호출 후에도 로깅을 남기도록 수정한다.

private MessageSource messageSource;
public void setMessageSource(MessageSource messageSource) {
	this.messageSource = messageSource;
}
public void afterLogging(JoinPoint thisJoinPoint) {
	Class clazz = thisJoinPoint.getTarget().getClass();
	String className = clazz.getName();
	String classSimpleLowerName = thisJoinPoint.getTarget().getClass().
	                              getSimpleName().toLowerCase();
	String methodName = thisJoinPoint.getSignature().getName();
	String methodLowerName = methodName.toLowerCase();
	
	StringBuffer buf = new StringBuffer();
	buf.append("\n** After Logging Aspect : executed " + methodName + "() in "
			+ className + " Class.");
	buf.append("\n*******************************************\n");
	buf.append(messageSource.getMessage("success." + classSimpleLowerName + "."
			+ methodLowerName, new String[] {}, "no messages", Locale.getDefault()));
	buf.append("\n*******************************************\n");
	
	Log logger = LogFactory.getLog(clazz);
	if (logger.isDebugEnabled())
		logger.debug(buf.toString());	
}

수정 및 추가한 정보에 의해 부가적으로 변경되어야 하는 파일이 존재하는 경우, 함께 수정하도록 한다.

Aspect 클래스에 메소드가 추가되고 이를 반영하기 위해 src/main/resources/archetype-resources/src/main/resources/spring/context-aspect.xml 파일에 다음과 같이 aop:after 태그를 추가해넣는다.

<aop:config>
	<aop:pointcut id="loggingMethod" expression="execution(* *..*Service+.*(..))" />
	<aop:aspect ref="methodLoggingAspect" >
		<aop:before method="beforeLogging" pointcut-ref="loggingMethod"/>
		<aop:after method="afterLogging" pointcut-ref="loggingMethod" />
	</aop:aspect>	 
</aop:config>

확장된 anyframe.gen.archetype.service.annotation.ext 프로젝트를 패키징한다.

Maven으로 프로젝트를 빌드하여 jar 파일로 패키징하도록 한다. Maven 빌드를 하기 위해서는 Maven을 먼저 설치해야 하는데 이는 Anyframe 매뉴얼 중 Maven 설치 및 환경 설정 부분 을 참고하도록 한다. Maven 설치 및 환경 설정한 이후 "mvn package" command를 수행시킨다. 그 결과 패키지 파일은 anyframe.gen.archetype.service.annotation.ext 프로젝트 하위의 target 폴더에 anyframe.gen.archetype.service.annotation.ext-1.0.0.jar 파일로 생성된다.

mvn package

확장된 anyframe.gen.archetype.service.annotation.ext 배포 파일을 [Gen Home] 폴더 하위의 templates 폴더에 위치시키는데 이때, 새로운 템플릿으로 명명하여 사용할 것이므로 templates 폴더 하위에 ext와 같이 템플릿명을 나타내는 폴더를 생성한 뒤 다음과 같이 ext 폴더 하위로 project 폴더를 두고, anyframe.gen.archetype.service.annotation.ext-1.0.0.jar 파일을 배포한다.

즉, [Gen Home]/templates/default 폴더 전체를 복사하여 [Gen Home]/templates/ext 폴더에 위치시킨 후 기존의 anyframe.gen.archetype.service.annotation-1.2.0.jar 파일을 project 폴더에서 삭제하고 새로 패키징한 anyframe.gen.archetype.service.annotation.ext-1.0.0.jar 파일을 위치시킨다.

Service 타입 프로젝트 생성 기능을 수행시켜서 위에서 추가한 LoggingAspect.java 파일이 자동생성되어 구성되는지 확인해보도록 한다.

CLI상에서 Service 타입 프로젝트 생성 시 build.properties 파일의 template_type 항목의 값을 ext로 변경하고 생성하도록 한다. Eclipse Plugin을 이용하여 Service 타입 타입 프로젝트 생성 시에는 AnyframeGen Editor의 Configuration Tab 내에서 template을 ext로 변경하고 생성하도록 한다.