1. 程式人生 > >Struts2註解詳解

Struts2註解詳解

使用註解來配置Action的最大好處就是可以實現零配置,但是事務都是有利有弊的,使用方便,維護起來就沒那麼方便了。 

要使用註解方式,我們必須新增一個額外包:struts2-convention-plugin-2.x.x.jar。 

雖說是零配置的,但struts.xml還是少不了的,配置如下: 

<?xml version="1.0" encoding="UTF-8" ?>
 
<!DOCTYPE struts PUBLIC
 
    "-//Apache Software Foundation//DTD Struts Configuration 2.1.7//EN"
 
    "http://struts.apache.org/dtds/struts-2.1.7.dtd">
 
<struts>  
 
    <!-- 請求引數的編碼方式-->
 
    <constant name="struts.i18n.encoding" value="UTF-8"/>
 
    <!-- 指定被struts2處理的請求字尾型別。多個用逗號隔開-->
 
    <constant name="struts.action.extension" value="action,do,htm"/>
 
    <!-- 當struts.xml改動後,是否重新載入。預設值為false(生產環境下使用),開發階段最好開啟  -->
 
    <constant name="struts.configuration.xml.reload" value="true"/>
 
    <!-- 是否使用struts的開發模式。開發模式會有更多的除錯資訊。預設值為false(生產環境下使用),開發階段最好開啟  -->
 
    <constant name="struts.devMode" value="false"/>  
 
    <!-- 設定瀏覽器是否快取靜態內容。預設值為true(生產環境下使用),開發階段最好關閉  -->
 
    <constant name="struts.serve.static.browserCache" value="false" />
 
    <!-- 指定由spring負責action物件的建立-->
    <constant name="struts.objectFactory" value="spring" />
 
    <!-- 是否開啟動態方法呼叫-->
 
    <constant name="struts.enable.DynamicMethodInvocation" value="false"/>
 
</struts>
action類的註解:
package com.tjcyjd.web.action;    
import org.apache.struts2.convention.annotation.Action;  
import org.apache.struts2.convention.annotation.ExceptionMapping;  
import org.apache.struts2.convention.annotation.ExceptionMappings;  
import org.apache.struts2.convention.annotation.Namespace;  
import org.apache.struts2.convention.annotation.ParentPackage;  
import org.apache.struts2.convention.annotation.Result;  
import org.apache.struts2.convention.annotation.Results;   
import com.opensymphony.xwork2.ActionSupport;  
/**
 * Struts2基於註解的Action配置
 * 
 */  
@ParentPackage("struts-default")
 
@Namespace("/annotation_test")
 
@Results( { @Result(name = "success", location = "/main.jsp"),
 
           @Result(name = "error", location = "/error.jsp") })
 
@ExceptionMappings( { @ExceptionMapping(exception = "java.lange.RuntimeException", result = "error") })
 
public class LoginAction extends ActionSupport {
 
    private static final long serialVersionUID = 2730268055700929183L; 
 
    private String loginName;  
    private String password;     
 
    @Action("login") //或者寫成  @Action(value = "login") 
    public String login() throws Exception {  
        if ("yjd".equals(loginName) && "yjd".equals(password)) {  
            return SUCCESS;  
        } else {  
            return ERROR;  
        }  
    }  
 
    @Action(value = "add", results = { @Result(name = "success", location = "/index.jsp") })  
    public String add() throws Exception {  
        return SUCCESS;  
    }   <br>
    public String getLoginName() {  
        return loginName;  
    }  
    public void setLoginName(String loginName) {  
        this.loginName = loginName;  
    }  
    public String getPassword() {  
        return password;  
    }  
    public void setPassword(String password) {  
        this.password= password;  
    }  
 
}

最後在web.xml中配置一下

<filter>
  	<filter-name>struts2</filter-name>
  	<filter-class>
  		org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter
  	</filter-class>
  	<init-param>
        <param-name>actionPackages</param-name> 
        <param-value>com.ssh</param-value> <!-- 填寫action所在包完整包名 -->
    </init-param> 
 
