Anyframe 3.2.1 - About Extended Controller

DefaultActionServlet

<servlet-class>는 org.apache.struts.action.ActionServlet을 extends한 anyframe.web.struts.action.DefaultActionServlet으로 정의한다. <init-param>은 ActionServlet이 제공하는 기본 기능과 Character Encoding을 설정 할 수 있다. Character Encoding 속성은 DefaulActionServlet에서 확장한 것으로 정의된 Message Resource Bundle을 읽어들일 때, 적용할 Character Encoding을 설정하기 위한 것인다.
다음은 DefaultActionServlet을 <servlet>으로 설정한 web.xml 의 일부이다.

<servlet>
	<servlet-name>action</servlet-name>
	<servlet-class>
		anyframe.web.struts.action.DefaultActionServlet
	</servlet-class>
	<init-param>
		<param-name>config</param-name>
		<param-value>/config/struts/struts-config.xml,
					/config/struts/struts-config-login.xml,
					/config/struts/struts-config-dispatch.xml,
					/config/struts/struts-config-token.xml,
					/config/struts/struts-config-exception.xml,
					/config/struts/struts-config-authorization.xml
		</param-value>
	</init-param>
	<init-param>
		<param-name>character-encoding</param-name>
		<param-value>utf-8</param-value>
	</init-param>
	<init-param>
		<param-name>debug</param-name>
		<param-value>3</param-value>
	</init-param>
	<init-param>
		<param-name>detail</param-name>
		<param-value>3</param-value>
	</init-param>
	<init-param>
		<param-name>convertNull</param-name>
		<param-value>true</param-value>
	</init-param>
	<load-on-startup>0</load-on-startup>
</servlet>

DefaultRequestProcessor

anyframe.web.struts.action.DefaultRequestProcessor는 Struts의 TilesRequestProcessor를 extends하고 있다. 따라서, DefaultRequestProcessor를 Struts 속성 정의 파일에 controller로써 설정한 경우에는 반드시 plug-in으로 TilesPlugin를 등록해 주어야 한다. TilesPlugin을 plug-in으로 등록하는 방법은 Struts Basic Tiles의 Tiles 설치 를 참고한다. 아래는 struts-config.xml 의 일부로, DefaultRequestProcessor를 <controller> 내에 정의하고 있다.

<controller
	contentType="text/html;charset=utf-8"
	locale="true"
	processorClass="anyframe.web.struts.action.DefaultRequestProcessor"/>

DefaultRequestProcessor 기능

role 기반의 인증 및 관리 기능
web.xml에서 설정한 character-encoding 값 적용
Locale 정보를 Session에 org.apache.struts.action.LOCALE이란 key 값으로 저장

아래는 인증 및 권한 처리를 수행하고 있는 DefaultRequestProcessor의 processRoles 메소드 구현 로직의 일부이다.

