Struts2学习笔记 -- 零配置之convention-plugin实现

 

         最近开始关注struts2的新特性，从这个版本开始，Struts开始使用convention-plugin代替codebehind-plugin来实现struts的零配置。
配置文件精简了，的确是简便了开发过程，但是，我们熟悉的配置突然disappear了，真是一下很不适应。跟着潮流走吧，看看该怎样来搞定convention-plugin。
使用Convention插件，你需要将其JAR文件放到你应用的WEB-INF/lib目录中，你也可以在你Maven项目的POM文件中添加下面包依赖

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

零配置并不是没有配置，而是通过约定大于配置的方式，大量通过约定来调度页面的跳转而使得配置大大减少。所以，首先应该了解下convention-plugin的约定：
1. 默认所有的结果页面都存储在WEB-INF/content下，你可以通过设置struts.convention.result.path这个属性的值来改变到其他路径。如：

<constantname="struts.convention.result.path"value="/WEB-INF/page"/>

则将路径配置到了WEB-INF/page 下。
2. 默认包路径包含action,actions,struts,struts2的所有包都会被struts作为含有Action类的路径来搜索。你可以通过设置struts.convention.package.locators属性来修改这个配置。如：

<constantname="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结尾的类：

com.example.actions.MainAction
com.example.actions.products.Display(implementscom.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 如

<constantname="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注释
对如下例子：

packagecom.example.web;

importcom.opensymphony.xwork2.Action;
importcom.opensymphony.xwork2.ActionSupport;

publicclassHelloActionextendsActionSupport{
@Action("action1")
publicStringmethod1(){
returnSUCCESS;
}

@Action("/user/action2")
publicStringmethod2(){
returnSUCCESS;
}
}

方法名	默认调用路径	默认映射路径
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注释

packagecom.example.web;

importcom.opensymphony.xwork2.ActionSupport;
importorg.apache.struts2.convention.annotation.Action;
importorg.apache.struts2.convention.annotation.Actions;

publicclassHelloActionextendsActionSupport{
@Actions({
@Action("/different/url"),
@Action("/another/url")
})
publicStringmethod1(){
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注释后，只是多了一种调用方式，而不是说覆盖了原来的调用方式。比如对于如下例子：

packagecom.example.web;

importcom.opensymphony.xwork2.ActionSupport;
importorg.apache.struts2.convention.annotation.Action;
importorg.apache.struts2.convention.annotation.Actions;

publicclassHelloActionextendsActionSupport{
@Action("/another/url")
publicStringmethod1(){
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 注释

packagecom.example.web;

importcom.opensymphony.xwork2.ActionSupport;
importorg.apache.struts2.convention.annotation.Action;
importorg.apache.struts2.convention.annotation.Actions;
@Namespace("/other")
publicclassHelloWorldextendsActionSupport{

publicStringmethod1(){
return“error”;
}
@Action("url")
publicStringmethod2(){
return“error”;
}

@Action("/different/url")
publicStringmethod3(){
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类上使用注解进行声明。

packagecom.example.actions;

importcom.opensymphony.xwork2.ActionSupport;
importorg.apache.struts2.convention.annotation.Action;
importorg.apache.struts2.convention.annotation.Actions;
importorg.apache.struts2.convention.annotation.Result;
importorg.apache.struts2.convention.annotation.Results;

@Results({
@Result(name="failure",location="/WEB-INF/fail.jsp")
})
publicclassHelloWorldextendsActionSupport{
publicStringmethod1(){
return“failure”;
}
@Action("/different/url")
publicStringmethod2(){
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方法上进行声明。

packagecom.example.actions;

importcom.opensymphony.xwork2.ActionSupport;
importorg.apache.struts2.convention.annotation.Action;
importorg.apache.struts2.convention.annotation.Actions;
importorg.apache.struts2.convention.annotation.Result;
importorg.apache.struts2.convention.annotation.Results;

publicclassHelloWorldextendsActionSupport{
@Action(value="/other/bar",results={@Result(name="error",location="www.baidu.com",type="redirect")})
publicStringmethod1(){
return“error”;
}
}