struts2 拦截器

Struts2中的拦截器（特别重要）

      1、拦截器的重要性

                     Struts2中的很多功能都是由拦截器完成的。比如：servletConfig，staticParam，params，modelDriven等等。

                     是AOP编程思想的一种应用形式。

      2、拦截器的执行时机：

                    

      3、自定义拦截器

           3.1、拦截器的类试图(初级版本)：

        

           3.2、编写步骤：

                     a、编写一个类，继承AbstractInterceptor类或者实现Interceptor接口。重写intercept方法。    

package com.itheima.web.interceptor;

import com.opensymphony.xwork2.ActionInvocation;
import com.opensymphony.xwork2.interceptor.AbstractInterceptor;
/**
 * 自定义拦截器
 *     第一步：创建一个普通类，继承AbstractInterceptor，实现抽象方法intercept
 *  第二步：在struts.xml中配置拦截器
 *       1.声明拦截器
 *          <interceptors>
                <interceptor name="demo1Interceptor" class="com.itheima.web.interceptor.Demo1Interceptor" />
            </interceptors>
         2.使用拦截器
             <!-- 使用自定义拦截器：当配置了任何一个拦截器，默认的拦截器栈就不会在工作了 -->
            <interceptor-ref name="demo1Interceptor"></interceptor-ref>
 * @author zhy
 *
 */
public class Demo1Interceptor extends AbstractInterceptor {

    public String intercept(ActionInvocation invocation) throws Exception {
        System.out.println("Demo1Interceptor拦截器：拦截了-执行动作方法之前");
        //放行：如果有下一个拦截器，就前往下一个拦截器，如果没有了，就到达动作方法
        String rtValue = invocation.invoke();//就是结果视图的名称
        System.out.println("Demo1Interceptor拦截器：拦截了-执行动作方法之后");
        return rtValue;
    }

}

                     b、配置拦截器：注意拦截器必须先声明再使用

             　　　　注意： 在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" />
    <package name="p1" extends="struts-default">
        <!-- 声明自定义拦截器 -->
        <interceptors>
            <interceptor name="demo1Interceptor" class="com.itheima.web.interceptor.Demo1Interceptor"></interceptor>
            <interceptor name="demo2Interceptor" class="com.itheima.web.interceptor.Demo2Interceptor"></interceptor>
        </interceptors>
        <action name="action1" class="com.itheima.web.action.Demo1Action" method="save">
            <!-- 使用自定义拦截器：当配置了任何一个拦截器，默认的拦截器栈就不会在工作了 .
                当有多个拦截器的时候，是由引用配置决定执行的顺序 。 注意：执行顺序与声明无关-->
            <interceptor-ref name="demo2Interceptor"></interceptor-ref>
            <interceptor-ref name="demo1Interceptor"></interceptor-ref>
            <result name="success">/demo1.jsp</result>
        </action>
    </package>

           3.3、执行顺序

                          见前面的执行时机图

           3.4、多个拦截器的执行顺序

                  　　在动作方法执行之前， 拦截器执行顺序与配置（不是声明）顺序正相关

　　　　　　　在动作方法执行之后， 拦截器执行顺序与配置（不是声明 ）顺序负相关

           3.5、intercept方法的返回值

                       return      invocation.invoke();   返回的就是 结果视图（seccess，input，error等）

      4、拦截器的应用：

            4.1、检查登录的拦截器案例

                      配置文件：

                    

<!-- 使用自定义拦截器，检查登录。最基本的配置方式。
         其中存在的问题：
             当我们使用了自定义拦截器之后，默认的拦截器栈就不再工作了 -->
    <package name="p2" extends="struts-default">
        <interceptors>声明拦截器
            <interceptor name="checkLoginInterceptor" class="com.itheima.web.interceptor.CheckLoginInterceptor" />
        </interceptors>
        <global-results>全局结果视图
            <result name="input">/login.jsp</result>数据回显的结果视图
        </global-results>
        用户登录时，不需要检查登录的拦截器工作
        <action name="login" class="com.itheima.web.action.Demo2Action" method="login">
            <result type="redirectAction">showMain</result>
        </action>
        前往主页的动作名称，需要检查登录的拦截器工作
        <action name="showMain" class="com.itheima.web.action.Demo2Action" >
            <interceptor-ref name="checkLoginInterceptor"></interceptor-ref>
            <result>/main.jsp</result>
        </action>
        前往另一个页面的动作名称，需要检查登录的拦截器工作
        <action name="showOther" class="com.itheima.web.action.Demo2Action" >
            <interceptor-ref name="checkLoginInterceptor"></interceptor-ref>
            <result>/otherpage.jsp</result>
        </action>
    </package>

                     动作类：

                          

