struts2拦截器应用

一、实现拦截器需要实现 Interceptor 接口:

public class LoginInterceptor implements Interceptor {

 @Override
 public void destroy() {
 }
 @Override
 public void init() { 
 }
 @Override
 public String intercept(ActionInvocation invocation) throws Exception {
  // 取得请求的URL  
        String strUrl = ServletActionContext.getRequest().getRequestURL().toString();
        ActionContext ctx = ActionContext.getContext();
    HttpServletRequest request = (HttpServletRequest)ctx.get(ServletActionContext.HTTP_REQUEST);//获取request对象,进而获取session对象

//可以获取用户的session
    HttpSession session = request.getSession();
    SysUser user = (SysUser) session.getAttribute("user");
  
        if(strUrl.indexOf("doLoginRightAct!login")!=-1){  
            return invocation.invoke();  
        }else{
         if((!ServletActionContext.getRequest().isRequestedSessionIdValid())|| user==null){  
             ServletActionContext.getRequest().setAttribute("interceptMsg", "请重新登录系统");
             //session过期跳转至登录页面  
             return Action.LOGIN;
            }
        }
        return invocation.invoke();
 }

}

二、注册拦截器

  2.1  在项目中配置文件比较少时,业务也不复杂,拦截功能也简单,可以如下配置,拦截当前包下的所有请求。

<package name="basemanage" extends="json-default" namespace="/base">

   <interceptors>
            <interceptor name="loginInterceptor"  class="cn.interceptor.LoginInterceptor"></interceptor>
<interceptor-stack name="loginStack">    <interceptor-ref name="defaultStack"></interceptor-ref> <!-- 为了应用struts的默认拦截器,应该先将默认的放在前面 -->          <interceptor-ref name="loginInterceptor">
            <param name="includeMethods">getALL,getPart,listUser</param> <!-- 设置需要拦截的方法,多个以逗号隔开 -->
         </interceptor-ref> </interceptor-stack>   </interceptors>    <action name="userAct" class="useraction">      <!-- <interceptor-ref name="loginStack" /> 为该action注册拦截器 -->     <result name="success" type="json"></result>   </action>    <!-- 默认拦截器,此包下所有的ACTION将都被拦截。如果ACTION再定义了拦截器,则默认拦截器失效 --> <default-interceptor-ref name="loginStack"/>   <!--当返回login视图名时,转入/login.jsp页面--> <global-results>     <result name="login">/jsp/login.jsp</result>   </global-results> </package>

  2.2   配置文件比较多,拦截数据(请求)也复杂,可以配置多个拦截器。

<?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 name="struts.custom.i18n.resources" value="message" /> -->
    <!-- 是否自动加载国际化资源文件 -->
    <!-- <constant name="struts.i18n.reload" value="true" /> -->
    <!-- convention类重新加载 -->
    <!-- <constant name="struts.convention.classes.reload" value="true" /> -->
    <!-- 是否自动加载配置文件更改后 -->

    <!-- 调试模式 -->

    <constant name="struts.enable.DynamicMethodInvocation" value="false" />
    <constant name="struts.configuration.xml.reload" value="true" />
    <constant name="struts.action.excludePattern" value="/dwr/*.*,/dwr/test/*.*" />
    <constant name="struts.xslt.nocache" value="true" />
    <constant name="struts.ui.theme" value="simple" />
    <constant name="struts.i18n.encoding" value="UTF-8" />
    <constant name="struts.action.extension" value="action,do" />
    <constant name="struts.ognl.allowStaticMethodAccess" value="true" />
    <constant name="struts.enable.DynamicMethodInvocation" value="true" />
    <constant name="struts.multipart.saveDir" value="D:/upload" />
    <constant name="struts.multipart.maxSize" value="10485760" />

    <package name="default-core" abstract="true" extends="struts-default,json-default">
        <interceptors>
            <interceptor name="checkLogin" class="com.util.interceptor.CheckLoginInterceptor" />
            <interceptor-stack name="fontDefault">
                <interceptor-ref name="checkLogin" />
                <interceptor-ref name="json" />
                <interceptor-ref name="defaultStack" />
            </interceptor-stack>
            <interceptor-stack name="tokenFontDefault">
                <interceptor-ref name="checkLogin" />
                <interceptor-ref name="token" />
                <interceptor-ref name="json" />
                <interceptor-ref name="defaultStack" />
            </interceptor-stack>
            <interceptor-stack name="backDefault">
                <interceptor-ref name="checkLogin" />
                <interceptor-ref name="json" />
                <interceptor-ref name="defaultStack" />
            </interceptor-stack>
            <interceptor-stack name="tokenBackDefault">
                <interceptor-ref name="checkLogin" />
                <interceptor-ref name="token" />
                <interceptor-ref name="json" />
                <interceptor-ref name="defaultStack" />
            </interceptor-stack>
        </interceptors>
        <global-results>
            <result type="json">
                <param name="root">jsonMap</param>
            </result>
            <result name="error" type="redirect">/error.jsp</result>
            <result name="input" type="redirect">/error.jsp</result>
            <result name="login" type="redirect">/login.jsp</result>
        </global-results>
    </package>

    <!-- Add packages here -->
    <include file="/struts/struts-AdminAction.xml"></include>
    <include file="/struts/struts-user.xml"></include>
    
    <!-- Add packages here -->
