第 5 章 Struts2 的核心概念

1. 第5章 Struts2的核心概念 • 本章将深入探讨了Struts2的核心概念，首先介绍的是Struts2的体系结构和几个重要的配置文件，并会举例说明Struts2的核心对象如何配置。然后介绍Struts2最重要的3个组成部分Action、Result、Interceptor（拦截器）的原理和使用方法。

2. 5.1 术语概述 • Action在Struts2中是负责Web应用程序中具体逻辑实现的。Action是一个Java类，一般的继承于com.opensymphony.xwork.ActionSupport类，这个类在Struts2的Dispatcher接受到HTTP请求的时候被调用。 • 当一个action执行完毕之后，它将返回一个返回码，譬如“SUCCESS”“INPUT”或者其他“返回代码”。这些“返回代码”通过查找struts.xml中的定义告诉Struts2下一步该做什么而这个下一步就称为result。Struts2 支持许多种不同的result类型，比如返回结果页面给用户。可选择的显示模板技术有JSP、Velocity或者是FreeMarker。

3. 5.2 Struts2的体系结构 • Struts2的核心体系结构如图5.1所示。用户在Struts2框架下只需编写自己的Action类来处理逻辑、编写JSP页面（或者其他方式）来展示用户界面和在struts.xml配置映射关系就可以完成基本的业务流程。

4. 5.3 Struts2的配置文件 • Struts2框架主要有两个核心配置文件：struts.properties和struts.xml。struts.xml与Struts1版本中的struts-config.xml非常类似，主要负责管理应用中的Action映射，以及该Action包含的Result定义等，而struts.properties文件则定义了Struts2框架的全局属性。所有的配置文件说明见表所示，图展示了几个配置文件所在位置和相互关系。

5. 5.3.1 全局配置文件--struts.properties • struts.properties文件是一个标准的Properties文件，该文件包含了系列的key-value对象，每个key就是一个Struts2属性，该key对应的value就是一个Struts2属性值。struts.properties文件通常放在Web应用的WEB-INF/classes路径下，实际上，只要将该文件放在Web应用的CLASSPATH路径下，Struts2框架就可以加载该文件。以下是一部分配置片段。 • struts.enable.DynamicMethodInvocation=false" • struts.devMode=false

6. 5.3.2 核心配置文件--struts.xml • struts.xml文件主要负责管理应用中的action映射，以及该action包含的result定义等。在struts.properties配置中的有一项struts.configuration.files，这里可以看出struts.xml这个文件名不一定是固定的，可以配置为其他文件名的。struts.xml内容主要包括：Action、Interceptor、Packages、Namespace等。后面的章节将详细介绍如何配置这些元素。 • 在struts.xml中可以使用<include>标签把内容分到几个文件中去。这里非常像JSP中的<jsp：include>动作标签，可以把其他文件的内容导入进来，被导入的每个配置文件必须和struts.xml文件有一样的格式。<include>标签的格式如下所示。

7. 5.3.3 struts.xml的缺省实现 • struts-default.xml这个文件被包含在struts2-core.jar中，文件名已经可以看出这个文件的作用是struts.xml的缺省配置，它将自动被加载然后导入到struts.xml中去。代码5-1是struts-default.xml的部分片段。

8. 5.3.4 Velocity模板规则文件 • 如果在程序中使用了Velocity（一个基于java的模板引擎，可以替代JSP作为显示页面）可以把文件velocity.properties放到classpath中去，系统将自动加载。同时还要配置struts-default.vm文件， • 代码 velocity.properties • # Velocity 资源定义. • velocimacro.library = action-default.vm， tigris-macros.vm， myapp.vm

9. 5.4 struts.xml的配置 • Struts2绝大多数的配置都是在struts.xml中完成的，学习struts.xml文件是学习使用struts2的基础。本节将详细讲述如何在struts.xml中定义和配置各种元素。

