Struts2 入门学习笔记（二）——拦截器应用

Struts2 入门学习笔记（二）——拦截器应用

一.拦截器原理

         在Struts2从接收请求（request）到完成响应（response）的过程中，Struts2框架内部会有很多的类进行功能上的封装实现，比如上传、数据验证，以及登录功能中对Action属性的赋值，都是拦截器在起作用，有了拦截器可以将Struts2框架中的组件进行松耦合开发，象棋桥板一样随意的拼装功能。

         在struts-default.xml中有一个名为defaultStack拦截器栈，他是默认的拦截器栈，主要如下：

   
   

    
    

     
                 <!-- Basic stack -->
    
    
    
    

     
                 <interceptor-stack name="basicStack">
    
    
    
    

     
                 </interceptor-stack>
    
    
    
    

     
      
    
    
    
    

     
                 <!-- Sample validation and workflow stack -->
    
    
    
    

     
                 <interceptor-stack name="validationWorkflowStack">
    
    
    
    

     
                 </interceptor-stack>
    
    
    
    

     
      
    
    
    
    

     
                 <!-- Sample file upload stack -->
    
    
    
    

     
                 <interceptor-stack name="fileUploadStack">
    
    
    
    

     
                 </interceptor-stack>
    
    
    
    

     
      
    
    
    
    

     
                 <!-- Sample model-driven stack  -->
    
    
    
    

     
                 <interceptor-stack name="modelDrivenStack">
    
    
    
    

     
                 </interceptor-stack>
    
    
    
    

     
      
    
    
    
    

     
                 <!-- Sample action chaining stack -->
    
    
    
    

     
                 <interceptor-stack name="chainStack">
    
    
    
    

     
                 </interceptor-stack>
    
    
    
    

     
      
    
    
    
    

     
                 <!-- Sample i18n stack -->
    
    
    
    

     
                 <interceptor-stack name="i18nStack">
    
    
    
    

     
                 </interceptor-stack>
    
    
    
    

     
      
    
    
    
    

     
                
    
    
    
    

     
                 <interceptor-stack name="paramsPrepareParamsStack">
    
    
    
    

     
                 </interceptor-stack>
    
    
    
    

     
     

    
    
    
    

     
                 <interceptor-stack name="defaultStack">
    
    
    
    

     
                 </interceptor-stack>
    
    
    
    

     
      
    
    
    
    

     
            
    
    
    
    

     
                 <interceptor-stack name="completeStack">
    
    
    
    

     
                 </interceptor-stack>
    
    
    
    

     
     

    
    
    
    

     
                 <interceptor-stack name="executeAndWaitStack">
    
    
    
    

     
                     </interceptor-ref>
    
    
    
    

     
                 </interceptor-stack>
    
    
   
   

二.拦截器应用

         使用拦截器必须要继承AbstracInterceptor类，然后重写intercept()方法，在该方法中进行业务的处理，其中ActionInvocation的invoke()方法的主要作用就是执行Action中的内容，返回的字符串就是result的逻辑名称。

         以下我们先创建下环境，之后在这个基础上添加拦截器：

这是action类：

   
   

    
    

     
     package cn.sun.action;
    
    
    
    

     
      
    
    
    
    

     
     public class PrintUsername {
    
    
    
    

     
     	
    
    
    
    

     
     	public String execute(){
    
    
    
    

     
     		System.out.println("PrintUsername execute()");
    
    
    
    

     
     		return "toPrintUsernameJSP";
    
    
    
    

     
     	}
    
    
    
    

     
      
    
    
    
    

     
     }
    
    
   
   