</struts>

  struts-AdminAction.xml和struts-user.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>
    <!-- 舱单模块 -->
    <package name="admin" extends="default-core" namespace="/admin">

         <!-- 应用拦截器 -->
        <default-interceptor-ref name="fontDefault"/>
     <!--实现action不同命名空间的跳转 -->
        <action name="add" class="com.action.UserAction" method="add">
            <result name="success" type="redirectAction">
                <param name="namespace">/user</param>
                <param name="actionName">find?id=${user.id}</param>
            </result>
        </action>
        
        <!-- 显示添加界面-->
        <action name="addUI" class="com.action.DeliveryWarrantAction" method="addUI">
            <result name="success" >/jsp/userlist.jsp</result>
        </action>
        <!-- 更新-->
        <action name="update" class="com.action.DeliveryWarrantAction" method="update"/>
    </package>
</struts>        

三、拦截器执行顺序: 

拦截器是AOP中的概念,它本身是一段代码,可以通过定义“织入点”,来指定拦截器的代码在“织入点”的前后执行,从而起到拦截的作用。正如上面 Struts2的Reference中讲述的,Struts2的Interceptor,其拦截的对象是Action代码,可以定义在Action代码之前或者之后执行拦截器的代码。

接下来,我们将重点讨论一下Struts2中的拦截器的内部结构和执行顺序,并结合源码进行分析。

Interceptor结构
让我们再来回顾一下之前我们曾经用过的一张Action LifeCycle的图:

我在这里需要指出的是一个很重要的方法invocation.invoke()。这是ActionInvocation中的方法,而ActionInvocation是Action调度者,所以这个方法具备以下2层含义:

1. 如果拦截器堆栈中还有其他的Interceptor,那么invocation.invoke()将调用堆栈中下一个Interceptor的执行。

2. 如果拦截器堆栈中只有Action了,那么invocation.invoke()将调用Action执行。

所以,我们可以发现,invocation.invoke()这个方法其实是整个拦截器框架的实现核心。基于这样的实现机制,我们还可以得到下面2个非常重要的推论:

1. 如果在拦截器中,我们不使用invocation.invoke()来完成堆栈中下一个元素的调用,而是直接返回一个字符串作为执行结果,那么整个执行将被中止。

2. 我们可以以invocation.invoke()为界,将拦截器中的代码分成2个部分,在invocation.invoke()之前的代码,将会在Action之前被依次执行,而在invocation.invoke()之后的代码,将会在Action之后被逆序执行。

由此,我们就可以通过invocation.invoke()作为Action代码真正的拦截点,从而实现AOP。

Interceptor拦截类型

从上面的分析,我们知道,整个拦截器的核心部分是invocation.invoke()这个函数的调用位置。事实上,我们也正式根据这句代码的调用位置,来进行拦截类型的区分的。在Struts2中,Interceptor的拦截类型,分成以下三类:

1. before

before拦截,是指在拦截器中定义的代码,它们存在于invocation.invoke()代码执行之前。这些代码,将依照拦截器定义的顺序,顺序执行。

2. after

after拦截,是指在拦截器中定义的代码,它们存在于invocation.invoke()代码执行之后。这些代码,将一招拦截器定义的顺序,逆序执行。

Interceptor执行顺序

Interceptor的执行顺序或许是我们在整个过程中最最关心的部分。根据上面所提到的概念,我们实际上已经能够大致明白了Interceptor的执行机理。我们来看看Struts2的Reference对Interceptor执行顺序的一个形象的例子。
如果我们有一个interceptor-stack的定义如下:
Xml代码?
<interceptor-stack name="xaStack"> 
<interceptor-ref name="thisWillRunFirstInterceptor"/> 
<interceptor-ref name="thisWillRunNextInterceptor"/> 
<interceptor-ref name="followedByThisInterceptor"/> 
<interceptor-ref name="thisWillRunLastInterceptor"/> 
</interceptor-stack> 

那么,整个执行的顺序大概像这样:

在这里,我稍微改了一下Struts2的Reference中的执行顺序示例,使得整个执行顺序更加能够被理解。我们可以看到,递归调用保证了各种各样的拦截类型的执行能够井井有条。

请注意在这里,每个拦截器中的代码的执行顺序,在Action之前,拦截器的执行顺序与堆栈中定义的一致;而在Action和Result之后,拦截器的执行顺序与堆栈中定义的顺序相反。
原文地址:https://www.cnblogs.com/lbangel/p/3043483.html