10. 5.4.1 action配置 • action是Struts2的基础“工作单元”。配置一个基本的action只需要两个信息：action名字和对应的action类，这两部分就建立了一个最简单的action配置。属性“method”用来告诉Struts2调用action的那个方法。在action处理之后一般的需要展示处理结果给用户，所以还需要把action和result映射在一起。如代码所示。 • 代码 Action配置：struts.xml • <!—Struts action配置--> • <action name="helloWorld" class="example.HelloWorld" method=”doWork”> • <result name="failure" path="Error.jsp"/> • <result name=”ok” path="HelloWorld.jsp"/> • </action>

11. 5.4.2 result配置 • Struts2定义了一些默认result：error，input，login，none和success。开发者当然也可以根据应用情况自由的定义结果。结果以“名字-值”的形式影射到结果类型。result标签告诉Strtus 2在action被调用以后下一步做什么。result在struts.xml文件中定义，嵌套在<action>标签里。如果location参数是唯一的参数，可以这样简单的定义： • <!—在result中添加参数--> • <action name="bar" class="myPackage.barAction"> • <result name="success" type="dispatcher"> • <param name="location">foo.jsp</param> • </result> • </action>

12. 5.4.3 拦截器（interceptor）配置 • interceptor是能在一个action执行的前后执行的代码。它是做Web应用程序时很有用的工具。最常见的由Interceptor实现的功能如：安全检查(确保访问者是登陆用户)、跟踪日志(记录每个action)、效率瓶颈检查(记录每个action开始和结束的时间以检查程序中的瓶颈)。也可以把interceptor连在一起组成interceptor栈（interceptor-stack）。比如在action执行前同时做登陆检查，安全检查和记录日志，可以定义一个interceptor的栈。interceptor必须事先定义好，然后可以连在一起组成一个栈。如代码5-7所示，定义了一个interceptor和一个interceptor栈。

13. 5.4.4 包（package）配置 • 所谓packages就是把actions、results、results、types、interceptors这些元素打包到一个逻辑单元中去，从概念上讲，packages就更像一个程序中的对象，可以被其他子包从写，而且可以拥有自己独立的部分。Name属性是packages的必填元素，它作为一个关键字被后边的包引用；extends元素是可选的，它允许包扩展一个和多个前边定义的包。Abstract元素是可选的，如抽象类和抽象函数一样它是必须被继承的，可以申明一个不包含actions的package。

14. 5.4.5 命名空间（Namespace）配置 • 命名空间属性允许把action配置分成不同的命名空间，这样可以使功能不同action中使用相同的名字。默认命名空间用“”(空字符串)表示。如果系统在指定的命名空间中没有找到某个action，就会到默认命名空间中查找。可以在所有用"extends"扩展的命名空间外配置全局action不指定命名空间。 • Struts2中有以“/”命名的根命名空间，它是请求直接来自应用程序根路径的时候的命名空间。和其他命名空间一样，如果在根命名空间中没有所需的action别名，系统会回到默认命名空间中查找。如代码5-9所示，这里使用了默认命名空间、“/”和声明了的命名空间“barspace”

15. 5.4.6 在struts.xml中定义Bean • 在struts.xml中还可以作JavaBean的定义如下： s • <!--在struts.xml中定义Bean ---> • <struts> • <bean type="com.opensymphony.xwork2.ObjectFactory" • name="myfactory" • class="com.company.myapp.MyObjectFactory" /> • </struts>

16. 5.4.7 在struts.xml中使用通配符 • 当配置文件中action mapping的数量很多的时候，使用通配符是一个很好的办法，可以将一些相似的mapping绑在一起，用一个比较通用的mapping来表示。在路径中用*来代替变化的部分，而action的处理类和JSP中{1}刚好是代替这个变量。 • <!--在struts.xml中使用通配符--> • <action name="/edit*” class="example.Edit{1}Action"> • <result name="failure" path="/mainMenu.jsp"/> • <result name=”ok” path="/\{1\}.jsp"/> • </action>

