struts2採用convention-plugin實現零配置

時間 2019-11-08

標籤 struts2 struts 採用 convention plugin 實現配置欄目 Struts 简体版

原文原文鏈接

最近開始關注struts2的新特性，從這個版本開始，Struts開始使用convention-plugin代替codebehind-plugin來實現struts的零配置。
配置文件精簡了，的確是簡便了開發過程，可是，咱們熟悉的配置忽然disappear了，真是一下很不適應。跟着潮流走吧，看看該怎樣來搞定convention-plugin。
使用Convention插件，你須要將其JAR文件放到你應用的WEB-INF/lib目錄中，你也能夠在你Maven項目的POM文件中添加下面包依賴html

Xml代碼 web

<dependency> apache
<groupId>org.apache.struts</groupId> app
<artifactId>struts2-convention-plugin</artifactId> jsp
<version>2.1.6</version> url
</dependency> spa

零配置並非沒有配置，而是經過約定大於配置的方式，大量經過約定來調度頁面的跳轉而使得配置大大減小。因此，首先應該瞭解下convention-plugin的約定：
1. 默認全部的結果頁面都存儲在WEB-INF/content下，你能夠經過設置struts.convention.result.path這個屬性的值來改變到其餘路徑。如：.net

Xml代碼插件

<constant name="struts.convention.result.path" value="/WEB-INF/page" /> code

則將路徑配置到了WEB-INF/page 下。
2. 默認包路徑包含action,actions,struts,struts2的全部包都會被struts做爲含有Action類的路徑來搜索。你能夠經過設置struts.convention.package.locators屬性來修改這個配置。如：

Xml代碼

<constant name="struts.convention.package.locators" value="web,action" />

則定義了在項目中，包路徑包含web和action的將被視爲Action存在的路徑來進行搜索。
Com.ustb.web.*/com.ustb.action.*都將被視爲含有Action的包路徑而被搜索。
3. 接着，Convention從前一步找到的package以及其子package中尋找 com.opensymphony.xwork2.Action 的實現以及以Action結尾的類：

Java代碼

com.example.actions.MainAction
com.example.actions.products.Display (implements com.opensymphony.xwork2.Action)
com.example.struts.company.details.ShowCompanyDetailsAction

4. 命名空間。從定義的.package.locators標示開始到包結束的部分，就是命名空間。舉個例子：
Com.ustb.web.user.userAction的命名空間是：」/user」。Com.ustb.web.user.detail.UserAction的命名空間是：」/user/detail」
5. Convention經過以下規則肯定URL的具體資源部分:去掉類名的Action部分。而後將將每一個分部的首字母轉爲小寫，用’-’分割，你能夠設置struts.convention.action.name.separator 如

Xml代碼

<constant name="struts.convention.action.name.separator" value="-" />

仍是舉個例子：
UserAction->user UserDetailAction ->user-detail。結合上面的。對於com.ustb.web.user.detail.UserDetailAction，映射的url就是/WEB-INF/content/user/detail/user-detail.jsp
6. struts支持.jsp .html .htm .vm格式的文件。
下面是actiong和結果模版的映射關係：

URL	Result	File that could match	Result Type
/hello	success	/WEB-INF/content/hello.jsp	Dispatcher
/hello	success	/WEB-INF/content/hello-success.htm	Dispatcher
/hello	success	/WEB-INF/content/hello.ftl	FreeMarker
/hello-world	input	/WEB-INF/content/hello-world-input.vm	Velocity
/test1/test2/hello	error	/WEB-INF/content/test/test2/hello-error.html	Dispatcher

以上的內容來自struts2的文檔http://struts.apache.org/2.1.6/docs/convention-plugin.html

固然，簡單的經過默認的方式來進行配置不能徹底知足實際項目的須要。所幸，convention的零配置是很是靈活的。
經過@Action註釋
對以下例子：

Java代碼

package com.example.web;
import com.opensymphony.xwork2.Action;
import com.opensymphony.xwork2.ActionSupport;
public class HelloAction extends ActionSupport {
@Action ("action1")
public String method1() {
return SUCCESS;
}
@Action ("/user/action2")
public String method2() {
return SUCCESS;
}
}

方法名	默認調用路徑	默認映射路徑
method1	/hello!method1.action .	/WEB-INF/content/hello.jsp
method2	/hello!method2.action.	/WEB-INF/content/hello.jsp

經過@Action註釋後

