详解Struts2拦截器机制

我会带着你远行 2021-12-08 22:45 226阅读 0赞

**Struts2**的核心在于它复杂的拦截器，几乎70%的工作都是由**拦截器**完成的。总之，在整个Struts框架中拦截器的作用是相当大的，本篇将从以下几点详细介绍下有关Struts拦截器的内容：

1.  拦截器在Struts中的作用
2.  自定义拦截器实现类
3.  配置拦截器（包含配置默认拦截器）
4.  引用拦截器
5.  配置拦截指定方法的拦截器
6.  拦截器的拦截顺序

## 一、拦截器在Struts中的作用 ##

在我们的web.xml中，我们配置了一个过滤器，实现将所有请求交付StrutsPrepareAndExecuteFilter类。一旦接受到任意action的请求，该类会创建和初始化一个ActionProxy实例，它代理了具体的action，在其中我们可以添加任意拦截器在execute方法执行之前和之后做一些额外的操作，最终会调用该action实例的execute方法，为用户返回视图结果字符串，然后系统会根据该视图结果字符串调取相应的视图页面。下图是拦截器和action之间的关系：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1pERlhO_size_16_color_FFFFFF_t_70]  
这是一种典型的AOP思想，当我们在Struts.xml中定义一个包的时候，大部分情况下我们会继承struts-default文件，所以虽然我们在自己的配置文件中并没有手动配置任何的拦截器，但是我们创建的action却被很多拦截器拦截处理，就是因为struts-default中配置的拦截器生效了。Struts中内建了很多的拦截器，他们大多被配置在struts-default文件中，详细的内建拦截器的介绍可以参考官方API，接下来我们看如何自定义一个拦截器。

## 二、自定义拦截器实现类 ##

想要实现自己的拦截器类只需要实现 com.opensymphony.xwork2.interceptor.Interceptor.Interceptor 接口即可，该接口中有如下几个方法：

**public abstract void init();**  
**public abstract void destroy();**  
**public abstract String intercept(ActionInvocation paramActionInvocation) throws Exception;**  
init 方法在执行拦截方法之前回调，主要用于初始化一些资源，destroy 与init 方法对应，在拦截器实例被销毁之前回调，主要用于释放在init 方法中打开的资源。intercept 方法是我们的拦截方法，我们可以重写该方法来完成对action实例的拦截，该方法具有一个ActionInvocation 类型的参数，该参数内部引用了具体的action实例对象（如果该action还有其他拦截器的话），我们可以调用该参数的invoke方法调用具体action实例的execute方法或者调用下一个拦截器，intercept方法返回一个String 类型的字符串代表了具体视图页面。下面看个具体的例子：

public class TestAction extends ActionSupport {  
    	public String execute(){  
    		System.out.println("执行execute方法......"); 
    		return SUCCESS;
    	}
    }
    public class MyIntercept implements Interceptor {  
    	public void init() { }
    	public void destroy() { } 
    	public String intercept(ActionInvocation action) throws Exception{ 
    		System.out.println("拦截action开始......."); 
    		String result = action.invoke(); 
    		System.out.println("拦截action结束.......");
    		return result; 
    	}
    }

省略了配置拦截器和TestAction 的代码，下图是上述程序运行的结果截图：  
![在这里插入图片描述][20190715222756492.png]

## 三、配置和引用拦截器 ##

上述的示例定义了一个简单的拦截器实现类，我们省略了在struts.xml中配置和引用该拦截器的代码，本小节将详细的介绍如何在struts.xml中定义和引用我们自定义实现的拦截器类。

从struts-default.xml中我们可以看出来，我们使用元素定义拦截器name和物理位置的配对，例如：

上述代码定义了一个拦截器test，它对应于具体的一个class。需要注意的是，定义拦截器的元素 interceptors 及其子元素必须被配置在某个package包下。

以上只是定义了一个拦截器和具体拦截器实现类之间的映射关系，但是想要实现对某个具体的action的拦截需要使用元素根据name属性值引用一个上述已经定义了的拦截器。例如：

<action name="test" class="MyPackage.TestAction">
    	<interceptor-ref name="test"/>
    	<result name="success">/index.jsp</result>
    	...... ...... 
    </action>

正如上述代码展示的一样，该元素用于引用一个已经定义好了的拦截器，并且该元素出现在具体的action内部，表明了该action具有一个test拦截器。以上代码实现了对单个拦截器的定义和引用，其实对于拦截器栈（一堆拦截器的组合）来说配置也是类似的。定义一个拦截器栈的代码是如下的：

<interceptor-stack name="拦截器栈名"> 
    	<interceptor-ref name="拦截器一"/> 
    	<interceptor-ref name="拦截器二"/> 
    	<interceptor-ref name="拦截器三"/> 
    	..... 
    </interceptor-stack>

引用一个拦截器栈就没什么区别了：

<interceptor-ref name="拦截器栈名"/>

当然我们也可以通过

<default-interceptor-ref name="拦截器名"/>

配置默认拦截器或者拦截器栈，如果该包下某个action没有显式指定拦截器，那么就会调用该默认拦截器，否则如果显式配置了拦截器，那么默认拦截器将会失效。

## 四、为Action中指定方法配置拦截器 ##

在默认情况下，我们为action配置了拦截器之后，该拦截器将会拦截该action中所有的方法，这有时候会给我们带来麻烦，当然struts为我们提供API用来针对具体的某个方法配置拦截器。这里涉及到一个抽象类：MethodFilterInterceptor。该类实际上实现了Interceptor并完成了一些默认实现，我们简单看看其中的代码：

