Struts2 拦截器详细配置过程拦截指定的一个方法或多个方法教程汇总。

在Action中使用拦截器，默认情况下回拦截Action中所有的方法，但是在某些情况下，可能只需要拦截Action中的一个或多个方法，有时候也希望不拦截某个方法，这个在Struts2中是怎么实现的呢 ？

拦截器方法过滤：让拦截器有选择的拦截Action中的某个方法！

Struts2中提供了一个MethodFilterInterceptor类，开发者自定义的拦截器只需要继承该类就可以使用这个方法过滤的功能，来拦截Action中特定的方法！

查看API文档 可以看到这个类为：

1. /*
2.  * Copyright 2002-2006,2009 The Apache Software Foundation.
3.  *
4.  * Licensed under the Apache License, Version 2.0 (the ”License”);
5.  * you may not use this file except in compliance with the License.
6.  * You may obtain a copy of the License at
7.  *
8.  *      http://www.apache.org/licenses/LICENSE-2.0
9.  *
10.  * Unless required by applicable law or agreed to in writing, software
11.  * distributed under the License is distributed on an ”AS IS” BASIS,
12.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13.  * See the License for the specific language governing permissions and
14.  * limitations under the License.
15.  */
17. package com.opensymphony.xwork2.interceptor;
19. import com.opensymphony.xwork2.ActionInvocation;
20. import com.opensymphony.xwork2.util.TextParseUtil;
21. import com.opensymphony.xwork2.util.logging.Logger;
22. import com.opensymphony.xwork2.util.logging.LoggerFactory;
24. import java.util.Collections;
25. import java.util.Set;
28. /**
29.  * <!– START SNIPPET: javadoc –>
30.  *
31.  * MethodFilterInterceptor is an abstract <code>Interceptor</code> used as
32.  * a base class for interceptors that will filter execution based on method
33.  * names according to specified included/excluded method lists.
34.  *
35.  * <p/>
36.  *
37.  * Settable parameters are as follows:
38.  *
39.  * <ul>
40.  *      <li>excludeMethods - method names to be excluded from interceptor processing</li>
41.  *      <li>includeMethods - method names to be included in interceptor processing</li>
42.  * </ul>
43.  *
44.  * <p/>
45.  *
46.  * <b>NOTE:</b> If method name are available in both includeMethods and
47.  * excludeMethods, it will be considered as an included method:
48.  * includeMethods takes precedence over excludeMethods.
49.  *
50.  * <p/>
51.  *
52.  * Interceptors that extends this capability include:
53.  *
54.  * <ul>
55.  *    <li>TokenInterceptor</li>
56.  *    <li>TokenSessionStoreInterceptor</li>
57.  *    <li>DefaultWorkflowInterceptor</li>
58.  *    <li>ValidationInterceptor</li>
59.  * </ul>
60.  *
61.  * <!– END SNIPPET: javadoc –>
62.  *
63.  * @author <a href=’mailto:the_mindstorm[at]evolva[dot]ro’>Alexandru Popescu</a>
64.  * @author Rainer Hermanns
65.  *
66.  * @see org.apache.struts2.interceptor.TokenInterceptor
67.  * @see org.apache.struts2.interceptor.TokenSessionStoreInterceptor
68.  * @see com.opensymphony.xwork2.interceptor.DefaultWorkflowInterceptor
69.  * @see com.opensymphony.xwork2.validator.ValidationInterceptor
70.  *
71.  * @version $Date: 2009-12-27 19:18:29 +0100 (Sun, 27 Dec 2009) $ $Id: MethodFilterInterceptor.java 894090 2009-12-27 18:18:29Z martinc $
72.  */
73. public abstract class MethodFilterInterceptor extends AbstractInterceptor {
74.     protected transient Logger log = LoggerFactory.getLogger(getClass());
76.     protected Set<String> excludeMethods = Collections.emptySet();
77.     protected Set<String> includeMethods = Collections.emptySet();
79.     public void setExcludeMethods(String excludeMethods) {
80.         this.excludeMethods = TextParseUtil.commaDelimitedStringToSet(excludeMethods);
81.     }
83.     public Set<String> getExcludeMethodsSet() {
84.         return excludeMethods;
85.     }
87.     public void setIncludeMethods(String includeMethods) {
88.         this.includeMethods = TextParseUtil.commaDelimitedStringToSet(includeMethods);
89.     }
91.     public Set<String> getIncludeMethodsSet() {
92.         return includeMethods;
93.     }
95.     @Override
96.     public String intercept(ActionInvocation invocation) throws Exception {
97.         if (applyInterceptor(invocation)) {
98.             return doIntercept(invocation);
99.         }
100.         return invocation.invoke();
101.     }
103.     protected boolean applyInterceptor(ActionInvocation invocation) {
104.         String method = invocation.getProxy().getMethod();
105.         // ValidationInterceptor
106.         boolean applyMethod = MethodFilterInterceptorUtil.applyMethod(excludeMethods, includeMethods, method);
107.         if (log.isDebugEnabled()) {
108.             if (!applyMethod) {
109.                 log.debug(“Skipping Interceptor… Method [" + method + "] found in exclude list.”);
110.             }
111.         }
112.         return applyMethod;
113.     }
115.     /**
116.      * Subclasses must override to implement the interceptor logic.
117.      *
118.      * @param invocation the action invocation
119.      * @return the result of invocation
120.      * @throws Exception
121.      */
122.     protected abstract String doIntercept(ActionInvocation invocation) throws Exception;
124. }

