Struts2 攔截器

攔截器在概念上與servlet過濾器或JDK代理類相同。攔截器允許橫切功能，把action以及框架分開實現(xiàn)。你可以使用攔截器實現(xiàn)以下操作：

• 在調(diào)用action之前提供預(yù)處理邏輯。

• 在調(diào)用action后提供后處理邏輯。

• 捕獲異常，以便可以執(zhí)行備用處理。

Struts2框架中提供的許多功能都是使用攔截器實現(xiàn)的，包括異常處理，文件上傳，生命周期回調(diào)和驗證等。事實上，由于Struts2將其大部分功能基于攔截器，因此不太可能為每個action分配7個或8個攔截器。

Struts2框架攔截器

Struts 2框架提供了一個良好的開箱即用的攔截器列表，這些攔截器預(yù)先配置好并可以使用。 下面列出了幾個重要的攔截器：

序號	攔截器和說明
1	alias 允許參數(shù)在請求之間使用不同的別名。
2	checkbox 通過為未檢查的復(fù)選框添加參數(shù)值false，以輔助管理復(fù)選框。
3	conversionError 將字符串轉(zhuǎn)換為參數(shù)類型的錯誤信息放置到action的錯誤字段中。
4	createSession 自動創(chuàng)建HTTP會話（如果尚不存在）。
5	debugging 為開發(fā)人員提供一些不同的調(diào)試屏幕。
6	execAndWait 當(dāng)action在后臺執(zhí)行時，將用戶發(fā)送到中間的等待頁面。
7	exception 映射從action到結(jié)果拋出的異常，允許通過重定向自動處理異常。
8	fileUpload 便于文件上傳。
9	i18n 在用戶會話期間跟蹤選定的區(qū)域。
10	logger 通過輸出正在執(zhí)行的action的名稱提供簡單的日志記錄。
11	params 設(shè)置action上的請求參數(shù)。
12	prepare 這通常用于執(zhí)行預(yù)處理工作，例如設(shè)置數(shù)據(jù)庫連接。
13	profile 允許記錄action的簡單分析信息。
14	scope 在會話或應(yīng)用程序范圍內(nèi)存儲和檢索action的狀態(tài)。
15	ServletConfig 提供可訪問各種基于servlet信息的action。
16	timer 以action執(zhí)行時間的形式提供簡單的分析信息。
17	token 檢查action的有效性，以防止重復(fù)提交表單。
18	validation 提供action的驗證支持。

你可以閱讀Struts 2文檔，了解上述攔截器的完整信息。接下來我們會告訴你如何在Struts應(yīng)用程序中使用攔截器。

如何使用攔截器？

讓我們看看如何在我們的“Hello World”程序中使用一個已經(jīng)存在的攔截器。我們將首先使用timer攔截器，目的是測量執(zhí)行action方法所需的時間。同時我們使用params攔截器，目的是將請求參數(shù)發(fā)送給action。你可以嘗試不在你的例子中使用這個攔截器，然后你會發(fā)現(xiàn)name屬性沒有被設(shè)置，因為參數(shù)無法發(fā)送給action。
我們可以保留HelloWorldAction.java，web.xml，HelloWorld.jsp和index.jsp文件，因為它們已在Hellow World示例一章中創(chuàng)建過了，然后讓我們參照下面修改struts.xml文件給它添加攔截器：

 
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE struts PUBLIC
   "-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"
   "http://struts.apache.org/dtds/struts-2.0.dtd">
<struts>
   <constant name="struts.devMode" value="true" />
   <package name="helloworld" extends="struts-default">
      <action name="hello" 
         class="cn.w3cschool.struts2.HelloWorldAction"
         method="execute">
         <interceptor-ref name="params"/>
         <interceptor-ref name="timer" />
         <result name="success">/HelloWorld.jsp</result>
      </action>
   </package>
</struts>

右鍵單擊項目名稱，然后單擊“Export”>“WAR File”創(chuàng)建WAR文件。然后在Tomcat的webapps目錄中部署這個WAR文件。最后，啟動Tomcat服務(wù)器并嘗試訪問URL http://localhost:8080/HelloWorldStruts2/index.jsp。結(jié)果如下圖所示：

現(xiàn)在，在給定文本框中輸入任意單詞，然后單擊Say Hello按鈕執(zhí)行定義的action。如果你去查看生成的日志，會看到以下文本：