package com.itheima.web.action;

import javax.servlet.http.HttpSession;

import org.apache.struts2.ServletActionContext;

import com.opensymphony.xwork2.ActionSupport;

public class Demo2Action extends ActionSupport {
    
    
    /**
     * 用户登录的方法
     * @return
     */
    public String login(){
        HttpSession session = ServletActionContext.getRequest().getSession();
        session.setAttribute("user", "test");
        return SUCCESS;
    }
    

    
    /**
     * 无论是显示主页还是显示另一个页面都执行此方法，
     * 返回成功
     */
    public String execute(){
        return SUCCESS;
    }
}

                     拦截器：

                        

package com.itheima.web.interceptor;

import javax.servlet.http.HttpSession;

import org.apache.struts2.ServletActionContext;

import com.opensymphony.xwork2.ActionInvocation;
import com.opensymphony.xwork2.interceptor.AbstractInterceptor;
/**
 * 检查登录的拦截器,初级版本
 * @author zhy
 *
 */
public class CheckLoginInterceptor extends AbstractInterceptor {

    public String intercept(ActionInvocation invocation) throws Exception {
        //1.获取HttpSession
        HttpSession session = ServletActionContext.getRequest().getSession();
        //2.获取session域中的登录标记
        Object obj = session.getAttribute("user");
        //3.判断是否有登录标记
        if(obj == null){
            //用户没有登录
            return "input";
        }
        //4.用户登录了，放行
        String rtValue = invocation.invoke();
        return rtValue;
    }

}

                     页面：

                    

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
    <head>
        <title>主页：检查登录的拦截器</title>
    </head>
    <body>
        <%--要想来到本页面（主页），必须得先登录 --%>
        主页<hr/>
        <a href="${pageContext.request.contextPath}/showOther.action">访问另一个页面</a>
    </body>
</html>

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
    <head>
        <title>用户登录</title>
    </head>
    <body>
        <form action="${pageContext.request.contextPath}/login.action" method="post">
            用户名：<input type="text" name="username"/><br/>
            密码：<input type="password" name="password"/><br/>
            <input type="submit" value="登录"/>
        </form>
    </body>
</html>

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
    <head>
        <title>另一个页面</title>
    </head>
    <body>
        另一个页面
    </body>
</html>

           4.2、案例中的问题

                            问题：由于我们写了自己的拦截器，默认的拦截器不起作用了。

                     解决办法：

                            a、把默认拦截器加入到配置文件中

                           

<!-- a.针对上面的问题，我们的解决办法是，把默认的拦截器栈也配置进来.
    <package name="p2" extends="struts-default">
        <interceptors>
            <interceptor name="checkLoginInterceptor" class="com.itheima.web.interceptor.CheckLoginInterceptor" />
        </interceptors>
        <global-results>
            <result name="input">/login.jsp</result>
        </global-results>
        <action name="login" class="com.itheima.web.action.Demo2Action" method="login">
            <result type="redirectAction">showMain</result>
        </action>
        <action name="showMain" class="com.itheima.web.action.Demo2Action" >
            加入自定义拦截器,和默认的拦截器栈
            <interceptor-ref name="defaultStack"></interceptor-ref>
            <interceptor-ref name="checkLoginInterceptor"></interceptor-ref>
            <result>/main.jsp</result>
        </action>
        <action name="showOther" class="com.itheima.web.action.Demo2Action" >
            加入自定义拦截器,和默认的拦截器栈
            <interceptor-ref name="defaultStack"></interceptor-ref>
            <interceptor-ref name="checkLoginInterceptor"></interceptor-ref>
            <result>/otherpage.jsp</result>
        </action>
    </package>-->

                     b、a中暴露的问题：当有多个拦截器时，需要改写的地方非常多。

                            解决办法：抽取公共的包，把全局配置放入公共包中。

                    

