最近开始关注struts2的新特性,从这个版本开始,Struts开始使用convention-plugin代替codebehind-plugin来实现struts的零配置。
配置文件精简了,的确是简便了开发过程,但是,我们熟悉的配置突然disappear了,真是一下很不适应。跟着潮流走吧,看看该怎样来搞定convention-plugin。
使用Convention插件,你需要将其JAR文件放到你应用的WEB-INF/lib目录中,你也可以在你Maven项目的POM文件中添加下面包依赖
- <dependency>
- <groupId>org.apache.strutsgroupId>
- <artifactId>struts2-convention-pluginartifactId>
- <version>2.1.6version>
- dependency>
零配置并不是没有配置&#xff0c;而是通过约定大于配置的方式&#xff0c;大量通过约定来调度页面的跳转而使得配置大大减少。所以&#xff0c;首先应该了解下convention-plugin的约定&#xff1a;
1. 默认所有的结果页面都存储在WEB-INF/content下&#xff0c;你可以通过设置struts.convention.result.path这个属性的值来改变到其他路径。如&#xff1a;
- <constant name&#61;"struts.convention.result.path" value&#61;"/WEB-INF/page" />
则将路径配置到了WEB-INF/page 下。
2. 默认包路径包含action,actions,struts,struts2的所有包都会被struts作为含有Action类的路径来搜索。你可以通过设置struts.convention.package.locators属性来修改这个配置。如&#xff1a;
- <constant name&#61;"struts.convention.package.locators" value&#61;"web,action" />
则定义了在项目中&#xff0c;包路径包含web和action的将被视为Action存在的路径来进行搜索。
Com.ustb.web.*/com.ustb.action.*都将被视为含有Action的包路径而被搜索。
3. 接着&#xff0c;Convention从前一步找到的package以及其子package中寻找 com.opensymphony.xwork2.Action 的实现以及以Action结尾的类&#xff1a;
- com.example.actions.MainAction
- com.example.actions.products.Display (implements com.opensymphony.xwork2.Action)
- com.example.struts.company.details.ShowCompanyDetailsAction
com.example.actions.MainAction
com.example.actions.products.Display (implements com.opensymphony.xwork2.Action)
com.example.struts.company.details.ShowCompanyDetailsAction
4. 命名空间。从定义的.package.locators标示开始到包结束的部分&#xff0c;就是命名空间。举个例子&#xff1a;
Com.ustb.web.user.userAction的命名空间是&#xff1a;”/user”。Com.ustb.web.user.detail.UserAction的命名空间是&#xff1a;”/user/detail”
5. Convention通过如下规则确定URL的具体资源部分:去掉类名的Action部分。然后将将每个分部的首字母转为小写&#xff0c;用’-’分割&#xff0c;你可以设置struts.convention.action.name.separator 如
- <constant name&#61;"struts.convention.action.name.separator" value&#61;"-" />
还是举个例子&#xff1a;
UserAction->user UserDetailAction ->user-detail。结合上面的。对于com.ustb.web.user.detail.UserDetailAction&#xff0c;映射的url就是/WEB-INF/content/user/detail/user-detail.jsp
6. struts支持.jsp .html .htm .vm格式的文件。
下面是actiong和结果模版的映射关系&#xff1a;
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
当然&#xff0c;简单的通过默认的方式来进行配置不能完全满足实际项目的需要。所幸&#xff0c;convention的零配置是非常灵活的。
通过&#64;Action注释
对如下例子&#xff1a;
- package com.example.web;
- import com.opensymphony.xwork2.Action;
- import com.opensymphony.xwork2.ActionSupport;
- public class HelloAction extends ActionSupport {
- &#64;Action("action1")
- public String method1() {
- return SUCCESS;
- }
- &#64;Action("/user/action2")
- public String method2() {
- return SUCCESS;
- }
- }
package com.example.web;import com.opensymphony.xwork2.Action;
import com.opensymphony.xwork2.ActionSupport; public class HelloAction extends ActionSupport {&#64;Action("action1")public String method1() {return SUCCESS;}&#64;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 |
通过&#64;Action注释后
方法名 | &#64;Action注释后调用路径 | &#64;Action注释 后映射路径 |
method1 | /action1!method1.action. | /WEB-INF/content/action1.jsp |
method1 | /user/action2!method2.action | /WEB-INF/content/user/action2.jsp |
通过&#64;Actions注释
- 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 {
- &#64;Actions({
- &#64;Action("/different/url"),
- &#64;Action("/another/url")
- })
- public String method1() {
- return “error”;
- }
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 {&#64;Actions({&#64;Action("/different/url"),&#64;Action("/another/url")})public String method1() {return “error”;}
我们可以通过&#xff1a;/different/url!method1.action 或 /another/url!method1.action 来调用method1 方法。
对应的映射路径分别是/WEB-INF/content/different/url-error.jsp; /WEB-INF/content/another/url-error.jsp
可能误导了大家&#xff0c;一个方法被&#64;Action注释后&#xff0c;只是多了一种调用方式&#xff0c;而不是说覆盖了原来的调用方式。比如对于如下例子&#xff1a;
- 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 {
- &#64;Action("/another/url")
- public String method1() {
- return “error”;
- }
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 {&#64;Action("/another/url")public String method1() {return “error”;}
我们调用method1方法可以通过两种方式&#xff1a;
1 /hello!method1.action 映射 url&#xff1a;/WEB-INF/content/hello-error.jsp
2 /another/url!method1.action 映射 url&#xff1a;/WEB-INF/content/another/url-error.jsp
可见&#xff0c;两种方式均可对method1方法进行调用&#xff0c;唯一的区别就是&#xff0c;两种调用的映射是不一样的&#xff0c;所以&#xff0c;想跳转到不同的界面&#xff0c;这是一个非常好的选择。
通过&#64;Namespace 注释
- package com.example.web;
- import com.opensymphony.xwork2.ActionSupport;
- import org.apache.struts2.convention.annotation.Action;
- import org.apache.struts2.convention.annotation.Actions;
- &#64;Namespace("/other")
- public class HelloWorld extends ActionSupport {
- public String method1() {
- return “error”;
- }
- &#64;Action("url")
- public String method2() {
- return “error”;
- }
- &#64;Action("/different/url")
- public String method3() {
- return “error”;
- }
- }
package com.example.web;import com.opensymphony.xwork2.ActionSupport;
import org.apache.struts2.convention.annotation.Action;
import org.apache.struts2.convention.annotation.Actions;
&#64;Namespace("/other")
public class HelloWorld extends ActionSupport {public String method1() {return “error”;}&#64;Action("url")public String method2() {
return “error”;}&#64;Action("/different/url")public String method3() {
return “error”;}
}
通过 /other/hello-world!method1.action 访问method1 方法。
通过 /other/url!method2.action 访问method2 方法
通过 /different /url!method3.action 访问method3 方法
与&#64;Action 注释不同的是&#xff0c;该注释覆盖了默认的namespace(这里是’/’)&#xff0c;此时再用hello!method1.action 已经不能访问method1 了.
&#64;Results和&#64;Result
1 全局的&#xff08;global&#xff09;。
全局results可以被action类中所有的action分享&#xff0c;这种results在action类上使用注解进行声明。
- 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;
- &#64;Results({
- &#64;Result(name&#61;"failure", location&#61;"/WEB-INF/fail.jsp")
- })
- public class HelloWorld extends ActionSupport {
- public String method1() {
- return “failure”;
- }
- &#64;Action("/different/url")
- public String method2() {
- return “failure”;
- }
- }
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;&#64;Results({&#64;Result(name&#61;"failure", location&#61;"/WEB-INF/fail.jsp")
})
public class HelloWorld extends ActionSupport {public String method1() {return “failure”;}&#64;Action("/different/url")public String method2() {return “failure”;}}
当我们访问 /hello -world !method1.action 时&#xff0c;返回 /WEB-INF/fail.jsp
当我们访问 /hello -world !method2.action 时&#xff0c;返回 /WEB-INF/fail.jsp
当我们访问 /different/url!method2.action 时&#xff0c;返回 /WEB-INF/fail.jsp
2 本地的&#xff08;local&#xff09;。
本地results只能在action方法上进行声明。
- 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 {
- &#64;Action(value&#61;"/other/bar",results&#61;{&#64;Result(name &#61; "error", location &#61; "www.baidu.com",type&#61;"redirect")})
- public String method1() {
- return “error”;
- }
- }
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 {&#64;Action(value&#61;"/other/bar",results&#61;{&#64;Result(name &#61; "error", location &#61; "www.baidu.com",type&#61;"redirect")})public String method1() {return “error”;}
}
当我们调用 /hello -world !method1.action 时&#xff0c;返回 /WEB-INF/content/hello-error.jsp
当我们调用 /other/bar!method1.action 时&#xff0c;返回 www.baidu.com