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