这是struts.xml配置：

   
   

    
    

     
     <?xml version="1.0" encoding="UTF-8"?>
    
    
    
    

     
      <!DOCTYPE struts PUBLIC
    
    
    
    

     
     	"-//Apache Software Foundation//DTD Struts Configuration 2.3//EN"
    
    
    
    

     
     	"http://struts.apache.org/dtds/struts-2.3.dtd" >
    
    
    
    

     
      
    
    
    
    

     
     <struts>
    
    
    
    

     
     	<constant name="struts.devMode" value="true"></constant>
    
    
    
    

     
     	<package name="anyone" namespace="/" extends="struts-default">
    
    
    
    

     
     		<action name="printUsername" class="cn.sun.action.PrintUsername">
    
    
    
    

     
     			<result name="toPrintUsernameJSP">/page_interceptor/printUsername.jsp</result>
    
    
    
    

     
     		</action>
    
    
    
    

     
     	</package>
    
    
    
    

     
     </struts>
    
    
   
   

默认输出：

   
   

    
    

     
     PrintUsername execute()
    
    
   
   

         下面我们开始新建一个拦截器：

   
   

    
    

     
     package cn.sun.interceptor;
    
    
    
    

     
      
    
    
    
    

     
     import com.opensymphony.xwork2.ActionInvocation;
    
    
    
    

     
     import com.opensymphony.xwork2.interceptor.AbstractInterceptor;
    
    
    
    

     
      
    
    
    
    

     
     public class MyInterceptor extends AbstractInterceptor {
    
    
    
    

     
      
    
    
    
    

     
     	@Override
    
    
    
    

     
     	public String intercept(ActionInvocation actionInvocation) throws Exception {
    
    
    
    

     
     		System.out.println("拦截器执行在前...");
    
    
    
    

     
     		actionInvocation.invoke();
    
    
    
    

     
     		System.out.println("拦截器执行在后...");
    
    
    
    

     
     		return null;
    
    
    
    

     
     	}
    
    
    
    

     
      
    
    
    
    

     
     }
    
    
   
   

    在配置文件struts.xml中注册拦截器并应用到action中（注意，这里放置标签是有顺序的，可参考其他）：

   
   

    
    

     
     <?xml version="1.0" encoding="UTF-8"?>
    
    
    
    

     
      <!DOCTYPE struts PUBLIC
    
    
    
    

     
     	"-//Apache Software Foundation//DTD Struts Configuration 2.3//EN"
    
    
    
    

     
     	"http://struts.apache.org/dtds/struts-2.3.dtd" >
    
    
    
    

     
      
    
    
    
    

     
     <struts>
    
    
    
    

     
     	<constant name="struts.devMode" value="true"></constant>
    
    
    
    

     
     	<package name="anyone" namespace="/" extends="struts-default">
    
    
    
    

     
     		
    
    
    
    

     
     		
    
    
    
    

     
     		<interceptors>
    
    
    
    

     
     			<interceptor name="myInterceptor" class="cn.sun.interceptor.MyInterceptor"></interceptor>
    
    
    
    

     
     		</interceptors>
    
    
    
    

     
     		<action name="printUsername" class="cn.sun.action.PrintUsername">
    
    
    
    

     
     			<result name="toPrintUsernameJSP">/page_interceptor/printUsername.jsp</result>
    
    
    
    

     
     			<interceptor-ref name="myInterceptor"></interceptor-ref>
    
    
    
    

     
     		</action>
    
    
    
    

     
     	</package>
    
    
    
    

     
     </struts>
    
    
   
   

  这次我们发现执行结果变成如下情况了：

   
   

    
    

     
     拦截器执行在前...
    
    
    
    

     
     PrintUsername execute()
    
    
    
    

     
     拦截器执行在后...
    
    
   
   

    说明我们所设计的拦截器确实起到了作用，但是这里有一个问题，当我们使用了自定义的拦截器以后系统默认的拦截器便失效了，如这里面数据验证，自动装配功能都没有了，所以想要完全的实现还需要我们将系统默认拦截器加入到程序中，在struts.xml中进行配置：

   
   

    
    

     
     <?xml version="1.0" encoding="UTF-8"?>
    
    
    
    

     
      <!DOCTYPE struts PUBLIC
    
    
    
    

     
     	"-//Apache Software Foundation//DTD Struts Configuration 2.3//EN"
    
    
    
    

     
     	"http://struts.apache.org/dtds/struts-2.3.dtd" >
    
    
    
    

     
      
    
    
    
    

     
     <struts>
    
    
    
    

     
     	<constant name="struts.devMode" value="true"></constant>
    
    
    
    

     
     	<package name="anyone" namespace="/" extends="struts-default">
    
    
    
    

     
     		
    
    
    
    

     
     		<interceptors>
    
    
    
    

     
     			<interceptor name="myInterceptor" class="cn.sun.interceptor.MyInterceptor"></interceptor>
    
    
    
    

     
     			<interceptor-stack name="myInterceptorStack">
    
    
    
    

     
     				<interceptor-ref name="defaultStack"></interceptor-ref>
    
    
    
    

     
     				<interceptor-ref name="myInterceptor"></interceptor-ref>
    
    
    
    

     
     			</interceptor-stack>
    
    
    
    

     
     		</interceptors>
    
    
    
    

     
     		
    
    
    
    

     
     		<action name="printUsername" class="cn.sun.action.PrintUsername">
    
    
    
    

     
     			<result name="toPrintUsernameJSP">/page_interceptor/printUsername.jsp</result>
    
    
    
    

     
     			<interceptor-ref name="myInterceptorStack"></interceptor-ref>
    
    
    
    

     
     		</action>
    
    
    
    

     
     	</package>
    
    
    
    

     
     </struts>
    
    
   
   