是AbstractInterceptor拦截器的子类，实现了Interceptor和Serializable接口

MethodFilerInterceptor实现方法过滤中用到的两个参数

主要方法：

①protected abstract String doIntercept(ActionInvocation invocation) throws Exception;  必须重写此方法，实现拦截。

②String interceptor(ActionInvocation invocation):继承自AbstractInterceptor类，方法不需要强制重写

③void setExcludeMethods(String excludeMethods):设置拦截器黑名单，参数为Action一方法名。拦截器不拦截该方法

④void setIncludeMethods(String includeMethods):设置拦截器白名单，参数为Action一方法名。拦截器会拦截该方法

⑤Set<String> getExcludeMethodsSet()：获得拦截器的黑名单

⑥Set<String> getIncludeMethodsSet()：获得拦截器的白名单

一般开发者只需要重写doIntercept方法即可！下面给出一个实例：

一。实现方法过滤的拦截器实现类：FilterInterceptor.java继承自MethodFilterInterceptor类

1. package com.yaxing.interceptor;
3. import java.util.Date;
5. import com.opensymphony.xwork2.ActionInvocation;
6. import com.opensymphony.xwork2.interceptor.MethodFilterInterceptor;
8. public class FilterInterceptor extends MethodFilterInterceptor {
9.     private String name;
12.     public String getName() {
13.         return name;
14.     }
17.     public void setName(String name) {
18.         this.name = name;
19.     }
22.     @Override
23.     protected String doIntercept(ActionInvocation invocation) throws Exception {
24.         // TODO Auto-generated method stub
25.         FilterAction fa= (FilterAction)invocation.getAction();
26.         System.out.println(name+”拦截器在Action执行前拦截”+new Date());
27.         String result=invocation.invoke();
28.         System.out.println(name+”拦截器在Action执行后拦截”+new Date());
29.         return result;
30.     }
32. }

在该类中name属性用来标识拦截器的名称，方便控制台的输出

二。Action：业务控制器FilterAction.java

1. package com.yaxing.interceptor;
3. import com.opensymphony.xwork2.ActionSupport;
5. public class FilterAction extends ActionSupport {
6.     private String msg;
8.     public String getMsg() {
9.         return msg;
10.     }
12.     public void setMsg(String msg) {
13.         this.msg = msg;
14.     }
15.     public String method1() throws Exception {
16.         System.out.println(“Action执行方法：method1（）”);
17.         return SUCCESS;
18.     }
19.     public String method2() throws Exception {
20.         System.out.println(“Action执行方法：method2（）”);
21.         return SUCCESS;
22.     }
24.     public String method3() throws Exception {
25.         System.out.println(“Action执行方法：method3（）”);
26.         return SUCCESS;
27.     }
30. }

三。配置文件struts.xml

