Struts2-03-拦截器（BOS物流项目用户登录拦截）

一.拦截器概述

1.拦截器

在AOP中用于在某个方法或字段被访问之前，进行拦 截然后在之前或之后加入某些操作。拦截是AOP的一种实现策略。
Webwork的中文文档的解释为:拦截器——动态拦截action调用的对象。它提供了一种机制可以使开发者定义在一个action执行的前后执行的代码，也可以在一个action执行前阻止其执行。同时也提供了一种可以提取action中可重用的部分的方式。

2.拦截器链

Interceptor Chain (在 Struts 2 中称为拦截器栈 Interceptor Stack) ，拦截器链就是将拦截器按一定的顺序联结成一条链。在访问被拦截的方法或字段时，拦截器链中的拦截器就会按其之前定义的顺序被调用。

3.拦截器的实现原理

1. 大部分时候，拦截器方法都是通过代理的方式来调用的。Struts2的拦截器实现相对简单。当请求到达 Struts2 的ServletDispatcher时 ，Struts2会查找配置文件，并根据其配置实例化相对的拦截器对象，然后串成一个列表，最后一个一个地调用列表中的拦截器。
2. Struts2拦截器是可插拔的，拦截器是AOP的一种实现。Struts2拦截器栈将拦截器按一定的顺序联结成一条链。在访问被拦截的方法或字段时，Struts2拦截器链中的拦截器就会按其之前定义的顺序被调用。

二.自定义拦截器

方式一：实现Interceptor接口

如果需要开发自己的拦截器，就需要直接或间接的实现com.opensymphony.xwork2.interceptor.Interceptor接口，其源代码如下：

public interface Interceptor extends Serializable {
    void destroy();
    void init();
    String intercept(ActionInvocation actionInvocation) throws Exception;
}

该接口提供了三个方法：

void init( )

该方法在拦截器被创建后会立即被调用，它在拦截器的生命周期内只被调用1次.可以在该方法中对相关资源进行必要的初始化。

void destroy( )

该方法与init方法相对应，在拦截器实例被销毁之前，将调用该方法来释放和拦截器相关的资源。它在拦截器的生命周期内，也只被调用1次。

String intercept(ActionInvocation invocation) throws Exception

该方法是拦截器的核心方法， 用来添加真正执行拦截工作的代码，实现具体的拦截操作。它返回—个字符串作为逻辑视图，系统根据返回的字符串跳转到对应的视图资源。每拦截一个动作请求，该方法就会被调用一次。该方法的Actionlnvocation参数包含了被拦截的Action的引用，可以通过该参 数的invoke( )方法，将控制权转给下一个栏截器或者转给Action的execute()方法。 创建自定义拦截器实现Interceptor接口的三个方法即可。

方式二：继承AbstractInterceptor类（常用）

该类实现了Interceptor ，并且提供了init()方法和destroy()方法的空实现。 使用时，可以直接继承该抽象类，而不用实现那些不必要的方法。拦截器类Abstractlnterceptor中定 义的方法如下所示：

public interface Interceptor extends Serializable {
    public void destroy();
    public void init();
    public String intercept(ActionInvocation actionInvocation) throws Exception;
}

从上述代码中可以看出，Abstractlnterceptor类己经实现了Interceptor接口的所有方法，一般情况下，只需继承Abstractlnterceptor类 ，实现 interceptor()方法就可以创建自定义拦截器。
只有当自定义的拦截器需要打开系统资源时，才需要覆盖Abstractlnterceptor类 的 init()方法和 destroy()方法。与实现Interceptor接口相比，继承Abstractlnterceptor类的方法更为简单。

三.拦截器的配置

拦截器在struts.xml文件中配置

1. 配置拦截器

<interceptor name="MyInterceptor" class="com.itheima.bos.web.interceptor.MyInterceptor">
        <param name="excludeMethods">login</param>
</interceptor>

标签	标签属性
< interceptor >标签	name：定义拦截器名称，class：拦截器的全路径名
< param >标签	name：参数名称

2. 配置拦截器栈

<interceptor-stack name="myStack">
        <interceptor-ref name="MyInterceptor"></interceptor-ref>
        <interceptor-ref name="defaultStack"></interceptor-ref>
</interceptor-stack>

标签	功能	标签属性
< interceptor-stack >标签	用于配置拦截器栈	name：定义拦截器栈名称
< interceptor-ref >标签	用于在拦截器栈中配置拦截器	name：引用拦截器名称

在拦截器栈中还可以引入拦截器栈，如上代码所示，自定义拦截器栈中配置了一个拦截器MyInterceptor和一个拦截器栈defaultStack（默认拦截器栈，必须引入）

四.BOS物流项目–用户登陆拦截

功能分析：

如果用户没有登陆，则用户发送任意请求后转到登陆页面
1.在web.xml中配置自定义拦截器

<interceptors>
        <!-- 1注册自定义拦截器 -->
        <interceptor name="bosLoginInterceptor" class="com.itheima.bos.web.interceptor.BOSLoginInterceptor">
            <!-- 设置参数(指定哪些方法不需要拦截) -->
            <param name="excludeMethods">login</param>
        </interceptor>
        <!-- 2.定义一个拦截器栈myStack，包含一个拦截器栈和一个拦截器 -->
        <interceptor-stack name="myStack">
            <interceptor-ref name="bosLoginInterceptor"></interceptor-ref>
            <interceptor-ref name="defaultStack"></interceptor-ref>
        </interceptor-stack>
</interceptors>
<default-interceptor-ref name="myStack"/>

<!-- 全局结果集定义(给拦截器使用) -->
<global-results>
    <result name="login">/login.jsp</result>
</global-results>

2.创建自定义拦截器
通过继承MethodFilterInterceptor类创建自定义拦截器，MethodFilterInterceptor中可以设置哪些方法不用拦截，需要在拦截器的配置中加入param参数

public class BOSLoginIntercepter extends MethodFilterInterceptor {
    @Override
    protected String doIntercept(ActionInvocation actionInvocation) throws Exception {
        //1.从session中获取登陆用户对象
        User user = (User) ServletActionContext.getRequest().getSession().getAttribute("loginUser");
        if(user == null){
            //2.没有登录，跳转到登录页面
            return "login";
        }
        //3.放行
        return actionInvocation.invoke();

    }
}

MethodFilterInterceptor 抽象类的部分代码：

public abstract class MethodFilterInterceptor extends AbstractInterceptor {
    protected transient Logger log = LoggerFactory.getLogger(this.getClass());
    protected Set<String> excludeMethods = Collections.emptySet();
    protected Set<String> includeMethods = Collections.emptySet();

    public MethodFilterInterceptor() {
    }

    public void setExcludeMethods(String excludeMethods) {
        this.excludeMethods = TextParseUtil.commaDelimitedStringToSet(excludeMethods);
    }

    public Set<String> getExcludeMethodsSet() {
        return this.excludeMethods;
    }