java struts 实现拦截器-mile米乐体育

struts2的拦截器和servlet过滤器类似。在执行action的execute方法之前，struts2会首先执行在struts.xml中引用的拦截器，在执行完所有引用的拦截器的intercept方法后，会执行action的execute方法。

struts2拦截器类必须从com.opensymphony.xwork2.interceptor.interceptor接口继承，在intercepter接口中有如下三个方法需要实现：

void destroy(); void init(); string intercept(actioninvocation invocation) throws exception;

其中intercept方法是拦截器的核心方法，所有安装的拦截器都会调用之个方法。在struts2中已经在struts-default.xml中预定义了一些自带的拦截器，如timer、params等。如果在标签中继承struts-default，则当前package就会自动拥有struts-default.xml中的所有配置。代码如下：

…

在struts-default.xml中有一个默认的引用，在默认情况下（也就是中未引用拦截器时）会自动引用一些拦截器。这个默认的拦截器引用如下：

                                                                                    dojo/..*                           input,back,cancel,browse                         input,back,cancel,browse       

上面在defaultstack中引用的拦截器都可以在中不经过引用就可以使用（如果在中引用了任何拦截器后，要使用在defaultstack中定义的拦截器，也需要在中重新引用，在后面将详细讲解）。

下面我们来看几个简单的拦截器的使用方法。

一、记录拦截器和execute方法的执行时间(timer)

timer是struts2中最简单的拦截器，这个拦截器对应的类是com.opensymphony.xwork2.interceptor.timerinterceptor。它的功能是记录execute方法和其他拦截器（在timer后面定义的拦截器）的intercept方法执行的时间总和。如下面的配置代码所示：

由于在timer后面没有其他的拦截器定义，因此，timer只能记录execute方法的执行时间，在访问first动作时，会在控制台输出类似下面的一条信息：

信息: executed action [/test/first!execute] took 16 ms.

在使用timer拦截器时，需要commons-logging.jar的支持。将logger引用放到timer的后面，就可以记录logger拦截器的intercept方法和action的execute方法的执行时间总和，代码如下：

大家可以使用如下的action类来测试一下timer拦截器：