1. <?xml version=”1.0″ encoding=”UTF-8″ ?>
2. <!DOCTYPE struts PUBLIC ”-//Apache Software Foundation//DTD Struts Configuration 2.1//EN” ”http://struts.apache.org/dtds/struts-2.1.dtd”>
3. <struts>
4. <package name=”filterexample” extends=”struts-default” namespace=”/ch5″>
5.     <interceptors>
6. <!–定义拦截器–>
7.         <interceptor name=”Myinterceptor” class=”com.yaxing.interceptor.Myinterceptor”></interceptor>
8.         <interceptor name=”SimpleInterceptor” class=”com.yaxing.interceptor.SimpleInterceptor”></interceptor>
9.         <interceptor name=”FilterInterceptor” class=”com.yaxing.interceptor.FilterInterceptor”></interceptor>
10.     </interceptors>
11.     <action  name=”Reg” class=”com.yaxing.interceptor.Reg” method=”execute”>
12.            <result name=”success”>/Success.jsp</result>
13.            <result name=”input”>/Reg.jsp</result>
14.            <interceptor-ref name=”defaultStack”></interceptor-ref>
15.            <interceptor-ref name=”SimpleInterceptor”></interceptor-ref>
16.     </action>
17.     <action name=”FilterAction” class=”com.yaxing.interceptor.FilterAction”>
18.             <result name=”success”>/MethodFilter.jsp</result>
19. <!–使用拦截器–>
20.             <interceptor-ref name=”defaultStack”></interceptor-ref>
21.             <interceptor-ref name=”FilterInterceptor”>
22. <!–拦截器黑白名单–>
23.                  <param name=”includeMethods”>method1</param>
24.                  <param name=”excludeMethods”>method2</param>
25. <!–指定参数name的值–>
26. <param name=”name”>FilterMethod</param>
27.             </interceptor-ref>
30.     </action>
32. </package>
34. </struts>

四。jsp视图 MethodFilter.jsp

1. <%@ page language=”java” import=”java.util.*” pageEncoding=”UTF-8″%>
2. <%@ taglib prefix=”s” uri=”/struts-tags” %>
4. <!DOCTYPE HTML PUBLIC ”-//W3C//DTD HTML 4.01 Transitional//EN”>
5. <html>
6.   <head>
9.     <title>My JSP ’MethodFilter.jsp’ starting page</title>
11.     <meta http-equiv=”pragma” content=”no-cache”>
12.     <meta http-equiv=”cache-control” content=”no-cache”>
13.     <meta http-equiv=”expires” content=”0″>
14.     <meta http-equiv=”keywords” content=”keyword1,keyword2,keyword3″>
15.     <meta http-equiv=”description” content=”This is my page”>
16.     <!–
17.     <link rel=”stylesheet” type=”text/css” href=”styles.css”>
18.     –>
20.   </head>
22.   <body>
23.     <s:form id=”id” action=”FilterAction!method1.action”>
24.        <s:textfield name=”msg” label=”请输入信息:”/>
25.        <s:submit value=”提交”/>
26.     </s:form>
27.   </body>
28. </html>

五：运行结果：

①

可以看出method1方法拦截了。而method2方法是放到了黑名单中。

②将JSP视图中action 换成FilterAction!method2.action 输出信息

因为指定method2为黑名单，不会拦截，因此是没有拦截信息的。

③将JSP视图中action 换成FilterAction!method3.action 输出信息

可以看到，虽然没有在黑名单中指定method3，因为配置文件显示指定了白名单，所以拦截器只拦截白名单中指定的方法！

本文出自 “幽灵柯南的技术blog” 博客，请务必保留此出处http://enetq.blog.51cto.com/479739/542619

http://www.cnblogs.com/ribavnu/archive/2013/03/15/2960891.html

Struts2 拦截器详细配置过程

1:所有拦截器的超级接口Interceptor ,Action去实现这个接口;

 Interceptor 它其中有三个方法(init(),destroy() ,interceptor()):

      Init()方法:在服务器起动的时候加载一次,并且只加载一次;

      Destroy()方法:当拦截器销毁时执行的方法;

      Interceptor()方法:其中里边有一个参数invocation

public String intercept(ActionInvocation invocation) throws xception {

       System.out.println(“interceptor!!”);

       String result=invocation.invoke();

       return result;

    }

Invocation.invoke()是如果只有一个拦截器执行完这个方法后,会返回给视图,如果有多个拦截器,它顺序的执行完所有的拦截器,才返回给视图.