以上配置便是将默认拦截器栈加入到自定义拦截器栈，这样所有功能就完善了。

         但是我们会发现之前是将自定义拦截器栈放入到当前action中的，这样做有一个不好的地方就是每次新加入一个action就得配一次拦截器栈，所以我们可以将之设置成默认栈，这样就不用每次单独配置：

   
   

    
    

     
     <?xml version="1.0" encoding="UTF-8"?>
    
    
    
    

     
      <!DOCTYPE struts PUBLIC
    
    
    
    

     
     	"-//Apache Software Foundation//DTD Struts Configuration 2.3//EN"
    
    
    
    

     
     	"http://struts.apache.org/dtds/struts-2.3.dtd" >
    
    
    
    

     
      
    
    
    
    

     
     <struts>
    
    
    
    

     
     	<constant name="struts.devMode" value="true"></constant>
    
    
    
    

     
     	<package name="anyone" namespace="/" extends="struts-default">
    
    
    
    

     
     		<!-- <action name="login" class="cn.sun.action.LoginAction">
    
    
    
    

     
     			<result name="toOkJSP">/ok.jsp</result>
    
    
    
    

     
     			<result name="toNoJSP">/no.jsp</result>
    
    
    
    

     
     		</action> -->
    
    
    
    

     
     		
    
    
    
    

     
     		<interceptors>
    
    
    
    

     
     			<interceptor name="myInterceptor" class="cn.sun.interceptor.MyInterceptor"></interceptor>
    
    
    
    

     
     			<interceptor-stack name="myInterceptorStack">
    
    
    
    

     
     				<interceptor-ref name="defaultStack"></interceptor-ref>
    
    
    
    

     
     				<interceptor-ref name="myInterceptor"></interceptor-ref>
    
    
    
    

     
     			</interceptor-stack>
    
    
    
    

     
     		</interceptors>
    
    
    
    

     
     		
    
    
    
    

     
     		<default-interceptor-ref name="myInterceptorStack"></default-interceptor-ref>
    
    
    
    

     
     		
    
    
    
    

     
     		<action name="printUsername" class="cn.sun.action.PrintUsername">
    
    
    
    

     
     			<result name="toPrintUsernameJSP">/page_interceptor/printUsername.jsp</result>
    
    
    
    

     
     		</action>
    
    
    
    

     
     	</package>
    
    
    
    

     
     </struts>