<!-- b. a中存在的弊端，当如果需要拦截的动作很多时，写起来很繁琐
    <package name="p2" extends="struts-default">
        <interceptors>
            <interceptor name="checkLoginInterceptor" class="com.itheima.web.interceptor.CheckLoginInterceptor" />
            定义一个拦截器栈,把我们自定义的拦截器和默认的拦截器栈放到一起.
            <interceptor-stack name="myDefaultStack">
                <interceptor-ref name="defaultStack"></interceptor-ref>
                <interceptor-ref name="checkLoginInterceptor"></interceptor-ref>
            </interceptor-stack>
        </interceptors>
        <global-results>
            <result name="input">/login.jsp</result>
        </global-results>
        <action name="login" class="com.itheima.web.action.Demo2Action" method="login">
            <result type="redirectAction">showMain</result>
        </action>
        <action name="showMain" class="com.itheima.web.action.Demo2Action" >
            直接引入我们自己定义的拦截器栈,里面已经包含了默认的拦截器栈
            <interceptor-ref name="myDefaultStack"></interceptor-ref>
            <result>/main.jsp</result>
        </action>
        <action name="showOther" class="com.itheima.web.action.Demo2Action" >
            直接引入我们自己定义的拦截器栈,里面已经包含了默认的拦截器栈
            <interceptor-ref name="myDefaultStack"></interceptor-ref>
            <result>/otherpage.jsp</result>
        </action>
    </package> -->
    
    <!-- c. b中存在的问题，还需要在每个要用到地方使用拦截器引用。
         解决办法：使用覆盖struts-default.xml配置文件中的默认拦截器栈，让我们的这个称为默认的-->
    
    <package name="p2" extends="struts-default">
        <interceptors>
            <interceptor name="checkLoginInterceptor" class="com.itheima.web.interceptor.CheckLoginInterceptor" />
            <interceptor-stack name="myDefaultStack">
                <interceptor-ref name="defaultStack"></interceptor-ref>
                <interceptor-ref name="checkLoginInterceptor"></interceptor-ref>
            </interceptor-stack>
        </interceptors>
        覆盖了struts-default.xml中定义的默认拦截器栈。由myDefaultStack把defaultStack给替换了
        <default-interceptor-ref name="myDefaultStack"></default-interceptor-ref>
        <global-results>
            <result name="input">/login.jsp</result>
        </global-results>
        <action name="login" class="com.itheima.web.action.Demo2Action" method="login">
            <result type="redirectAction">showMain</result>
        </action>
        <action name="showMain" class="com.itheima.web.action.Demo2Action" >
            <result>/main.jsp</result>
        </action>
        <action name="showOther" class="com.itheima.web.action.Demo2Action" >
            <result>/otherpage.jsp</result>
        </action>
    </package> 

                     c、b中的问题：还要再每个动作方法中引入拦截器。能不能不写呢？

                            思路：我们在设置【开发模式】时，覆盖掉了一个default.properties中的常量，能不能把struts-default.xml中的默认拦截器栈的设置给覆盖掉呢？答案是可以的。

 　　　　　　　　 解决办法：

                    

    <!-- c. b中存在的问题，还需要在每个要用到地方使用拦截器引用。
         解决办法：使用覆盖struts-default.xml配置文件中的默认拦截器栈，让我们的这个称为默认的 -->
    
    
    <package name="p2" extends="struts-default">
        <interceptors>
            <interceptor name="checkLoginInterceptor" class="com.itheima.web.interceptor.CheckLoginInterceptor" />
            <interceptor-stack name="myDefaultStack">
                <interceptor-ref name="defaultStack"></interceptor-ref>
                <interceptor-ref name="checkLoginInterceptor"></interceptor-ref>
            </interceptor-stack>
        </interceptors>
        覆盖了struts-default.xml中定义的默认拦截器栈。由myDefaultStack把defaultStack给替换了
        <default-interceptor-ref name="myDefaultStack"></default-interceptor-ref>
        <global-results>
            <result name="input">/login.jsp</result>
        </global-results>
        <action name="login" class="com.itheima.web.action.Demo2Action" method="login">
            <result type="redirectAction">showMain</result>
        </action>
        <action name="showMain" class="com.itheima.web.action.Demo2Action" >
            <result>/main.jsp</result>
        </action>
        <action name="showOther" class="com.itheima.web.action.Demo2Action" >
            <result>/otherpage.jsp</result>
        </action>
    </package>

                     d、c中出现的问题：当使用了默认拦截器栈，这时候三个动作login,showIndex和show1Action都将被检查登录的拦截器拦截。

                            解决办法：

                                          需要通过AbstractInterceptor类的子类入手，通过查看发现，该类还有一个子类是抽象的：

                                  

                                          所以我们在自定义拦截器时，还可以继承MethodFilterInterceptor并且重写doIntercept方法。

