我们已经从较高层解释了整个框架的结构,请求流程的基础,配置方式和Struts2和Struts1的不同之处。了解这些后从Struts 应用 迁移到 Struts 2 不再是难事。
& O" o( C) v3 Z2 N. S: X; ~; O0 E3 s 在这篇文章中,我们将会更详细地讲述如何由Struts 的action转为Struts 2的action。
# F/ z; n2 ?- {& A6 w3 Q
: W5 h9 f# J- s5 v& n一个应用的例子6 ^# [# B* `) f/ Y& x
这个例子选择了大家都熟悉的 - weblog. 简单地介绍下这例子的功能需求:
" E1 j L! g* C+ h- 增加一个新的日志
- 察看一个日志
- 修改一个日志
- 删除一个日志
- 列出所有日至
增删修改(CRUD),是项目中最为普遍的应用。
4 N, q ^7 A& {4 N. s 业务逻辑类在Struts 和 Struts2 应用都是可共用的。如:
复制内容到剪贴板
代码:
public class BlogService{
private static List<Blog> blogs = new ArrayList<Blog>();
public List<Blog> list() { ... }
public Blog create(Blog blog) { ... }
public void update(Blog blog) { ... }
public void delete(int id){ ... }
public Blog findById(int id){ ... }
} BlogService 只是个简单的业务逻辑类,并不是接口,Struts 和 Struts2 的action皆可调用其实例。虽然这样设计在实际项目中会带来不必要的耦合,但我们的例子只是集中在讨论web层上,所以无关重要。
- L: E1 R) h8 S5 Z$ v5 U7 W/ T$ _# q& ~$ V$ m* t" p( P
工具箱: 在第一篇文章中,我们谈论了在Struts2 actions中的依赖注入的接口注入方式。这个是servlet 相关类(
HttpServletRequest,
HttpServletResponse,
PrincipalProxy, 等.)的主要注入方式,但这并不是唯一的方式。
+ ^: Y8 z+ Y0 g1 J& U
8 W4 r2 ]. x7 XStruts2 可以使用Spring框架作为默认的容器时,依赖注入的setter方法就可用了。通过在action中加入setter方法(如下演示), Struts2 框架将能从Spring框架中获得正确的信息,并通过setter加载在action中。
复制内容到剪贴板
代码:
public void setBlogService(BlogService service){
this.blogService = service;
} 和接口注入方式类似,我们需要一个拦截器来帮助我们完成任务,这就是
ActionAutowiringInterceptor 拦截器。这样我们的业务逻辑类就通过Spring框架管理自动在action被调用之前注入到Struts2得action中。有多种的配置参数(如by name, by type 或 automatically)可供选择,可以让对象和setter匹配的注入的方式根据你的需要而定。
4 A {0 ~; L: X% V( J* C' O
1 |1 T+ E' Z$ n8 NStruts 应用中的代码
k5 ?( N, y! A+ j0 d 我们首先从Struts讲起。在Struts中,最普遍的做法是,对于每个需求用例(如save,update,remove,list)来说都会有对应的action类,同时也会有相应的action form类。在我们的应用中的这个方式或许不是最佳的实现方式(其他的解决方案包括使用dynamic form或者使用request来分发action),但我们例子中的做法是所有Struts开发者最熟悉的一种形式。了解了这种简单的实现方法,你有能力在迁移到Struts2时,使用更为优秀的方法。
9 L3 I8 n+ _- ?% Q% s6 |在第一篇文章中我们谈过Struts 和 Struts2 中action的区别。现在我们从UML中再次看看他们的差别。一般来说form在Struts action中的表现形式是:
3 a& J5 ~; h$ `3 r0 z
6 k& B6 I- o6 P
! \# S7 j; ?, o: c, N7 Y7 E$ n9 c" E' O
这action form将会在多个action中使用,让我们来看看它:
复制内容到剪贴板
代码:
public class BlogForm extends ActionForm {
private String id;
private String title;
private String entry;
private String created;
// public setters and getters for all properties
}如UML中展示的那样,其中一个限制就是必须继承ActionForm类,另外一个限制就是form中所有属性都必须是String类型,所以所有的getter和setter都必须只能接受String参数和返回String结果。
/ m4 {0 `8 w, L! X7 F$ F: `( h
( a+ w6 K% R+ F: B* G
然后我们来看看action。我们这个例子中的action有view, create 和 update action。
9 w2 C2 t9 e- L! _. z7 cThe View Action:
8 {6 q9 i0 c+ }7 ` @, `
The Create Action:
复制内容到剪贴板
代码:
public class ViewBlogAction extends Action{
public ActionForward execute(ActionMapping mapping,
ActionForm form,
HttpServletRequest request,
HttpServletResponse response)
throws Exception {
BlogService service = new BlogService();
String id = request.getParameter("id");
request.setAttribute("blog",service.findById(Integer.parseInt(id)));
return (mapping.findForward("success"));
}
}复制内容到剪贴板
代码:
public class SaveBlogEntryAction extends Action {
public ActionForward execute(ActionMapping mapping,
ActionForm form,
HttpServletRequest request,
HttpServletResponse response)
throws Exception{
BlogService service = new BlogService();
BlogForm blogForm = (BlogForm) form;
Blog blog = new Blog();
BeanUtils.copyProperties( blog, blogForm );
service.create( blog );
return (mapping.findForward("success"));
}
}The Update Action:复制内容到剪贴板
代码:
public class UpdateBlogEntryAction extends Action{
public ActionForward execute(ActionMapping mapping,
ActionForm form,
HttpServletRequest request,
HttpServletResponse response)
throws Exception{
BlogService service = new BlogService();
BlogForm blogForm = (BlogForm) form;
Blog blog = service.findById( Integer.parseInt(blogForm.getId()));
BeanUtils.copyProperties( blog, blogForm );
service.update( blog );
request.setAttribute("blog",blog);
return (mapping.findForward("success"));
}
}这三个action都跟随着同一个模式:
( V2 {; e, }) B; v6 ~) a0 Z! v+ j1 j5 k1 [7 f9 Q, x0 {- t* M
- 产生一个新的业务逻辑对象实例 - 如前面所提到的,我们使用最直接的方式在action中使用业务逻辑对象,这表示在每个action中都会产生新的业务逻辑对象实例。
- 从请求中获得数据 - 这是两种形式之一。在view action中,"id"是从HttpServletRequest 对象中直接获取的。而在create 和 update action 中,则从ActionForm 中取值。ActionForm 与 HttpServletRequest 的调用方式其实很相似,唯一不同的ActionForm 是bean的从field中取值。
- 调用业务逻辑- 现在开始生成调用业务逻辑所需的参数并调用逻辑。如果参数(在view action中)是一个简单对象类型,则转换值时会自动转为正确的类型(如从String转到Integer)。如果参数是复杂的对象类型,,则ActionForm 需要通过BeanUtil 来帮忙转成相应的对象。
- 设定返回的数据 - 如果需要把数据返回显示给用户,那则要把这个数据设在HttpServletRequest 的attribute 中返回。
- 返回一个 ActionForward - 所有 Struts action的最后都需要找到并返回其相应的 ActionForward 对象.
最后的两个action,remove和list action, 只有很少的差别。remove action如下所示,没有用BlogForm类. 通过从request的attribute中获取"id"(和view action相似),就能调用业务逻辑完成其需要的工作。在下面我们介绍配置时,你可以看到它并没有返回任何数据,因为它的"success"返回结果其实是执行remove后再执行了list action来返回信息的。
复制内容到剪贴板
代码:
public class RemoveBlogEntryAction extends Action {
public ActionForward execute(ActionMapping mapping,
ActionForm form,
HttpServletRequest request,
HttpServletResponse response)
throws Exception {
BlogService service = new BlogService();
String id = request.getParameter("id");
service.delete(Integer.parseInt(id));
return (mapping.findForward("success"));
}
}list action并不需要任何的用户输入,它只是简单地调用了业务逻辑的无参方法,同时返回所有的Blog对象。
复制内容到剪贴板
代码:
public class ListBlogsAction extends Action {
public ActionForward execute(ActionMapping mapping,
ActionForm form,
HttpServletRequest request,
HttpServletResponse response)
throws Exception{
BlogService service = new BlogService();
request.setAttribute("bloglist",service.list());
return (mapping.findForward("success"));
}
}向 Struts2 迁移
: F, F, S6 J! P 在Struts2中,可选的实现方式有很多,可以像Struts那样每个需求用例对应一个action,也可以用一个action对应所有需求用例。但在我们的例子中,使用的方法是我认为最佳的解决方案 - 在一个action类中实现整套CRUD功能。
5 \2 ^( z3 [. w* X 也许你人为把list需求用例也同样地整合到同一个action类里会比较好,而我认为把list的功能分到另外一个action中,会减少容易产生的混淆,因为list用例中并不需要
Blog这个类作为属性,而在其他用例中则需要。
& s; l4 I B) {4 `: U! q
# n4 o# ?) v; N+ e对于 Struts2的例子, 它的UML模型展示如下:
# Y7 Y5 t9 z" g; }
. ]' \! ~6 B r/ s# R6 H% h3 I
$ l, E! Y, ]! j# ^1 a9 b# L) {
' ^8 ]9 G4 j# \1 ~7 B9 n3 V$ E8 s9 c
每个用例在action中都有自己所对应的方法。从上图中我们可以看到,在
BlogAction 中我们有save, update 和 remove三个方法。而
ListBlogAction中,没有list这个方法,因为
ListBlogAction继承了
ActionSupport 类,实际上就是在默认的execute 方法中实现list功能。
T. i) A8 I, G& U* Y
为了更容易看,图中的
BlogAction并没有画出它所实现了的三个接口。它们分别是
ServletRequestAware 接口,
Prepareable 接口和
ModelDriven 接口。
8 y' ]- Z1 @% H; G; Z
首先回顾一下
ServletRequestAware, 我们在第一篇文章中已经详细介绍它了。这个
ParametersInterceptor 拦截器提供了把
HttpServletRequest 自动set到action中的功能,让我们能通过request, 把所需的值传回到JSPs。
8 g5 X _$ B: [# l7 P* m 接着看看
Preparable 接口, 它会联合
PrepareInterceptor拦截器一起工作,让action在执行execute() 方法前, 执行一个prepare()方法,实现在执行前设定,配置或预设一些值在action中。 在我们的例子里,prepare方法会检查
blogId 属性,如果为零则这是一个新日志,非零则该日志已经存在,根据
blogId取出日志。
. g+ q2 w: f8 a- n, L& t7 y( Q X% K 最后我们说说
ModelDriven 接口,在上一篇文章中,我们已经了解到 Struts action的很大的不同在于它是需要线程安全的,而在Struts2中则没有这个限制,因为每次的请求都会有一次action对象的初始化和调用。没有了这个限制,能允许Struts2使用类级别的属性变量(特别是getters和setters),从而获得更多编码优势。
* q/ r8 }: l Q
4 A+ J! o4 x7 n2 ?* r+ q! ]( m和拦截器的功能结合起来, 把
HttpServletRequest 中的attribute 注入action中的流程如下所示:
6 o. C' k& P5 N% b# N2 C1 d7 m1 T- V- w3 F% d+ v' D
- 循环读取HTTP request中的attribute
- 查找当前request attribute中是否有和action中的setter中的属性匹配的
- 有则根据attribute从HttpServletRequest 里取出其值
- 把取出来的值由String转成setter中相应的类型
- 调用setter把该转换后的值注入action中
提示: 当调用action时,如果发现不明原因使不能正确地通过setter注入值情况下,第一步最好是先检查下各拦截器,确保它们都已作用于该action。因为这些意外通常有时由拦截器设置不当形成的,检查是否各个拦截器都已起作用,并看看它们作用的顺序,因为有些情况下它们间会相互影响而产生错误。
现在我们已经有基于String类型的form bean中取值的方法或者是自动把request的attributes 注入到action的方法,那下一步就是如何把值传入 domain object 或 value / transfer object的属性中去。其实这很简单,你只需要实现
ModelDriven 接口(即实现
getModel()方法)就可以了,确保
ModelDrivenInterceptor 拦截器已作用于action。
5 D1 N4 r' h: j
除了会调用action中的setter外,model 首先检查是否有和setter可以匹配当前的attribute名。如果在model中没有这个attribute相应的setter,则会再在action上找相应的setter来设值。
$ s2 M( b( r* N4 n7 T6 m2 @# | 在
BlogAction 的例子中我们可以看到如何很灵活地使用这些方法,首先通过prepare() 方法根据Id获取相应的
Blog model object 或新建一个instance, 然后再根据把request中相应的属性注入Blog instance中和action中。
0 l$ r) h; ?3 ]8 M
以上的两个功能使得现在调用action那么简单 - 调用具体的业务逻辑,和把数据设在
HttpServletRequest供返回用
。复制内容到剪贴板
代码:
public class BlogAction extends ActionSupport
implements ModelDriven, Preparable, ServletRequestAware{
private int blogId;
private Blog blog;
private BlogService service = new BlogService();
private HttpServletRequest request;
public void setServletRequest(HttpServletRequest httpServletRequest){
this.request = httpServletRequest;
}
public void setId(int blogId){
this.blogId = blogId;
}
public void prepare() throws Exception{
if( blogId==0 ){
blog = new Blog();
} else{
blog = service.findById(blogId);
}
}
public Object getModel() {
return blog;
}
public String save(){
service.create(blog);
return SUCCESS;
}
public String update() {
service.update(blog);
request.setAttribute("blog",blog);
return SUCCESS;
}
public String remove() {
service.delete(blogId);
return SUCCESS;
}
public String execute() {
request.setAttribute("blog",blog);
return SUCCESS;
}
} 最后就是说说 list这个用例了。它同样需要访问HttpServletRequest对象去返回数据给JSP,所以也需要实现ServletRequestAware 接口。但是,因为它并不需要任何输入值,所以就不需要实现其他的接口了。以下是它的具体实现:
复制内容到剪贴板
代码:
public class ListBlogsAction extends ActionSupport implements ServletRequestAware{
private BlogService service = new BlogService();
private HttpServletRequest request;
public void setServletRequest(HttpServletRequest httpServletRequest){
this.request = httpServletRequest;
}
public String execute() ...{
request.setAttribute("bloglist",service.list());
return SUCCESS;
}
}这样就完成了我们该实现的action代码了。 在下一篇文章中,当我们新的Struts2用户界面结合时,我们还会进一步简化action的代码。
( n- L. o, V7 Y
; x! F, a1 C( J: [) H1 R4 M6 T0 |$ k0 J4 Q9 P) h
配置Actions( l. S0 F0 s$ @% ]% M
在我们调用action之前,我们必须通过XML配置文件去配置它们。
6 R( a; T/ r6 q$ u2 [
在Struts中, 我们习惯用在WEB-INF 目录的"struts-config.xml"配置文件,在这里我们需要配置action form和action属性。在Struts2中, 用的是在classpath中的"struts.xml"配置文件, 它看起来好象会稍微复杂一些,因为它需要在配置action的同时也配置其拦截器。
9 G$ U6 F8 u; x* q
O- Y& Q0 L9 {/ T) v# r2 \: @ 在Struts中配置
form-beans 节点很容易, 只需要一个唯一的名字,还有就是继承ActionForm类的class作为type。
复制内容到剪贴板
代码:
<struts-config>
<form-beans>
<form-bean name="blogForm" type="com.fdar.articles.infoq.conversion.struts.BlogForm"/>
</form-beans>
...
</struts-config> 在我们的例子中,我们的配置文件有3点不相同:
& y1 n! o. }; j* t' H* t2 p1. 重定向配置
( Z9 f. O _2 A- @ u9 R 在Struts的配置中,每个mapping 都需要提供调用action时所需要对应的路径,Struts默认为".do", 例如paht是"/struts/add"对应于URL"/struts/add.do"。同时也需要一个
forward 属性来提供给URL去转向,如"/struts/add.jsp".
复制内容到剪贴板
代码:
<struts-config>
...
<action-mappings>
<action path="/struts/add" forward="/struts/add.jsp"/>
...
</action-mappings>
</struts-config> 而Struts2的需要更多的一些配置,如:
复制内容到剪贴板
代码:
<struts>
<include file="struts-default.xml"/>
<package name="struts2" extends="struts-default" namespace="/struts2">
<action name="add" >
<result>/struts2/add.jsp</result>
</action>
...
</package>
</struts> 首先你会注意到的是,代替
action-mappings 节点的是
include 和
package 节点。Struts2可以把配置细分到任意数目的配置文件中,来实现配置可模块化管理。每个配置文件的结构其实都是一样的,不同的只是文件名。
; a/ f- b$ P" B. F% x! y
include 节点中,以文件名作为
file 属性,可把所include的文件内容包含到当前文件中。
; A9 v( N, B r% \5 S package 节点把actions组成一组,其
name 属性的值必须是唯一的。
% }' J e; U A 在 Struts action的配置中, paht属性需要指定完整的URL路径。而在Struts2中,URL是通过
package节点中的
namespace属性,还有在
action 节点中的
name 属性, 和action扩展(默认是".action")共同起作用的。在上面的例子中,则URL为"/struts2/add.action"时会调用action。
: d8 E4 L6 Q! q4 Y2 n% c n# y package节点除了可以分离命名空间外, package 节点中的
extends 属性,还提供了某种可复合的组成结构。通过继承另外一个package节点,你就能继承那个节点的配置,包括其actions, results, interceptors, exception,等值。在我们的例子中,"struts2" package节点继承了 "struts-default" package 节点(在"struts-default.xml" 文件里定义了该节点) ,注意这个是主要的include文件,所以必须在所有配置之前的第一行中写出。 这个功能有助于大大减少你重复性输入默认配置所浪费的时间。
2 \( G9 c$ O9 C6 P2 z% x' ~ 最后是
result 节点, 它只是存放你这个action所需要转向的URL. 在这里我们没有提及
name 和
type 属性。如果你不想改变它们的默认属性的话,你能忽略不写它们,让你的配置文件看起来更清晰。从action返回的 "success" 的结果将组成这个JSP显示给用户。
7 ^5 k- e/ N6 x# b
& a+ y5 n) K7 z! J
8 o3 R) ^* |7 v0 \2. Action 配置
) C, N6 P* r" d: n9 S( C) D 在Struts 中
forward 节点指定了action处理后,结果将重定向到哪个相应的页面。
type属性指定了action的类,
scope 属性保证了form beans只在request范围内。
复制内容到剪贴板
代码:
<struts-config>
...
<action-mappings>
<action path="/struts/list" scope="request"
type="com.fdar.articles.infoq.conversion.struts.ListBlogsAction" >
<forward name="success" path="/struts/list.jsp"/>
</action>
...
</action-mappings>
</struts-config>Struts2 的 XML配置和上面提到的基本相同。唯一不同的就是通过class属性为action节点提供了它所需要调用的类的完整路径
复制内容到剪贴板
代码:
<struts>
...
<package name="struts2" extends="struts-default" namespace="/struts2">
<default-interceptor-ref name="defaultStack"/>
<action name="list" class="com.fdar.articles.infoq.conversion.struts2.ListBlogsAction">
<result>/struts2/list.jsp</result>
<interceptor-ref name="basicStack"/>
</action>
...
</package>
</struts>如果是用其他的方法而不是用默认的execute 方法去调用action(在
BlogAction 类中大多数方法如此), 则需要在action节点的
method 属性里加入方法名,下面就是个例子,这时候update方法将会被调用。
复制内容到剪贴板
代码:
<action name="update" method="update" class="com.fdar.articles.infoq.conversion.struts2.BlogAction" >
...
</action> default-interceptor-ref 和
interceptor-ref 节点有几点不同。在第一篇文章中,我们看到在action被调用之前必须通过一系列的拦截器,而这两个节点就是用来配置拦截器组的。
default-interceptor-ref 节点为该package提供了默认的拦截器组。当在action节点中提供
interceptor-ref节点时 ,它就会覆盖默认的拦截器(
interceptor-ref 节点能够和单独一个拦截器相关联,或者跟一个拦截器组相关联),在action节点中可以存在多个
interceptor-ref节点,处理拦截器组的顺序会和该节点列出的顺序一致。
. s/ F/ r5 k( H/ @
0 {7 f* c/ J& d8 Q, O6 s( u0 i3 @9 s; T D) `7 q: l
3. 再重定向配置
+ L# S- x& _2 A& j" G; s4 v 当我们提交表格的时候,我们需要重定向到更新后的结果页面。这个通常称为 "post-redirect pattern" 或, 最近出现的, "flash scope."
9 o3 e7 W) s3 o/ T0 A; ^; z 由于这是一个form, 所以在Struts中我们需要为Struts指定一个
ActionForm。需要在name属性中提供form的名称,同样地,我们也需要在
forward 节点中举加入redirect属性为true。
复制内容到剪贴板
代码:
<struts-config>
...
<action-mappings>
<action path="/struts/save" type="com.fdar.articles.infoq.conversion.struts.SaveBlogEntryAction"
name="blogForm" scope="request">
<forward name="success" redirect="true" path="/struts/list.do"/>
</action>
...
</action-mappings>
</struts-config> Struts2 在
result 节点里提供了
type 属性, 默认情况下是"dispatch", 如果需要重定向,则需要设为 "redirect"。
复制内容到剪贴板
代码:
<struts>
...
<package name="struts2" extends="struts-default" namespace="/struts2">
<action name="save" method="save" class="com.fdar.articles.infoq.conversion.struts2.BlogAction" >
<result type="redirect">list.action</result>
<interceptor-ref name="defaultStack"/>
</action>
...
</package>
</struts> 总结7 v0 N* y2 [; b) ^
我们并不可能在这篇文章中覆盖所有的内容,如果你需要更好的了解整个框架,还有其他的实现方式和选项,这里有几点可以供你参考:
J3 K! e! V, m2 ?4 q U8 l6 O: b
& c: N' X7 \8 p% T% ], X
/ M8 ?! @. c, s+ r% p/ v* K: F- 配置拦截器和拦截器组 - 以Struts2-core JAR 包里的"struts-default.xml" 文件作为例子。"struts-default.xml" 演示了如何配置你自己的拦截器组,包含新的拦截器,你可以尝试实现自己的拦截器。
- 配置文件中的通配符模式 - 你可以选择使用Struts2中的通配符模式来简化你的配置。
- 通过 ParameterAware 接口把form值传入maps中 - 你可以在Struct2中配置,让所有request的form属性都存于action的一个map中,这样就不需要专门再为action指定model / transfer / value object了。这和Struts的dynamic form特点很相似。
也许到现在为,也许你有个疑问,"迁移后我们的界面是否可以完全重用呢?",答案是yes。你能从
这里, 下载到我这篇文章中的完整源代码,你可以自己尝试把URL的扩展名由".do" 改为 ".action",使用的页面时一样的。除此之外,其实用JSTL来代替Struts taglib也是很容易的。
/ k* T1 X. {4 c0 o; ~
在下一篇文章中,我们将讲述用户界面,讨论themes 和 tags; 如何做validation; 如何重用UI控件。