17. 5.5 实现Action • Action是Struts2编程的核心部分，反映了对Web应用程序的功能需求。Action在MVC模式中担任控制部分的角色，在Struts2中也使用的最多。每个请求的动作都对应于一个相应的action，action还可以负责存储数据/状态（以getter和setter的方式）并且执行逻辑处理。 • 在本章中将关注如何实现action，以及action如何提供Web应用程序中所需的通用功能。除了Action接口之外，Struts2的action也可以选择实现其他可选择的接口，从而使action能够提供诸如国际化、校验、负责工作流和错误信息处理等功能。ActionSupport基类实现了Action接口并提供了大部分可选择口默认实现，将在本章深入讲述这个类。除此之外，也将探讨action是如何通过使用JavaBean属性提供输入和输出的，最后将介绍如何处理文件上传。

18. 5.5.1 实现Aciton接口 • Struts2的Action接口来源于WebWork，全包名为com.opensymphony.xwork2.Action如代码5-10所示。在Struts2中定义action类时已经可以不实现Aciton接口，Struts2会以反射的方式来调用action类。

19. 5.5.2 扩展ActionSupport类 • ActionSupport是一个让action类能够更快开始工作的基类。它包含了action能够提供的许多可选服务的默认实现，让开发者更容易地开始开发自己的action类，不需要在为这些可选服务提供具体实现了。同时能够改写可选择接口的任意一个方法实现并保持其他方法的默认实现。由于ActionSupport预建了许多开箱即用的功能，建议读者创建自己的action时都扩展ActionSupport类。ActionSupport实现了以下可选择接口，

20. 5.5.3 实现基本校验 • 通常在执行业务逻辑之前，校验用户提供的数据是十分表要的。这种字段校验包括“某个字段是必须的”、“某个字段必须大于某个值，小于某个值“等内容。为了自动执行校验，Sturts 2提供了一种能够在excuete()方法被调用之前调用其他方法对action进行处理的机制，这个机制由com.opensymphony.xwork2.Validateable接口提供，它包含了一个方法： • public void validate() • Validateable接口为action增加了一个标记，通过以上方法使得action能够自动被校验。 • 保存和显示校验的错误信息有接口ValidationAware来负责，这两个接口一般会同时使用。

21. 5.5.4 使用本地的资源文件 • 本节中将介绍另外两个接口TextProvider和LocalProvider，它们都是为了使用本地的资源文件而设计的。 • 在Java中用户语言和地区的信息被封装在java.util.Local类中，而action则通过一个定义与com.opensymphony.xwork.LocaleProvider接口的方法判断使用哪个Locale获取用于显示的信息文本，这个接口中只定义了一个方法： • Public Locale getLocale() • 在ActionSupport中，这个方法的默认实现为：通过调用AcitonContext.getContext ().getLocale()方法，利用ActionContext获得locale的值（关于ActionContext的使用将在后面的章节详细描述）。Struts2通过查询HttpServletRequest对象并调用它的getLocale () 方法将Local与action调用联系起来。

22. 5.5.5 用ActionContext与Web容器发生联系 • 在Action的接口定义中，excute()方法并没有HttpServletRequest和HttpServletResponse参数也就是说Struts2的Action不用去依赖于任何Web容器（不像Struts 1必须在Web容器中才能运行），不用与那些JavaServlet复杂的请求（Request）、响应(Response)关联在一起。但在Web应用程序开发中，往往需要在Action里直接获取请求(Request)或会话（Session）的一些信息，甚至需要直接对JavaServlet Http的请求、响应操作。Struts2 提供了一个工具，用ActionContext对象来与Web容器发生联系。 • ActionContext（com.opensymphony.xwork.ActionContext）是Action执行时的上下文，上下文可以把它看作是一个Map，它存放是Action在执行时需要用到的对象，比如：上下文放有请求的参数（Parameter）、会话（Session）、Servlet上下文（ServletContext）、本地化（Locale）信息等。在每次执行Action之前都会创建新的ActionContext，ActionContext是线程安全的，也就是说在同一个线程里ActionContext里的属性是唯一的，这样的Action就可以在多线程中使用。