package com.itheima.web.interceptor;

import javax.servlet.http.HttpSession;

import org.apache.struts2.ServletActionContext;

import com.opensymphony.xwork2.ActionInvocation;
import com.opensymphony.xwork2.interceptor.MethodFilterInterceptor;
/**
 * 检查登录的拦截器,最终版本
 * @author zhy
 *
 */
public class CheckLoginInterceptor1 extends MethodFilterInterceptor {

    public String doIntercept(ActionInvocation invocation) throws Exception {
        //1.获取HttpSession
        HttpSession session = ServletActionContext.getRequest().getSession();
        //2.获取session域中的登录标记
        Object obj = session.getAttribute("user");
        //3.判断是否有登录标记
        if(obj == null){
            //用户没有登录
            return "input";
        }
        //4.用户登录了，放行
        String rtValue = invocation.invoke();
        return rtValue;
    }

}

                                   并且在struts的配置文件中，配置需要拦截哪些方法，和需要放过哪些方法。

         

    <!-- d. c中存在的问题，当我们配置了默认的拦截器栈时，连登陆都被拦截了。
        解决办法： 在AbstractInterceptor的子类中，还有一个抽象类MethodFilterInterceptor，它里面提供了两个属性。
                excludeMethods：哪些方法不需要拦截
                includeMethods：哪些方法需要拦截 -->
     
    <package name="p2" extends="struts-default">
        <interceptors>
            <interceptor name="checkLoginInterceptor1" class="com.itheima.web.interceptor.CheckLoginInterceptor1" />
            <interceptor-stack name="myDefaultStack">
                <interceptor-ref name="defaultStack"></interceptor-ref>
                <interceptor-ref name="checkLoginInterceptor1">
                    给自定义拦截器注入参数，告知他哪些方法不需要拦截
                    <param name="excludeMethods">login</param>
                </interceptor-ref>
            </interceptor-stack>
        </interceptors>
        <default-interceptor-ref name="myDefaultStack"></default-interceptor-ref>
        <global-results>
            <result name="input">/login.jsp</result>
        </global-results>
        <action name="login" class="com.itheima.web.action.Demo2Action" method="login">
            <result type="redirectAction">showMain</result>
        </action>
        <action name="showMain" class="com.itheima.web.action.Demo2Action" >
            <result>/main.jsp</result>
        </action>
        <action name="showOther" class="com.itheima.web.action.Demo2Action" >
            <result>/otherpage.jsp</result>
        </action>
    </package>

                            e、d中遗留的问题：我们在声明时配置了哪些方法需要拦截，哪些方法不需要拦截。但是在没有写动作类和动作方法之前，不确定方法名叫什么。

                                   解决办法：我们需要在使用拦截器的时候给它注入参数。

                           

<!-- e. d中的问题，我们在声明拦截器和定义拦截器栈的时候，可能根本不知道哪些方法需要拦截，哪些不需要
        解决办法：在使用拦截器的时候，注入参数，告诉拦截器哪些需要拦截，哪些不需要
     -->
    <package name="p2" extends="struts-default">
        <interceptors>
            <interceptor name="checkLoginInterceptor1" class="com.itheima.web.interceptor.CheckLoginInterceptor1" />
            <interceptor-stack name="myDefaultStack">
                <interceptor-ref name="defaultStack"></interceptor-ref>
                <interceptor-ref name="checkLoginInterceptor1"></interceptor-ref>
            </interceptor-stack>
        </interceptors>
        <default-interceptor-ref name="myDefaultStack"></default-interceptor-ref>
        <global-results>
            <result name="input">/login.jsp</result>
        </global-results>
        
        <action name="login" class="com.itheima.web.action.Demo2Action" method="login">
            <interceptor-ref name="myDefaultStack">
                <!-- 在引用自定义拦截器栈的时候，给指定的拦截器注入参数。方式就是：拦截器名称.属性名称 -->
                <param name="checkLoginInterceptor1.excludeMethods">login</param>
            </interceptor-ref>
            <result type="redirectAction">showMain</result>
        </action>
        <action name="showMain" class="com.itheima.web.action.Demo2Action" >
            <result>/main.jsp</result>
        </action>        
        <action name="showOther" class="com.itheima.web.action.Demo2Action" >
            <result>/otherpage.jsp</result>
        </action>
    </package>

           4.3、拦截器类视图（全）：

                                     

lanjieqi