使用注解來配置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;
}
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;
}
}
這樣就完成了一個基於注解的action配置。
總結常用的注解如下:
Namespace:指定命名空間。 ParentPackage:指定父包。 Result:提供了Action結果的映射。(一個結果的映射) Results:“Result”注解列表 ResultPath:指定結果頁面的基路徑。 Action:指定Action的訪問URL。 Actions:“Action”注解列表。 ExceptionMapping:指定異常映射。(映射一個聲明異常) ExceptionMappings:一級聲明異常的數組。 InterceptorRef:攔截器引用。 InterceptorRefs:攔截器引用組。
實際上struts2中最主要的概念就是package、action以及Interceptor等等概念,所以只要明白這些注解就可以了。
如果希望使用struts2的注解功能,必須使用一個包 struts2-convention-plugin-2.1.8.1.jar,我使用的環境是struts2.1.8.1。如果你使用了不同的版本,找名字就行。
在以上所述的jar文件中定義了一系列的注解,其中比較主要的是:
@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中的主要注解就是這些,當然了,還有上面提到的@interceptorRef和@exceptionMapping;基本上,掌握了這些注解就可以了。
但是如果想讓這些注解真正工作,必須在配置文件增加幾個常量的定義:
- struts.convention.default.parent.package:這個常量表示缺省的包名是什么,因為在實際應用中,我們常常定義一個缺省的包,這個包中定義了一大堆的攔截器等等,然后其他的包繼承自這個包。這個常量可以配也可以不配;
- struts.convention.package.locators:這個常量表示你的action類的java包的包名的后綴是啥:比如action。這個常量也可以不配;
- struts.convention.package.locators.basePackage:這個常量表示你的action類的java包package的名字是啥;這個常量也可以不配;
以上三個常量都是輔助作用的,為了讓注解真正的工作,必須在配置文件中增加<package>節點的配置,至少是<package name="myPackage" extends="struts-default" />,這樣注解就可以使用了。