package action;  import com.opensymphony.xwork2.actionsupport;  public class firstaction extends actionsupport            {        public string execute() throws exception         {            thread.sleep(1000); // 延迟1秒            return null;        }  }

如果只记录execute方法的执行时间，一般会输出如下的信息：

信息: executed action [/test/first!execute] took 1000 ms.

二、通过请求调用action的setter方法(params)

当客户端的一个form向服务端提交请求时，如有一个textfield，代码如下：

在提交后，struts2将会自动调用first动作类中的setname方法，并将name文本框中的值通过setname方法的参数传入。实际上，这个操作是由params拦截器完成的，params对应的类是com.opensymphony.xwork2.interceptor.parametersinterceptor。由于params已经在defaultstack中定义，因此，在未引用拦截器的中是会自动引用params的，如下面的配置代码，在访问first动作时，struts2是会自动执行相应的setter方法的。

     ... ... 

但如果在中引用了其他的拦截器，就必须再次引用params拦截器，struts2才能调用相应的setter方法。如下面的配置代码所示：

三、通过配置参数调用action的setter方法(static-params)

static-params拦截器可以通过配置标签来调用action类的相应的setter方法，static-params拦截器对应的类是com.opensymphony.xwork2.interceptor.staticparametersinterceptor。

下面配置代码演示了如何使用static-params拦截器：

          比尔           

如果first动作使用上面的配置，在访问first动作时，struts2会自动调用setwho方法将“比尔”作为参数值传入setwho方法。

四、使用拦截器栈

为了能在多个动作中方便地引用同一个或几个拦截器，可以使用拦截器栈将这些拦截器作为一个整体来引用。拦截器栈要在标签中使用和子标签来定义。代码如下：

                                                                                               比尔                           

可以象使用拦截器一样使用拦截器栈，如上面代码所示。

拦截器的实现

 实现一个拦截器非常简单。实际上，一个拦截器就是一个普通的类，只是这个类必须实现com.opensymphony.xwork2.interceptor.interceptor接口。interceptor接口有如下三个方法：

public interface interceptor extends serializable  {     void destroy();     void init();     string intercept(actioninvocation invocation) throws exception; }

其中init和destroy方法只在拦截器加载和释放（都由struts2自身处理）时执行一次。而intercept方法在每次访问动作时都会被调用。struts2在调用拦截器时，每个拦截器类只有一个对象实例，而所有引用这个拦截器的动作都共享这一个拦截器类的对象实例，因此，在实现interceptor接口的类中如果使用类变量，要注意同步问题。

下面我们来实现一个简单的拦截器，这个拦截器通过请求参数action指定一个拦截器类中的方法，并调用这个方法（我们可以使用这个拦截器对某一特定的动作进行预处理）。如果方法不存在，或是action参数不存在，则继续执行下面的代码。如下面的url：

http://localhost:8080/struts2/test/interceptor.action?action=test

访问上面的url后，拦截器会就会调用拦截器中的test方法，如果这个方法不存在，则调用invocation.invoke方法，invoke方法和servlet过滤器中调用filterchain.dofilter方法类似，如果在当前拦截器后面还有其他的拦截器，则invoke方法就是调用后面拦截器的intercept方法，否则，invoke会调用action类的execute方法（或其他的执行方法）。

下面我们先来实现一个拦截器的父类actioninterceptor。这个类主要实现了根据action参数值来调用方法的功能，代码如下：

package interceptor;  import com.opensymphony.xwork2.actioninvocation; import com.opensymphony.xwork2.interceptor.interceptor; import javax.servlet.http.*; import org.apache.struts2.*;  public class actioninterceptor implements interceptor {     protected final string invoke = "##invoke";      public void destroy()     {         system.out.println("destroy");     }      public void init()     {         system.out.println("init");     }      public string intercept(actioninvocation invocation) throws exception     {             httpservletrequest request = servletactioncontext.getrequest();         string action = request.getparameter("action");         system.out.println(this.hashcode());         if (action != null)         {             try             {                 java.lang.reflect.method method = this.getclass().getmethod(action);                 string result = (string)method.invoke(this);                 if(result != null)                 {                     if(!result.equals(invoke))                         return result;                 }                 else                     return null;             }             catch (exception e)             {             }         }         return invocation.invoke();     } }

从上面代码中的intercept方法可以看出，在调用action所指定的方法后，来判断返回值。可能发生的情况有三种：

1.返回值为null，执行return null。

2.返回值为invoke，执行return invockation.invoke()。

3.其他情况，执行return result。 result表示指定方法的返回值，如上面代码所示。

在实现完上面的拦截器父类后，任何继承于actioninterceptor类的拦截器都可以自动根据action的参数值调用自身的相应方法。下面我们来实现一个拥有两个动作方法test和print的拦截器类。代码如下：

package interceptor;  import javax.servlet.http.httpservletresponse; import org.apache.struts2.servletactioncontext;  public class multimethodinterceptor extends actioninterceptor {     public string test() throws exception     {         httpservletresponse response = servletactioncontext.getresponse();         response.getwriter().println("invoke test");         return this.invoke;     }      public string print() throws exception     {         httpservletresponse response = servletactioncontext.getresponse();         response.getwriter().println("invoke print");          return null;     } }

test方法返回了invoke，因此，在执行完这个方法后，struts2会接着调用其他拦截器的intercept方法或action类的execute方法。而print方法在执行完后，只是返回了null，而不再调用其他的方法了，也就是访问如下的url时，动作的execute方法将不会执行：

http://localhost:8080/struts2/test/ddd.action?action=print

下面我们来实现一个action类，代码如下：

package action;  import org.apache.struts2.*; import com.opensymphony.xwork2.actionsupport;  public class interceptoraction extends actionsupport {     public string abcd() throws exception     {         servletactioncontext.getresponse().getwriter()                 .println("invoke abcd");         return null;     } }

在这个action类中，只有一个abcd方法，实际上，这个方法相当于execute方法，在下面会设置动作的method属性为abcd。下面我们来在struts.xml中定义拦截器类和动作，代码如下：

在配置上面的methodstack拦截器时要注意，最好在后面引用defaultstack，否则很多通过拦截器提供的功能将失去。

ok，现在访问如下的url：

http://localhost:8080/struts2/test/ddd.action?action=test

在浏览器中将会出现如下的字符串：

invoke test

invoke abcd

而如果访问http://localhost:8080/struts2/test/ddd.action?action=print，将会只出现如下的字符串：

invoke print

大家可以看出，访问这个url时并没有调用abcd方法。如果随便指定的action值的话，则只调用abcd方法，如访问http://localhost:8080/struts2/test/ddd.action?action=aaa，就只会输出invoke abcd。

拦截器的参数

我们在使用很多struts2内置的拦截器时会发现有很多拦截器都带参数，当然。我们自己做的拦截器也可以加上同样的参数。有两个参数比较常用，这两个参数是includemethods和excludemethods，其中includemethods指定了拦截器要调用的action类的执行方法（默认是execute），也就是说，只有在includemethods中指定的方法才会被struts2调用，而excludemethods恰恰相反，在这个参数中指定的执行方法不会被struts2调用。如果有多个方法，中间用逗号(,)分隔。在struts2中提供了一个抽象类来处理这两个参数。这个类如下：

com.opensymphony.xwork2.interceptor.methodfilterinterceptor

如有继承于这个类的拦截器类都会自动处理includemethods和excludemethods参数，如下面的拦截器类所示：

package interceptor;  import com.opensymphony.xwork2.actioninvocation; import com.opensymphony.xwork2.interceptor.*;  public class myfilterinterceptor extends methodfilterinterceptor {     private string name;     public string getname()     {         return name;     }     public void setname(string name)     {         this.name = name;     }     @override     protected string dointercept(actioninvocation invocation) throws exception     {         system.out.println("dointercept");         system.out.println(name);         return invocation.invoke();     } }

methodfilterinterceptor的子类需要实现dointercept方法（相当于interceptor的intercept方法），如上面代码所示。在上面的代码中还有一个name属性，是为了读取拦截器的name属性而设置的，如下面的配置代码所示：

                                                                   abcd                     中国                                                                                                                                                                 

再次访问http://localhost:8080/struts2/test/ddd.action?action=test, struts2就会调用myfilterinterceptor的dointercept方法来输出name属性值。如果将上面的includemethods参数值中的abcd去掉，则action类的abcd方法不会被执行。