23. 5.5.6 高级输入 • 应用程序经常使用JavaBean表示一个域中的对象，包括User、Address、Block在内地的类就是这种JavaBean很好的例子。而在Web程序中很大一部工作都是将信息填充到这些对象中去和从Bean中获取数据信息在网页中表现。本节将以一个完整的实例来说明Sturts 2在这些方面提供了那些便利。

24. 5.5.7 使用Model-Driven • Struts2中，提供了两种Action驱动模式：Property-Driven（属性驱动），Model-Driven（模型驱动的）。 • 模型驱动的Action很像Struts1中的FormBean，在传递过程中有一个单独的值对象来作为参数的载体，但在Struts2中这个值对象不必再继承任何接口，只要普通JavaBean就可以充当模型部分。很多情况下Bean的定义已经存在了，而且是不能修改的（如从外部引入的类或者是已经被大量代码引用的类），如果必须实现某个接口才能作为FromBean，不得不再新增一个类，Struts2的这个改进非常及时。

25. 5.5.8 使用Property-Driven • Property-Driven 就是Action将直接用自己的字段来充当FormBean的功能，在Struts2入门一章中，HelloReader这个例子就是采用的这种方法，在Action中直接包含了message属性和它set、get方法。它一般用在页面表单比较简单的情况使用，而且可以直接把属性作为Action的字段，这样就不用在另写FormBean，减少了重复代码。 • 上一节的例子如果使用Property-Driven方法，那就是将User与action类合并定义，把User中的属性值直接转移到action中去，在配置文件中也不必再增加modelDriven这个过滤器。

26. 5.6 Result类型介绍 • Result是在Action执行完，一个结果返回后决定发生什么事的类。开发者可以自由的根据他们的应用和环境的需要创建自己的Result类型。例如在Struts2中Servlet和Velocity结果类型已经被创建用来显示web应用程序的画面。本节将介绍Struts2 内置的几种Result类型和如何自定义开发Result。

27. 5.6.1 内置Result类型 • 所有的Result类型都实现了com.opensymphony.xwork.Result接口。这个接口是所有action执行结果的通用接口，不管这个结果是用来显示一个网页还是产生一个E-mail，发送一个JMS消息还是别的。 • 在struts-default.xml中定义了系统提供的缺省Result类型，把它们映射为action配置中可以引用的名字，在action配置就就不用再使用长类名直接使用这些别名就可以了。

28. 5.6.2 默认Result • Dispatcher Result是最常用的一种result，它也是Struts2默认的result，又称为通用resut。action执行完后，请求会导向对应的View，相当于<jsp:forword>标签实现的跳转功能。将同一个HTTP请求中的内容分发至某一个页面(dispatcher类型的result的使用)只要配置文件包含了struts-default.xml，而且package继承了struts-default，那么使用dispatcher result并不需要其他设置。示例： • <result name="success" type="dispatcher"> • <param name="location">foo.jsp</param> • </result>

29. 5.6.3 页面跳转 Result • Redirect Result与Dispatcher Result作用类似也是实现页面跳转。对上次的响应将重定向到指定的位置，可以理解为在客户端跳转用户又重新请求了一个新的URL。redirect是重新产生一个新的request，因此原来request保存的东西将不再有效，比如不能通过再requet.getAtrribute()取得对象，也不能取得action的实例、errors、field errors等。 • Redirect Result与Dispatcher Result的区别于源于JSP篇中<jsp:forward>标签与response.redeiret()的区别。