</filter><filter-mapping> <filter-name>struts2</filter-name> <url-pattern>/*</url-pattern> </filter-mapping>

總結常用的註解如下:

Namespace:指定名稱空間 ParentPackage:指定父包 Result:提供了Action結果的對映(一個結果的對映) Results:“Result”註解列表 ResultPath:指定結果頁面的基路徑 Action:指定Action的訪問URL Actions:“Action”註解列表 ExceptionMapping:指定異常對映(對映一個宣告異常) ExceptionMappings:一級宣告異常的陣列 InterceptorRef:攔截器引用 InterceptorRefs:攔截器引用組 重點解析: @ParentPackage,這個註解對應了xml檔案中的package節點,它只有一個屬性叫value,其實就是package的name屬性; @Namespace,名稱空間,也就是xml檔案中<package>的namespace屬性;
@Action,這個註解對應<action>節點。這個註解可以應用於action類上,也可以應用於方法上。這個註解中有幾個屬性:   value(),表示action的URL,也就是<action>節點中的name屬性;   results(),表示action的多個result;這個屬性是一個數組屬性,因此可以定義多個Result;   interceptorRefs(),表示action的多個攔截器。這個屬性也是一個數組屬性,因此可以定義多個攔截器;     params(),這是一個String型別的陣列,它按照name/value的形式組織,是傳給action的引數;   exceptionMappings(),這是異常屬性,它是一個ExceptionMapping的陣列屬性,表示action的異常,在使用時必須引用相應的攔截器; @Result,這個註解對應了<result>節點。這個註解只能應用於action類上。這個註解中也有幾個屬性:   name(),表示action方法的返回值,也就是<result>節點的name屬性,預設情況下是【success】;   location(),表示view層檔案的位置,可以是相對路徑,也可以是絕對路徑;   type(),是action的型別,比如redirect; params(),是一個String陣列。也是以name/value形式傳送給result的引數;

使用struts2註解需要注意的幾個問題:

1.在使用struts2註解的時候如何跳轉從一個action跳轉到另一個action

@Result(name = "insertProfessionalCourse",  params={"actionName","cultivateTeachtask","namespace","/cultivate","method","beforeInsertProfessionalCourse"}, type = "chain")

2.如果沒有配置@Namespace註解,那麼他是如何對映的呢

以前在用struts2的註解配置時總是要在web.xml中配置一個初始化引數(actionPackages),最近發現不靈了,仔細研究了下發現即使不用在web.xml中配置也能成功,但時靈時不靈的,很是糾結原來在新版本中的註解配置是要依賴一個struts2-convention-plugin-2.1.8.1.jar的包,而這個包會預設依次檢索包名裡含有struts,struts2,action,actions的包,然後它會對實現了Action介面以及類名以Action結尾的這些類,作為Action來進行處理。

對映規則

對於以Action結尾的的類,去掉Action,取剩下的部分,將所有的字母轉換為小寫,如果有駝峰式的寫法,則用"-"連線符來連線不同的單詞,這是此外掛的預設方式。最終轉換之後的就是請求地址

例:

com.han.action.OrderAction                  

這個類按照上面的規則,那麼它的請求地址就應該是去年後面的Action,前面的Order全部轉換成小寫,那麼最後的請求地址就是 /order.action

預設名稱空間

我們平時一般還有名稱空間的問題,在這裡面是如果你的包名裡面在struts,sturts2,action,action2的後面還有其它的話,那麼後面的部分就預設為名稱空間

例:

com.han.action.other.OrderAction 

按上面所說的那麼這個最終的請求地址就為:/other/order.action 預設的名稱空間為: other

類名使用駝峰命名法的解析規則

它的預設解析規則為"-"連線符來連線不同的單詞

例:

com.han.action.UserOrderAction

這個請求地址就為:/user-order.action

包名裡含有struts,struts2,action,actions(struts的優先順序高於action)等關鍵字時的解析規則 例: com.han.struts.action.OrderAction     請求地址為:  /action/order.action
com.han.action.struts.OrderAction     請求地址為:  /order.action
自定義關鍵字

那麼如果我們不想按照它預設的這幾種關鍵字來檢索呢?有辦法,那就是通過struts.xml的常量配置來修改它檢索的關鍵字:

<constant name="struts.convention.package.locators" value="han" />

這樣就讓它預設的檢索為包名裡是否含有han來判定action了