public abstract class MethodFilterInterceptor extends AbstractInterceptor { 
    	//该set集合保存了该拦截器不需要拦截的所有方法 
    	protected Set<String> excludeMethods = Collections.emptySet(); 
    	//该set集合保存了所有该拦截器需要拦截的方法 
    	protected Set<String> includeMethods = Collections.emptySet(); 
    	//省略getter，setter方法 
    	//用于拦截action的入口 
    	public String intercept(ActionInvocation invocation) throws Exception { 
     		if (applyInterceptor(invocation)) { 
     			return doIntercept(invocation); 
     		}
     		return invocation.invoke(); 
     	}
     	//判断当前需要调用的action处理逻辑方法是否需要被此拦截器拦截 
     	protected boolean applyInterceptor(ActionInvocation invocation) { 
     		String method = invocation.getProxy().getMethod(); 
     		boolean applyMethod = MethodFilterInterceptorUtil.applyMethod(this.excludeMethods, this.includeMethods, method); 
     		if ((this.log.isDebugEnabled()) && (!applyMethod)) { 
     			this.log.debug("Skipping Interceptor... Method [" + method + "] found in exclude list.", new String[0]); 
     		} 
     		return applyMethod; 
     	} 
     	//这是需要我们重写的方法，具体作用下文介绍 
     	protected abstract String doIntercept(ActionInvocation paramActionInvocation) throws Exception; 
     }

从上述代码中可以看出，该抽象类实现了Interceptor接口并完成了基本的实现。除此之外，该类提供了两个集合用于保存该拦截器需要拦截的所有方法和不需要拦截的所有方法，拦截器入口intercept中会首先判断此次请求action实例中的逻辑处理方法是否需要被该拦截器拦截，如果需要被拦截，那么将会调用doIntercept我们自己实现的拦截器逻辑。否则直接调用invoke方法执行处理逻辑。所以一般来说，我们只需要重写doIntercept方法完成拦截器的核心处理即可。

当然此处需要注意一点的是，用于判断当前请求的处理逻辑方法是否需要被该拦截器拦截的方法applyInterceptor是在intercept中进行校验的，也就是说在执行doIntercept方法之前excludeMethods和includeMethods的值应当是已经初始化完毕了的。所以我们在doIntercept中再次为这两个属性赋值是没用的，因为已经完成了校验。一般我们在struts.xml中为这两个属性赋值，因为该配置文件是先被加载的。下面我们看个实例：

//自定义一个拦截器 
    public class MyIntercept extends MethodFilterInterceptor { 
    	protected String doIntercept(ActionInvocation action) throws Exception{ 
    		System.out.println("拦截开始......");
    		String result = action.invoke();
    		System.out.println("拦截结束......");
    		return result; 
    	}
    }

//引用该拦截器并指定不需要拦截的方法 
    <action name="test" class="MyPackage.TestAction">
    	<interceptor-ref name="test">
    		<param name="excludeMethods">execute</param>
    	</interceptor-ref>
    	<result name="success">/index.jsp</result>
    </action>

下面我们看运行的结果截图：  
![在这里插入图片描述][2019071522480340.png]  
显然我们指明了该拦截器不用拦截方法execute，当然结果显示的也是如我们所愿。如果我们修改上述struts.xml中内容：

<action name="test" class="MyPackage.TestAction">
    	<interceptor-ref name="test">
    		<param name="includeMethods">execute</param>
    	</interceptor-ref>
    	<result name="success">/index.jsp</result>
    </action>

我们指定该execute方法是需要被拦截器拦截的，下面运行的结果截图：  
![在这里插入图片描述][20190715224917593.png]  
当然如果需要指定多个方法需要被拦截或者不用被拦截，可以使用英文逗号隔开这些方法，例如：

最后还有一点是：如果一个方法既被放在了includeMethods中也被放在了excludeMethods中，那么框架将会选择拦截该方法。

## 五、有关拦截器机制的其他一些细节 ##

拦截器的执行顺序是按照引用拦截器的顺序决定的，例如我们定义两个拦截器：

<action name="test" class="MyPackage.TestAction">
    	<interceptor-ref name="test"/>
    	<interceptor-ref name="test2"/>
    	<result name="success">/index.jsp</result> </action>

也就是说第一个拦截器拦截action之后，会调用invoke方法，如果还有其他拦截器则会调用下一个拦截器，一层层嵌套，最后结束最外层的拦截器。

上述实例中我们使用param参数为拦截器类中的includeMethods属性赋值，但是如果是一个拦截器栈中我们有该如何为其中某个具体的拦截器属性赋值呢？

<interceptor-ref name="拦截器栈">
    	<param name="拦截器一.属性名">属性值</param>
    </interceptor-ref>

至此，我们简单了解了有关struts2中拦截器器的相关知识，如需深刻理解还要在具体项目中体会。

## 菜鸟共同学习---->QQ58971227 ##

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1pERlhO_size_16_color_FFFFFF_t_70]: /images/20211209/3311248561184985831a084ba205dee6.png
[20190715222756492.png]: /images/20211209/d8dee5e222aa493bab8ff01a38d0fcd6.png
[2019071522480340.png]: /images/20211209/e7684408430f4bd3b6047903abca78eb.png
[20190715224917593.png]: /images/20211209/05893cd2c7ea4dac86b2cee285a0dea3.png