INFO: Server startup in 3539 ms
27/08/2011 8:40:53 PM 
com.opensymphony.xwork2.util.logging.commons.CommonsLogger info
INFO: Executed action [//hello!execute] took 109 ms.

這里的最后一行是由timer攔截器生成的，是表示ation總共需要109ms來執(zhí)行。

創(chuàng)建自定義攔截器

在你的應(yīng)用程序中使用自定義攔截器是提供跨切割應(yīng)用程序功能的簡潔方式。創(chuàng)建自定義攔截器很容易，需要擴展的是以下Interceptor接口：

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

正如name所指出的，init()方法提供了一種初始化攔截器的方法，而destroy()方法為攔截器清理提供了一個工具。與action不同，攔截器在請求之間重復(fù)使用，需要線程安全，特別是intercept()方法。
ActionInvocation對象可訪問運行時的環(huán)境。它允許訪問action本身以及方法來調(diào)用action，并確定action是否已被調(diào)用。
如果你不需要初始化或清理代碼，可以擴展AbstractInterceptor類，以實現(xiàn)init()和destroy()的默認的無操作指令。

創(chuàng)建攔截器類

我們接下來在Java Resources>src文件夾中創(chuàng)建以下MyInterceptor.java文件：

 
package cn.w3cschool.struts2;

import java.util.*;
import com.opensymphony.xwork2.ActionInvocation;
import com.opensymphony.xwork2.interceptor.AbstractInterceptor;

public class MyInterceptor extends AbstractInterceptor {

   public String intercept(ActionInvocation invocation)throws Exception{

      /* let us do some pre-processing */
      String output = "Pre-Processing"; 
      System.out.println(output);

      /* let us call action or next interceptor */
      String result = invocation.invoke();

      /* let us do some post-processing */
      output = "Post-Processing"; 
      System.out.println(output);

      return result;
   }
}

你可以發(fā)現(xiàn)，實際中action將通過攔截器使用invocation.invoke()調(diào)用執(zhí)行，所以你可以根據(jù)你的需求做一些預(yù)處理和一些后處理。
框架本身通過第一次調(diào)用ActionInvocation對象的invoke()來啟動進程。每次調(diào)用invoke()時，ActionInvocation都會查詢其狀態(tài)，并執(zhí)行下一個攔截器。當(dāng)所有配置的攔截器都被調(diào)用時，invoke()將使得action本身被執(zhí)行。以下圖表通過請求流顯示了所說的概念：

創(chuàng)建Action類

我們在Java Resources>src文件夾下創(chuàng)建一個java文件HelloWorldAction.java，其中包名為cn.w3cschool.struts2，內(nèi)容如下：

package cn.w3cschool.struts2;

import com.opensymphony.xwork2.ActionSupport;

public class HelloWorldAction extends ActionSupport{
   private String name;

   public String execute() throws Exception {
      System.out.println("Inside action....");
      return "success";
   }  

   public String getName() {
      return name;
   }

   public void setName(String name) {
      this.name = name;
   }
}

這是我們在前面的例子中看到的同一個類，我們有“name”屬性標(biāo)準的getters和setter方法，以及返回字符串“success”的execute方法。

創(chuàng)建視圖

讓我們在你的eclipse項目的WebContent文件夾中創(chuàng)建下面的jsp文件HelloWorld.jsp。

<%@ page contentType="text/html; charset=UTF-8" %>
<%@ taglib prefix="s" uri="/struts-tags" %>
<html>
<head>
<title>Hello World</title>
</head>
<body>
   Hello World, <s:property value="name"/>
</body>
</html>

創(chuàng)建主頁

我們還需要在WebContent文件夾中創(chuàng)建index.jsp文件，此文件將用作初始的action URL，用戶可以單擊它以命令Struts 2框架調(diào)用HelloWorldAction類的定義方法并呈現(xiàn)HelloWorld.jsp視圖。

<%@ page language="java" contentType="text/html; charset=ISO-8859-1"
   pageEncoding="ISO-8859-1"%>
<%@ taglib prefix="s" uri="/struts-tags"%>
   <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" 
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>Hello World</title>
</head>
<body>
   <h1>Hello World From Struts2</h1>
   <form action="hello">
      <label for="name">Please enter your name</label><br/>
      <input type="text" name="name"/>
      <input type="submit" value="Say Hello"/>
   </form>
</body>
</html>

在上述視圖文件中定義的hello action將使用struts.xml文件映射到HelloWorldAction類及其execute方法中。

配置文件

現(xiàn)在我們需要注冊新的攔截器，然后調(diào)用它，因為我們在前面的例子中調(diào)用的是默認攔截器。要注冊一個新的攔截器，把<interceptors> ... </ interceptors>標(biāo)簽直接放置在<package>標(biāo)簽下的struts.xml文件中即可。對于默認攔截器，你可以跳過此步驟，就像我們前面的示例中所做的那樣。但現(xiàn)在讓我們使用以下方法注冊新的：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE struts PUBLIC
    "-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"
    "http://struts.apache.org/dtds/struts-2.0.dtd">

<struts>
   <constant name="struts.devMode" value="true" />
   <package name="helloworld" extends="struts-default">

      <interceptors>
         <interceptor name="myinterceptor"
            class="cn.w3cschool.struts2.MyInterceptor" />
      </interceptors>

      <action name="hello" 
         class="cn.w3cschool.struts2.HelloWorldAction" 
         method="execute">
         <interceptor-ref name="params"/>
         <interceptor-ref name="myinterceptor" />
         <result name="success">/HelloWorld.jsp</result>
      </action>

   </package>
</struts>

需要注意的是，你可以在<package>標(biāo)簽內(nèi)注冊多個攔截器，同時可以在<action>標(biāo)簽內(nèi)調(diào)用多個攔截器，也可以用不同的action調(diào)用同一個攔截器。

web.xml文件需要在WebContent下的WEB-INF文件夾下創(chuàng)建，如下所示：

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns="http://java.sun.com/xml/ns/javaee" 
   xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
   xsi:schemaLocation="http://java.sun.com/xml/ns/javaee 
   http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
   id="WebApp_ID" version="3.0">
   
   <display-name>Struts 2</display-name>
   <welcome-file-list>
      <welcome-file>index.jsp</welcome-file>
   </welcome-file-list>
   <filter>
      <filter-name>struts2</filter-name>
      <filter-class>
         org.apache.struts2.dispatcher.FilterDispatcher
      </filter-class>
   </filter>

   <filter-mapping>
      <filter-name>struts2</filter-name>
      <url-pattern>/*</url-pattern>
   </filter-mapping>
</web-app>

右鍵單擊項目名稱，然后單擊“Export”>“WAR File”以創(chuàng)建WAR文件。然后在Tomcat的webapps目錄中部署WAR文件。最后，啟動Tomcat服務(wù)器并嘗試訪問URL http://localhost:8080/HelloWorldStruts2/index.jsp。將顯示如下圖片：

現(xiàn)在，在給的定文本框中輸入任意單詞，然后單擊Say Hello按鈕執(zhí)行定義的action。如果你查看生成的日志，會在底部看到以下文本：

Pre-Processing
Inside action....
Post-Processing

攔截器堆棧

你可以想象，為每個action配置的多個攔截器將很快變得極其難以管理。為此，攔截器使用攔截器堆棧進行管理。這里是直接從struts-default.xml文件展示的一個例子：

<interceptor-stack name="basicStack">
   <interceptor-ref name="exception"/>
   <interceptor-ref name="servlet-config"/>
   <interceptor-ref name="prepare"/>
   <interceptor-ref name="checkbox"/>
   <interceptor-ref name="params"/>
   <interceptor-ref name="conversionError"/>
</interceptor-stack>

上面的堆棧稱為basicStack，可以如下所述在你的配置中使用，此配置節(jié)點放置在<package ... />節(jié)點下。<interceptor-ref ... />標(biāo)簽引用的是在當(dāng)前攔截器堆棧之前配置的攔截器或攔截器堆棧。因此非常重要的是在配置初始攔截器和攔截器堆棧時，確保name在所有攔截器和攔截器堆棧配置中是唯一的。
我們已經(jīng)學(xué)習(xí)了如何將攔截器應(yīng)用到action中，而攔截器堆棧的應(yīng)用也是類似的。事實上，使用的標(biāo)簽也是一樣的：

 
<action name="hello" class="com.tutorialspoint.struts2.MyAction">
   <interceptor-ref name="basicStack"/>
   <result>view.jsp</result>
</action

上述的“basicStack”注冊將完整注冊hello action的所使用的六個攔截器。要注意的是，攔截器按照它們被配置的順序執(zhí)行。例如，在上面的例子中，exception將首先執(zhí)行，第二個將是servlet-config等。