30. 5.6.4 创建action链 • Chain Result是一种result 类型，它基于自己的拦截器stack（堆栈）和result调用一个action，这样允许一个action附带着原来的状态将请求转到目标action • Struts2提供把多个Action按照预先定义好的顺序或者流程链接起来的能力。这个特性通过给指定的Action设置一个Chain Result，然后通过一个ChainingInterceptor拦截目标Action来实现。

31. 5.6.5 整合各种View技术 • Velocity、Freemarker、JasperReports、xslt这4种result都是为了整合不同的视图技术而设计的。 • 1．Velocity Result:Velocity是一个基于java的模板引擎（template engine）。 • 2．Freemarker Result:Freemarker也是一个模板引擎，允许JavaServlet保持图形设计同应用程序逻辑的分离，这是通过在模板中密封HTML完成的。模板用servlet提供的数据动态地生成 HTML。 • 3．JasperReports result:JasperReports是一个基于Java的开源报表工具，它可以在Java环境下像其他IDE报表工具一样来制作报表。 • 4．XSLT Result:XSLT Result用XSLT来转换action对象到XML。

32. 5.6.6 自定义result • Struts2也允许用户自定义自己的result类型，只要实现com.opensymphony.xwork2.Result接口就可以了。如代码5-29所示，模拟了一种result作用是根据处理结果将给指用户发送一份E-mail。这个result需要4个参数to、from、subject和body

33. 5.7 拦截器（Interceptors）介绍 • 拦截器（Interceptor）是Struts2的一个强有力的工具，有许多功能都是构建于它之上，如国际化、转换器，校验等。Interceptor是Struts2的一大特色，在执行action之前和之后可以使请求通过一个或多个Interceptor。多个连接器组合在一起实现某一个功能称为interceptor链（Interceptor Chain，在Struts2中称为拦截器栈Interceptor Stack）。interceptor链就是将interceptor按一定的顺序联结成一条链。在访问被拦截的方法或字段时，interceptor链中的interceptor就会按其之前定义的顺序被调用。

34. 5.7.1 Interceptor的原理 • Struts2的interceptor实现相对简单。当请求到达Struts2的ServletDispatcher时，Struts2会查找配置文件，并根据其配置实例化相对的interceptor对象，然后串成一个列表（list），最后一个一个地调用列表中的拦截器，

35. 5.7.2 内置拦截器介绍 • Struts2包含了许多内置的interceptor，它们提供了很多核心功能和可选的高级特性。interceptor在struts.default.xml文件中被定义，而一些默认的interceptor栈及interceptor的命名也被定义其中。框架中提供了很多实用的Interceptor，可以随时使用它们的名字来调用这些interceptor，

36. 5.7.3 使用内置interceptor • 本节将介绍几种常用interceptor的用法： • 1．使用timer为action即时 • 2．使用logger 为aciton提供日志 • 3．使用校验 • 4．准备action • 5．实现ModelDriven • 6．token和token-session

37. 5.7.4 内置拦截器栈介绍 • 除了内置的interceptor之外，struts.xml还包含了内置的interceptor组合，可以通过具体的命名的interceptor栈来使用它们。

38. 5.7.5 自定义拦截器 • 自定义一个拦截器需要3个步骤： • （1）自定义一个实现Interceptor接口的类。 • （2）在strutx.xml中注册上一步中定义的拦截器。 • （3）在需要使用的Action中引用上述定义的拦截器，为了方便也可将拦截器定义为默认的拦截器，这样在不加特殊声明的情况下所有的Action都被这个拦截器拦截。

39. 5.8 小结 • 本章讲述的是Struts2的核心构成元素及其使用方法，使读者对Sturts 2的体系结构有了一个清晰的认识。Struts2是一个开放的系统，它的很多实现对用户来说都是透明的，它们在struts-default.xml 中配置，开发人员配置自己的元素在struts.xml中，这个文件是可以拆分并按用户需要组织的。Struts2的核心部分由action、interceptor、result3个主要部分构成，Interceptor是它最大特色。