2:可以在系统初始化中给拦截器指定默认的参数(也包括了定义拦截器方式)如下:

    在拦截器类中把hello当做属性set/get方式注入到拦截器类中;

      <interceptors>

           <!– 先定义拦截器 –>

           <interceptor name=”myInterceptor” class=”com.zzz.struts2.interceptor.MyInterceptor”>

              <!– 指定系统初始化给拦截器的参数 –>

              <param name=”hello”>张钊钊</param>

           </interceptor>

           <!– 加到自己设置的拦截器栈里边去 –>

           <interceptor-stack name=”myStack”>

              <interceptor-ref name=”myInterceptor”>

              </interceptor-ref>

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

           </interceptor-stack>

       </interceptors>

       <!– 改变系统默认的拦截器,改成自己的默认拦截器,并且一个系统只能有一个默认的拦截器,这样这个拦截器栈会默认应用到所有的Action上去 –>

       <default-interceptor-ref name=”myStack”>

       </default-interceptor-ref>

       也可以在使用拦截器的时候给它设置参数:

       就是在一个action 的reslut下面配置上如下:

    <action name=”register”

           class=”com.zzz.struts2.action.RegisterAction”>

           <result name=”success”>/success.jsp</result>

           <!– result 它其中还有一个信息转发类型 type=”"记住，如果不转向JSP，转向图表，可以改变type=”"值 –>

           <result name=”input”>/register.jsp</result>

           <interceptor-ref name=”myInterceptor”>

              <param name=”hello”>welcome</param>

           </interceptor-ref>

           <interceptor-ref name=”myStack”></interceptor-ref>

       </action>

2.拦截器,拦截器栈和默认的拦截器之间的关系

1:拦截器和拦截器栈是一个级别的,也就是说一个拦截器栈中包括许多拦截器, 一个拦截器栈中还可以包括许多拦截器栈,配置如下方式:

<interceptors>

           <!– 先定义拦截器 –>

           <interceptor name=”myInterceptor” class=”com.zzz.struts2.interceptor.MyInterceptor”>

              <!– 指定系统初始化给拦截器的参数 –>

              <param name=”hello”>张钊钊</param>

           </interceptor>

           <!– 加到自己设置的拦截器栈里边去 –>

           <interceptor-stack name=”myStack”>

              <interceptor-ref name=”myInterceptor”>

              </interceptor-ref>

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

           </interceptor-stack>

       </interceptors>

拦截器的使用:1.先定义;2.在引用使用;

<interceptor name=”myInterceptor” class=”com.zzz.struts2.interceptor.MyInterceptor”>

<interceptor-ref name=”myInterceptor”>

              </interceptor-ref>

 2:struts2中有一个系统默认的拦截器栈是 defaultStack,如果你手动引用自己的拦截器,系统默认的拦截器栈将不起作用;这样必需手动引入系统的拦截器栈<interceptor-ref name=”defaultStack”>

              </interceptor-ref>

如果想改变系统默认的拦截器栈,可以这样配置:

<default-interceptor-ref name=”myStack”>

</default-interceptor-ref>其中myStack是自己定义的拦截器栈名字;

如果拦截器栈中有多个拦截器,在执行action之前的顺序跟配置拦截器的顺序一致,而在action之后执行的顺序是相反的;

3:抽象的拦截器类AbstractInterceptor

1:Interceptor这个超级拦截器接口,有三方法需要实现,但是如果不想使用init();

    和destroy()方法,可以去继承这个抽象拦截器类;

它的使用跟上边的没有什么区别;

4:方法过滤拦截器MethodFilterInterceptor

1:上边的拦截器都要是针对整个action的,如果针对某个方法进行拦截可以去继承这个类;

它的使用跟上边的使用方法差不多,只是需要要配置它对那个方法进行拦截,方法过滤拦截器最好不要配置到自己设置默认的拦截器栈里边,自己手动配置.

interceptor-ref name=”myInterceptor3″>

              <param name=”includeMethods”>execute</param>

              <param name=”excludeMethods”>execute</param>

           </interceptor-ref>

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

其中includeMethods ,excludeMethods是固定写法: includeMethods 包含拦截那些方法,多个方法需要用”,”隔开; excludeMehtods是排除拦截的那些方法;

5:鉴听器PreResultListener接口

1:它的鉴听点在拦截器执行完某个action方法后,在渲染视图之前做一些事情；让某个类去实现这个接口；

然后向需要它的拦截器中注册进去如下代码：

publicclass MyInterceptor3 extends MethodFilterInterceptor {

    privatestaticfinallongserialVersionUID = 3756655410194005443L;

    @Override

    protected String doIntercept(ActionInvocation invocation) throws Exception {

       //把鉴听器注册到拦截中去;

       invocation.addPreResultListener(new MyListener());

       System.out.println(“my Interceptor3″);

       String result=arg0.invoke();

       System.out.println(“my interceptor3 finshed!”);

       return result;

    }

}http://blog.sina.com.cn/s/blog_67196ddc0100ncnh.html

Struts2自定义拦截器实例—登陆权限验证