protected boolean processRoles(HttpServletRequest request,
            HttpServletResponse response, ActionMapping mapping)
            throws IOException, ServletException {
	// [public] Is this action protected by role requirements?
	String roles[] = mapping.getRoleNames();
	if ((roles == null) || (roles.length < 1)) {
	    return (true);
	}
	
	Subject _subject = null;
	
	HttpSession session = request.getSession();
	_subject = (Subject) session.getAttribute("subject");
	
	if (_subject == null) {
	    log.debug("#AuthenticationException is encounted");
	    
	    ExceptionConfig config = mapping.findException(AuthenticationException.class);
	    
	    if(config == null ){
	    	mapping.findException(Exception.class);
	    }
	    
	    AuthenticationException ae = new AuthenticationException(config.getKey(), request
	            .getRequestURI());
	// 중략 ...

위의 소스 코드에서 보듯이 Struts 속성 정의 파일의 특정 action 매핑 정보에 role이 부여되었을 때 Session에 저장된 Subject에서 사용자 인증 정보를 확인한 후, 인증되지 않았을 경우 AuthenticationException을 throw한다.
Exception 메시지의 key는 Struts 속성 정의 파일 <exception> 내에 정의된 AuthenticationException에 대한 key와 동일하며, 정의되지 않았을 경우엔 java.lang.Exception에 대한 key와 동일하다. 아래는 struts-config-exception.xml 파일의 일부로 AuthenticationException을 Global Level Exception으로 등록한 예이다.

<global-exceptions>
	<exception path="/extensions/error.jsp"
		key="common.msg.authentication.error"
		type="anyframe.web.struts.util.AuthenticationException"
		handler="anyframe.sample.struts.web.common.SampleExceptionHandler" />
	... 중략 ...
</global-exceptions>

AbstractActionSupport

anyframe.web.struts.action.AbstractActionSupport 클래스는 다음과 같은 주요 기능을 제공한다.

Spring 기반의 Anyframe 서비스와의 손쉬운 연동 지원
선언적인 Synchronized Token 처리
공통 Exception 처리

따라서, 각 Action 클래스는 AbstractActionSupport를 상속받아 구현하되, process 메소드를 오버라이드하여 비즈니스 레이어와 연계하여 클라이언트의 요청을 처리하는 로직을 담도록 한다.
위와 같은 주요 기능을 제공하는 AbstractActionSupport의 execute 메소드는 다음과 같이 구현되어 있다.

public ActionForward execute(ActionMapping mapping, ActionForm form,
		HttpServletRequest request, HttpServletResponse response)
		throws Exception {

	ActionForward forward = null;

	try {
		preProcess(mapping, form, request, response);
		getLogger()
				.debug(this.getClass().getName() + ".process() Started!");
		forward = process(mapping, form, request, response);
		getLogger().debug(this.getClass().getName() + ".process() Ended!");
		forward = postProcess(mapping, form, request, response, forward);
	} catch (InvalidTokenException tokenException) {
		forward = processInvalidTokenException(mapping, form, request,
				response, tokenException);
	} catch (RuntimeException uncheckedException) {
		forward = processUnCheckedException(mapping, form, request,
				response, uncheckedException);
	} catch (Exception checkedException) {
		getLogger().debug("\n Action Support Exception catch!!");
		forward = processCheckedException(mapping, form, request, response,
				checkedException);
	} finally {
		forward = processFinally(mapping, form, request, response, forward);
	}
	return forward;
}

다음 목록에 제시된 메소드들은 AbstractActionSupport 클래스 내에 구현된 메소드들로써, execute 메소드의 로직을 수행하기 위해 적절한 순서에 따라 호출된다.

preProcess

process

postProcess

processInvalidTokenException

processUnCheckedException

processCheckedException

processFinally

위에서 제시한 AbstractActionSupport의 기본 제공 기능 이외에 각 Action 클래스에서 처리해야 할 공통 기능이 필요할 경우, AbstractActionSupport를 상속받은 클래스를 생성하고, 해당 클래스에서 필요한 기능을 추가하도록 한다. 그리고 각 Action 클래스는 AbstractActionSupport를 상속받은 클래스를 상속받아 구현하도록 한다.

Action Sample

다음은 AbstractActionSupport를 상속받아 구현한 LoginAction.java 이다.

public class LoginAction extends AbstractActionSupport {
	
	public Log getLogger() throws Exception {
		return LogFactory.getLog(this.getClass().getName());
	}
	
	public ActionForward process(ActionMapping mapping, ActionForm form,
			HttpServletRequest request, HttpServletResponse response)
			throws Exception {
		AuthenticationService authenticationService = 
				(AuthenticationService) getService("authenticationService");

		UserForm userForm = (UserForm) form;
		UserVO userVO = new UserVO();
		BeanUtils.copyProperties(userVO, userForm);

		Subject subject = authenticationService.authenticate(userVO);

		HttpSession session = request.getSession();

		session.setAttribute("subject", subject);
		return (mapping.findForward("success"));
	}
}

위의 소스코드에서는 LoginAction 클래스에서 개별 Logger를 사용하기 위해 AbstractActionSupport의 getLogger 메소드를 오버라이드하고 있다.

DefaultDispathActionSupport

anyframe.web.struts.action.DefaultDispathActionSupport은 앞서 언급한 AbstractActionSupport를 상속받아 구현한 클래스로써 Struts에서 기본으로 제공하는 DispatchAction과 동일한 기능을 제공한다.

Action Sample

다음은 DefaultDispatchActionSupport를 상속받아 구현한 ShoppingCartACtion.java 이다.

public class ShoppingCartAction extends DefaultDispatchActionSupport {

	private Log log = LogFactory.getLog(this.getClass().getName());
	
	public ActionForward add(ActionMapping mapping, ActionForm form,
			HttpServletRequest request, HttpServletResponse response)
			throws Exception {
		
		log.debug(this.getClass().getName() + "add start");

		// TODO : add 기능 관련 로직
		
		return mapping.findForward("add");
	}

	public ActionForward update(ActionMapping mapping, ActionForm form,
			HttpServletRequest request, HttpServletResponse response)
			throws Exception {

		log.debug(this.getClass().getName() + "update start");
		
		// TODO : update 기능 관련 로직
		
		return mapping.findForward("update");
	}

	public ActionForward list(ActionMapping mapping, ActionForm form,
			HttpServletRequest request, HttpServletResponse response)
			throws Exception {

		log.debug(this.getClass().getName() + "list start");
		
		// TODO : search 기능 관련 로직
		
		return mapping.findForward("list");
	}

	public ActionForward delete(ActionMapping mapping, ActionForm form,
			HttpServletRequest request, HttpServletResponse response)
			throws Exception {

		
		log.debug(this.getClass().getName() + "delete start");
		
		// TODO : delete 기능 관련 로직
		
		return mapping.findForward("delete");
	}
}

DefaultDispatchActionSupport를 상속한 Action 클래스는 DispatchAction이므로, AbstractActionSupport를 상속한 Action 클래스 작성과 다르게 한 Action 내에 여러 메소드 정의가 가능하다.

DefaultForwardAction

anyframe.web.struts.common.action.DefaultForwardAction은 Struts에서 기본으로 제공하는 ForwardAction과 동일한 기능을 수행한다. 단, 차이점은 DefaultForwardAction은 AbstractActionSupport를 상속받았기 때문에 공통 Exception 처리, Synchronized Toke 처리 등이 가능하다는 장점이 있다. 아래는 DefaultForwardAction을 이용해 Action 매핑을 정의한 struts-config-dispatch.xml 파일의 일부이다. 요청 URL이 dispatchActionView.do일 경우 DefaultForwardAction을 통해 /extensions/dispatch.jsp 페이지로 이동할 것이다.

<action path="/dispatchActionView"
	type="anyframe.web.struts.action.DefaultForwardAction"
	parameter="/extensions/dispatch.jsp" />

AnyframeMiPAction

프리젠테이션 레이어 구성시 X-Internet 제품인 MiPlatform을 이용하는 경우 MiPlatform에서 다루는 고유한 형태의 데이터를 쉽게 처리할 수 있도록 하기 위해 anyframe.web.struts.action.ria.mip.AnyframeMiPAction 클래스를 제공한다. 개발자는 AnyframeMiPAction을 상속받아 개별 Action을 개발하되, process 메소드를 구현해주도록 한다.

process 메소드는 MiPlatform과 관련하여 다음과 같은 입력 인자를 가진다.

VariableList	inVl	Client에서 GET 방식으로 전송한 parameter들 포함
VariableList	outVl	Client로 전송하는 VariableList
DatasetList	inDl	Client에서 POST 방식으로 전송한 Dataset XML 포함
DatasetList	outDl	Client로 전송하는 Dataset XML 설정

Sample Action

다음은 AnyframeMiPAction을 상속받아 구현한 클래스의 일부로, process 메소드 내부에서 비즈니스 서비스를 실행하고, 그 결과값을 반환하고 있다.

public void process(ActionMapping mapping, PlatformRequest request,
		VariableList inVl, DatasetList inDl, VariableList outVl,
		DatasetList outDl) throws Exception {
	this.inVl = inVl;
	this.inDl = inDl;
	this.outVl = outVl;
	this.outDl = outDl;

	MiPUserService userService = (MiPUserService)getService("ueserService");
	Dataset ds = userService.getUserList(inVl);
	outDl.addDataset("ds_access",ds);

	// 중략 ...
}

Resources

다운로드

테스트 환경 설정

Name	Download
anyframe-struts-sample-extensions.zip	Download

참고자료
- Apache Struts User Guide

Introduction

Struts

Struts Extensions

Spring MVC

Spring MVC Extensions

References

Controller

DefaultActionServlet

DefaultRequestProcessor

DefaultRequestProcessor 기능

AbstractActionSupport

preProcess

process

postProcess

processInvalidTokenException

processUnCheckedException

processCheckedException

processFinally

Action Sample

DefaultDispathActionSupport

Action Sample

DefaultForwardAction

AnyframeMiPAction

Sample Action

Resources

다운로드

참고자료