方法名	@Action註釋後調用路徑	@Action註釋後映射路徑
method1	/action1!method1.action.	/WEB-INF/content/action1.jsp
method1	/user/action2!method2.action	/WEB-INF/content/user/action2.jsp

經過@Actions註釋

Java代碼

package com.example.web;
import com.opensymphony.xwork2.ActionSupport;
import org.apache.struts2.convention.annotation.Action;
import org.apache.struts2.convention.annotation.Actions;
public class HelloAction extends ActionSupport {
@Actions ({
@Action ("/different/url"),
@Action ("/another/url")
})
public String method1() {
return 「error」;
}

咱們能夠經過：/different/url!method1.action 或 /another/url!method1.action 來調用method1 方法。
對應的映射路徑分別是/WEB-INF/content/different/url-error.jsp; /WEB-INF/content/another/url-error.jsp

可能誤導了你們，一個方法被@Action註釋後，只是多了一種調用方式，而不是說覆蓋了原來的調用方式。好比對於以下例子：

Java代碼

package com.example.web;
import com.opensymphony.xwork2.ActionSupport;
import org.apache.struts2.convention.annotation.Action;
import org.apache.struts2.convention.annotation.Actions;
public class HelloAction extends ActionSupport {
@Action ("/another/url")
public String method1() {
return 「error」;
}

咱們調用method1方法能夠經過兩種方式：
1 /hello!method1.action 映射 url：/WEB-INF/content/hello-error.jsp
2 /another/url!method1.action 映射 url：/WEB-INF/content/another/url-error.jsp
可見，兩種方式都可對method1方法進行調用，惟一的區別就是，兩種調用的映射是不同的，因此，想跳轉到不一樣的界面，這是一個很是好的選擇。

經過@Namespace 註釋

Java代碼

package com.example.web;
import com.opensymphony.xwork2.ActionSupport;
import org.apache.struts2.convention.annotation.Action;
import org.apache.struts2.convention.annotation.Actions;
@Namespace ("/other")
public class HelloWorld extends ActionSupport {
public String method1() {
return 「error」;
}
@Action ("url")
public String method2() {
return 「error」;
}
@Action ("/different/url")
public String method3() {
return 「error」;
}
}

經過 /other/hello-world!method1.action 訪問method1 方法。
經過 /other/url!method2.action 訪問method2 方法
經過 /different /url!method3.action 訪問method3 方法
與@Action 註釋不一樣的是，該註釋覆蓋了默認的namespace(這裏是’/’)，此時再用hello!method1.action 已經不能訪問method1 了.
@Results和@Result
1 全局的（global）。
全局results能夠被action類中全部的action分享，這種results在action類上使用註解進行聲明。

Java代碼

package com.example.actions;
import com.opensymphony.xwork2.ActionSupport;
import org.apache.struts2.convention.annotation.Action;
import org.apache.struts2.convention.annotation.Actions;
import org.apache.struts2.convention.annotation.Result;
import org.apache.struts2.convention.annotation.Results;
@Results ({
@Result (name="failure", location="/WEB-INF/fail.jsp")
})
public class HelloWorld extends ActionSupport {
public String method1() {
return 「failure」;
}
@Action ("/different/url")
public String method2() {
return 「failure」;
}
}

當咱們訪問 /hello -world !method1.action 時，返回 /WEB-INF/fail.jsp
當咱們訪問 /hello -world !method2.action 時，返回 /WEB-INF/fail.jsp
當咱們訪問 /different/url!method2.action 時，返回 /WEB-INF/fail.jsp

2 本地的（local）。
本地results只能在action方法上進行聲明。

Java代碼

package com.example.actions;
import com.opensymphony.xwork2.ActionSupport;
import org.apache.struts2.convention.annotation.Action;
import org.apache.struts2.convention.annotation.Actions;
import org.apache.struts2.convention.annotation.Result;
import org.apache.struts2.convention.annotation.Results;
public class HelloWorld extends ActionSupport {
@Action (value="/other/bar",results={@Result (name = "error", location = "www.baidu.com",type="redirect")})
public String method1() {
return 「error」;
}
}

當咱們調用 /hello -world !method1.action 時，返回 /WEB-INF/content/hello-error.jsp
當咱們調用 /other/bar!method1.action 時，返回 www.baidu.com

相關標籤/搜索

每日一句

每一个你不满意的现在，都有一个你没有努力的曾经。