Struts2 - 攔截HTML或JSP

Problem

許多人都會有在Struts中如何攔截過濾HTML或JSP的需求。使用者想連結至某一個網頁，並不一定會登入才連結。他可能會將有興趣的網頁直接存到我的最愛，下次就直接連過去了。假如他是處於session過期或沒登入的情況呢?也許這個網頁就無法正常顯示了。在Struts中該如何在存取某些網頁前，先做狀態的檢查呢?

How to?

透過Filter

web.xml

如果使用Struts範例中的設定，通常會將所有的URL請求讓struts2處理。在這我們可以增加一個DelegatingFilterProxy，當使用者請求*.html的頁面時，會經過我所實作的DelegatingFilterProxy去確認session狀態。

	<filter>
		<filter-name>struts2</filter-name>
		<filter-class>org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter</filter-class>
	</filter>
	<filter>
		<filter-name>DelegatingFilterProxy</filter-name>
		<filter-class>org.tonylin.funny.web.DelegatingFilterProxy</filter-class>
	</filter>	
	<filter-mapping>
		<filter-name>struts2</filter-name>
		<url-pattern>*</url-pattern>
	</filter-mapping>
	<filter-mapping>
		<filter-name>DelegatingFilterProxy</filter-name>
		<url-pattern>*.html</url-pattern>
	</filter-mapping>	

DelegatingFilterProxy

DelegatingFilterProxy繼承struts的StrutsPrepareAndExecuteFilter。根據我的範例，除了login.html的頁面外，其它的html都必須檢查session中是否有User登入的資料，如果沒有就會將頁面導向login.html。

public class DelegatingFilterProxy extends StrutsPrepareAndExecuteFilter {
	private Logger logger = LoggerFactory.getLogger(DelegatingFilterProxy.class);
	final static private List<String> IGNORE_SESSION_CHECKING_LIST = Arrays.asList("/login.html");
 
	@Override
	public void doFilter(ServletRequest req, ServletResponse res,
			FilterChain chain) throws IOException, ServletException {
		HttpServletRequest request = (HttpServletRequest)req;
		HttpServletResponse response = (HttpServletResponse)res;
 
		String servletPath = request.getServletPath();
		logger.debug("doFilter: {},{}", servletPath,
				IGNORE_SESSION_CHECKING_LIST.indexOf(servletPath));
 
 
		if( SessionUtil.getAttribute(request, SessionKeys.ACCOUNT) == null && IGNORE_SESSION_CHECKING_LIST.indexOf(servletPath) == -1 ){
			response.sendRedirect("login.html");
		} else {
			super.doFilter(req, res, chain);	
		}
	}
 
 
}

透過Interceptor

web.xml

將所有URL請求都交給struts的StrutsPrepareAndExecuteFilter。

	<filter>
		<filter-name>struts2</filter-name>
		<filter-class>org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter</filter-class>
	</filter>
	<filter-mapping>
		<filter-name>struts2</filter-name>
		<url-pattern>*</url-pattern>
	</filter-mapping>

strus.xml

最重要的兩點:

1. 定義struts.action.extension的constant包含html，讓struts知道html也是屬於Action的一種。
2. 假設必須登入才能使用的頁面為clientInfo.html，我必須定義一個名為clientInfo的action。它的interceptor為basic-stack，其中包含我所實作的AuthorizationInterceptor。

<struts>
	<constant name="struts.action.extension" value="action,do,html" />
	<package name="default" extends="struts-default">
		<interceptors>
			<interceptor name="loginValidator"
				class="org.tonylin.funny.web.AuthorizationInterceptor" />
			<interceptor-stack name="basic-stack">
				<interceptor-ref name="loginValidator" />
				<interceptor-ref name="defaultStack" />
			</interceptor-stack>
		</interceptors>
 
		<global-results>
			<result name="login">/login.html</result>
		</global-results>
		<action name="clientInfo">
			<interceptor-ref name="basic-stack" />
		</action>
	</package>
</struts>

AuthorizationInterceptor

檢查session是否包含使用者登入的資訊，如果沒有就導入登入頁面，如果有就照原本的流程繼續做下去。

public class AuthorizationInterceptor extends AbstractInterceptor {
	private static final long serialVersionUID = -8706948299919053366L;
	private Logger logger = LoggerFactory.getLogger(AuthorizationInterceptor.class);
 
	@Override
	public String intercept(ActionInvocation arg0) throws Exception {
		logger.debug("Check app session.");
 
		Map<String, Object> session = arg0.getInvocationContext().getSession();
		if( session.get(SessionKeys.ACCOUNT) == null ){
			return Action.LOGIN;
		}
		return arg0.invoke();
	}
}

Summary

兩種方法哪一個好呢? 我個人使用了第一種Filter的方式。因為使用Interceptor的方式，我必須將所有必須要登入才能使用的頁面，都宣告在struts設定檔中。我很懶所以使用了第一種方法。如果使用了第二種方法，為了避免讓html宣告與原本身為Controller的Action宣告容易造成閱讀上的不便，建議可以透過struts2的功能，將html部分的宣告另外拉出成一個設定檔，這部分可以參考Reference 3的做法。