Struts 2权威指南：基于WebWork核心的MVC开发

来源：互联网发布：淘宝6.2.1下载编辑：程序博客网时间：2024/04/28 11:33

3.5 Struts 2的基本配置

前面大致了解了Struts 2框架的基本内容，但这些基本内容都必须建立在Struts 2的配置文件基础之上，这些配置文件的配置信息也是Struts 2应用的核心部分。

3.5.1 配置web.xml文件

任何MVC框架都需要与Web应用整合，这就不得不借助于web.xml文件，只有配置在web.xml文件中Servlet才会被应用加载。

通常，所有的MVC框架都需要Web应用加载一个核心控制器，对于Struts 2框架而言，需要加载FilterDispatcher，只要Web应用负责加载FilterDispatcher，FilterDispatcher将会加载应用的Struts 2框架。

因为Struts 2将核心控制器设计成Filter，而不是一个普通Servlet。故为了让Web应用加载FilterDispacher，只需要在web.xml文件中配置FilterDispatcher即可。

配置FilterDispatcher的代码片段如下：

<filter-name>struts</filter-name>

<filter-class>org.apache.struts2.dispatcher.FilterDispatcher

</filter-class>

<init-param>

<param-name>actionPackages</param-name>

<param-value>org.apache.struts2.showcase.person</param-value>

</init-param>

<init-param>

<param-name>configProviders</param-name>

<param-value>lee.MyConfigurationProvider</param-value>

</init-param>

</filter>

正如上面看到的，当配置Struts 2的FilterDispatcher类时，可以指定一系列的初始化参数，为该Filter配置初始化参数时，其中有3个初始化参数有特殊意义：

— config：该参数的值是一个以英文逗号（,）隔开的字符串，每个字符串都是一个XML配置文件的位置。Struts 2框架将自动加载该属性指定的系列配置文件。

— actionPackages：该参数的值也是一个以英文逗号（,）隔开的字符串，每个字符串都是一个包空间，Struts 2框架将扫描这些包空间下的Action类。

— configProviders：如果用户需要实现自己的ConfigurationProvider类，用户可以提供一个或多个实现了ConfigurationProvider接口的类，然后将这些类的类名设置成该属性的值，多个类名之间以英文逗号（,）隔开。

除此之外，还可在此处配置Struts 2常量，每个<init-param>元素配置一个Struts 2常量，其中<param-name>子元素指定了常量name，而<param-value>子元素指定了常量value。

提示关于Struts 2常量的讲解，请参阅本书的4.1.2节。

在web.xml文件中配置了该Filter，还需要配置该Filter拦截的URL。通常，我们让该Filter拦截所有的用户请求，因此使用通配符来配置该Filter拦截的URL。

下面是配置该Filter拦截URL的配置片段：

<filter-mapping>

<filter-name>struts</filter-name>

<url-pattern>/*</url-pattern>

</filter-mapping>

配置了Struts 2的核心FilterDispatcher后，基本完成了Struts 2在web.xml文件中的配置。

如果Web应用使用了Servlet2.3以前的规范，因为Web应用不会自动加载Struts 2框架的标签文件，因此必须在web.xml文件中配置加载Struts 2标签库。

配置加载Struts 2标签库的配置片段如下：

<taglib-uri>/s</taglib-uri>

<taglib-location>/WEB-INF/struts-tags.tld</taglib-location>

</taglib>

在上面配置片段中，指定了Struts 2标签库配置文件物理位置：/WEB-INF/struts- tags.tld，因此我们必须手动复制Struts 2的标签库定义文件，将该文件放置在Web应用的WEB-INF路径下。

如果Web应用使用Servlet2.4以上的规范，则无需在web.xml文件中配置标签库定义，因为Servlet 2.4规范会自动加载标签库定义文件。

提示 Struts2的标签库定义文件包含在struts2-core-2.0.6.jar文件里，在struts2-core-2.0.6.jar文件的META-INF路径下，包含了一个struts-tag.tld文件，这个文件就是Struts 2的标签库定义文件，Servlet2.4规范会自动加载该标签库文件。

对于Servlet 2.4以上的规范，Web应用自动加载该标签库定义文件。加载struts-tag.tld标签库定义文件时，该文件的开始部分包含如下代码片段：

<tlib-version>2.2.3</tlib-version>

<jsp-version>1.2</jsp-version>

<short-name>s</short-name>

<uri>/struts-tags</uri>

...

</taglib>

因为该文件中已经定义了该标签库的URI：struts-tags，这就避免了在web.xml文件中重新定义Struts 2标签库文件的URI。

3.5.2 struts.xml配置文件

Struts框架的核心配置文件就是struts.xml配置文件，该文件主要负责管理Struts 2框架的业务控制器Action。

在默认情况下，Struts 2框架将自动加载放在WEB-INF/classes路径下的struts.xml文件。在大部分应用里，随着应用规模的增加，系统中Action数量也大量增加，导致struts.xml配置文件变得非常臃肿。

为了避免struts.xml文件过于庞大、臃肿，提高struts.xml文件的可读性，我们可以将一个struts.xml配置文件分解成多个配置文件，然后在struts.xml文件中包含其他配置文件。

下面的struts.xml文件中就通过include手动导入了一个配置文件：struts-part1.xml文件，通过这种方式，就可以将Struts 2的Action按模块配置在多个配置文件中。

<?xml version="1.0"encoding="UTF-8" ?>

<!DOCTYPE struts PUBLIC

"-//Apache SoftwareFoundation//DTD Struts Configuration 2.0//EN"

"http://struts.apache.org/dtds/struts-2.0.dtd">

<includefile="struts-part1.xml" />

...

</struts>

通过这种方式，Struts 2提供了一种模块化的方式来管理struts.xml配置文件。

除此之外，Struts 2还提供了一种插件式的方式来管理配置文件。用WinRAR等解压缩软件打开struts2-core-2.0.6.jar文件，看到如图3.21所示的文件结构，在光标选中的一行，看到有一个struts-default.xml文件。

图3.21 struts2-core-2.0.6.jar压缩文件的文件结构

查看struts-default.xml文件，看到该文件代码片段如下：

<?xml version="1.0"encoding="UTF-8" ?>

<!DOCTYPE struts PUBLIC

"-//Apache SoftwareFoundation//DTD Struts Configuration 2.0//EN"

"http://struts.apache.org/dtds/struts-2.0.dtd">

<beanclass="com.opensymphony.xwork2.ObjectFactory" name="xwork"/>

<beantype="com.opensymphony.xwork2.ObjectFactory" name="struts"

class="org.apache.struts2.impl.StrutsObjectFactory"/>

....

<beanclass="com.opensymphony.xwork2.util.OgnlValueStack"static="true" />

<beanclass="org.apache.struts2.dispatcher.Dispatcher"static="true" />

...

<packagename="struts-default">

<result-types>

<result-typename="chain" class="com.opensymphony.xwork2.

ActionChainResult"/>

<!--定义Dispatcher的Result类型，并设置default="true"，

指定该结果Result是默认的Result类型 -->

<result-typename="dispatcher"

class="org.apache.struts2.dispatcher.Servlet

DispatcherResult"default="true"/>

<result-typename="freemarker"

class="org.apache.struts2.views.freemarker.

FreemarkerResult"/>

...

</result-types>

<interceptorname="alias" class="com.opensymphony.xwork2.

interceptor.AliasInterceptor"/>

<interceptorname="autowiring"

class="com.opensymphony.xwork2.spring.interceptor.

ActionAutowiringInterceptor"/>

...

<interceptor-stackname="basicStack">

<interceptor-refname="exception"/>

<interceptor-refname="servlet-config"/>

<interceptor-refname="prepare"/>

<interceptor-refname="checkbox"/>

<interceptor-refname="params"/>

<interceptor-refname="conversionError"/>

</interceptor-stack>

...

</interceptors>

<default-interceptor-refname="defaultStack"/>

</package>

</struts>

上面的代码并未全部列出struts-default.xml文件，只是列出了每个元素的代表。上面配置文件中定义了一个名字为struts-default的包空间，该包空间里定义了Struts 2内建的Result类型，还定义了Struts2内建的系列拦截器，以及由不同拦截器组成的拦截器栈，文件的最后还定义了默认的拦截器引用。

这个struts-default.xml文件是Struts 2框架的默认配置文件，Struts 2框架每次都会自动加载该文件。查看我们前面使用的struts.xml文件，看到我们自己定义的package元素有如下代码片段：

<packagename="lee" extends="struts-default">

...

</package>

</struts>

在上面配置文件中，名为lee的包空间，继承了名为struts-default的包空间，struts-default包空间定义在struts-default.xml文件中。可见，Struts 2框架默认会加载struts-default.xml文件。

不仅如此，Struts2框架提供了一种类似Eclipse的扩展方式，它允许以一种“可插拔”的方式来安装插件，例如后面将要介绍的Spring插件、JSF插件等，它们都提供了一个类似struts2-Xxx-plugin.jar的文件——这个文件就是插件安装文件，只要将该文件放在Web应用的WEB-INF/lib路径下，Struts 2框架将自动加载该框架。

使用WinRAR工具打开struts2-spring-plugin2.06.jar文件，找到一个struts-plugin.xml文件，打开该文件，该文件的代码如下：

<?xml version="1.0"encoding="UTF-8" ?>

<!DOCTYPE struts PUBLIC

"-//Apache SoftwareFoundation//DTD Struts Configuration 2.0//EN"

"http://struts.apache.org/dtds/struts-2.0.dtd">

<beantype="com.opensymphony.xwork2.ObjectFactory" name="spring"

class="org.apache.struts2.spring.StrutsSpringObjectFactory"/>

<constantname="struts.objectFactory" value="spring" />

<packagename="spring-default">

<interceptorname="autowiring"

class="com.opensymphony.xwork2.spring.interceptor.

ActionAutowiringInterceptor"/>

<interceptorname="sessionAutowiring"

class="org.apache.struts2.spring.interceptor.

SessionContextAutowiringInterceptor"/>

</interceptors>

</package>

</struts>

在上面配置文件中，配置了Struts 2与Spring框架整合必需的常量、拦截器等——这也是Struts2框架使用Spring插件必需的配置。只要将struts2-spring-plugin2.06.jar文件放在WEB-INF/lib路径下，Struts 2框架将自动加载该文件。

提示如果用户开发属于自己的Struts 2插件，只要将对应的struts-plugin. xml文件放在JAR文件中，Struts 2框架将自动加载该文件。通过这种方式，Struts 2框架允许使用可插拔的方式管理Struts 2的插件。

3.5.3 struts.properties配置文件

Struts2框架有两个核心配置文件，其中struts.xml文件主要负责管理应用中的Action映射，以及该Action包含的Result定义等。除此之外，Struts 2框架还包含一个struts.properties文件，该文件定义了Struts2框架的大量属性，开发者可以通过改变这些属性来满足应用的需求。

struts.properties文件是一个标准的Properties文件，该文件包含了系列的key-value对象，每个key就是一个Struts 2属性，该key对应的value就是一个Struts 2属性值。

struts.properties文件通常放在Web应用的WEB-INF/classes路径下。实际上，只要将该文件放在Web应用的CLASSPATH路径下，Struts 2框架就可以加载该文件。

现在的问题是，struts.properties文件的哪些key是有效的？即struts.properties文件里包含哪些属性是有效的Struts 2属性。下面列出了可以在struts.properties中定义的Struts 2属性。

— struts.configuration：该属性指定加载Struts2配置文件的配置文件管理器。该属性的默认值是org.apache.Struts2.config.DefaultConfiguration，这是Struts2默认的配置文件管理器。如果需要实现自己的配置管理器，开发者则可以实现一个实现Configuration接口的类，该类可以自己加载Struts2配置文件。

— struts.locale：指定Web应用的默认Locale。

— struts.i18n.encoding：指定Web应用的默认编码集。该属性对于处理中文请求参数非常有用，对于获取中文请求参数值，应该将该属性值设置为GBK或者GB2312。

提示当设置该参数为GBK时，相当于调用HttpServletRequest的setCharacterEncoding方法。

— struts.objectFactory：指定Struts 2默认的ObjectFactory Bean，该属性默认值是spring。

— struts.objectFactory.spring.autoWire：指定Spring框架的自动装配模式，该属性的默认值是name，即默认根据Bean的name属性自动装配。

— struts.objectFactory.spring.useClassCache：该属性指定整合Spring框架时，是否缓存Bean实例，该属性只允许使用true和false两个属性值，它的默认值是true。通常不建议修改该属性值。

— struts.objectTypeDeterminer：该属性指定Struts 2的类型检测机制，通常支持tiger和notiger两个属性值。

— struts.multipart.parser：该属性指定处理multipart/form-data的MIME类型（文件上传）请求的框架，该属性支持cos、pell和jakarta等属性值，即分别对应使用cos的文件上传框架、pell上传及common-fileupload文件上传框架。该属性的默认值为jakarta。

注意如果需要使用cos或者pell的文件上传方式，则应该将对应的JAR文件复制到Web应用中。例如，使用cos上传方式，则需要自己下载cos框架的JAR文件，并将该文件放在WEB-INF/lib路径下。

— struts.multipart.saveDir：该属性指定上传文件的临时保存路径，该属性的默认值是javax.servlet.context.tempdir。

— struts.multipart.maxSize：该属性指定Struts 2文件上传中整个请求内容允许的最大字节数。

— struts.custom.properties：该属性指定Struts2应用加载用户自定义的属性文件，该自定义属性文件指定的属性不会覆盖struts.properties文件中指定的属性。如果需要加载多个自定义属性文件，多个自定义属性文件的文件名以英文逗号（,）隔开。

— struts.mapper.class：指定将HTTP请求映射到指定Action的映射器，Struts2提供了默认的映射器：org.apache.struts2.dispatcher.mapper.DefaultActionMapper。默认映射器根据请求的前缀与Action的name属性完成映射。

— struts.action.extension：该属性指定需要Struts 2处理的请求后缀，该属性的默认值是action，即所有匹配*.action的请求都由Struts 2处理。如果用户需要指定多个请求后缀，则多个后缀之间以英文逗号（,）隔开。

— struts.serve.static：该属性设置是否通过JAR文件提供静态内容服务，该属性只支持true和false属性值，该属性的默认属性值是true。

— struts.serve.static.browserCache：该属性设置浏览器是否缓存静态内容。当应用处于开发阶段时，我们希望每次请求都获得服务器的最新响应，则可设置该属性为false。

— struts.enable.DynamicMethodInvocation：该属性设置Struts 2是否支持动态方法调用，该属性的默认值是true。如果需要关闭动态方法调用，则可设置该属性为false。

— struts.enable.SlashesInActionNames：该属性设置Struts 2是否允许在Action名中使用斜线，该属性的默认值是false。如果开发者希望允许在Action名中使用斜线，则可设置该属性为true。

— struts.tag.altSyntax：该属性指定是否允许在Struts 2标签中使用表达式语法，因为通常都需要在标签中使用表达式语法，故此属性应该设置为true，该属性的默认值是true。

— struts.devMode：该属性设置Struts2应用是否使用开发模式。如果设置该属性为true，则可以在应用出错时显示更多、更友好的出错提示。该属性只接受true和flase两个值，该属性的默认值是false。通常，应用在开发阶段，将该属性设置为true，当进入产品发布阶段后，则该属性设置为false。

— struts.i18n.reload：该属性设置是否每次HTTP请求到达时，系统都重新加载资源文件。该属性默认值是false。在开发阶段将该属性设置为true会更有利于开发，但在产品发布阶段应将该属性设置为false。

提示开发阶段将该属性设置了true，将可以在每次请求时都重新加载国际化资源文件，从而可以让开发者看到实时开发效果；产品发布阶段应该将该属性设置为false，是为了提供响应性能，每次请求都需要重新加载资源文件会大大降低应用的性能。

— struts.ui.theme：该属性指定视图标签默认的视图主题，该属性的默认值是xhtml。

— struts.ui.templateDir：该属性指定视图主题所需要模板文件的位置，该属性的默认值是template，即默认加载template路径下的模板文件。

— struts.ui.templateSuffix：该属性指定模板文件的后缀，该属性的默认属性值是ftl。该属性还允许使用ftl、vm或jsp，分别对应FreeMarker、Velocity和JSP模板。

— struts.configuration.xml.reload：该属性设置当struts.xml文件改变后，系统是否自动重新加载该文件。该属性的默认值是false。

— struts.velocity.configfile：该属性指定Velocity框架所需的velocity.properties文件的位置。该属性的默认值为velocity.properties。

— struts.velocity.contexts：该属性指定Velocity框架的Context位置，如果该框架有多个Context，则多个Context之间以英文逗号（,）隔开。

— struts.velocity.toolboxlocation：该属性指定Velocity框架的toolbox的位置。

— struts.url.http.port：该属性指定Web应用所在的监听端口。该属性通常没有太大的用户，只是当Struts2需要生成URL时（例如Url标签），该属性才提供Web应用的默认端口。

— struts.url.https.port：该属性类似于struts.url.http.port属性的作用，区别是该属性指定的是Web应用的加密服务端口。

— struts.url.includeParams：该属性指定Struts 2生成URL时是否包含请求参数。该属性接受none、get和all三个属性值，分别对应于不包含、仅包含GET类型请求参数和包含全部请求参数。

— struts.custom.i18n.resources：该属性指定Struts 2应用所需要的国际化资源文件，如果有多份国际化资源文件，则多个资源文件的文件名以英文逗号（,）隔开。

— struts.dispatcher.parametersWorkaround：对于某些JavaEE服务器，不支持HttpServletRequest调用getParameterMap()方法，此时可以设置该属性值为true来解决该问题。该属性的默认值是false。对于WebLogic、Orion和OC4J服务器，通常应该设置该属性为true。

— struts.freemarker.manager.classname：该属性指定Struts2使用的FreeMarker管理器。该属性的默认值是org.apache.struts2.views.freemarker.FreemarkerManager，这是Struts2内建的FreeMarker管理器。

— struts.freemarker.wrapper.altMap：该属性只支持true和false两个属性值，默认值是true。通常无需修改该属性值。

— struts.xslt.nocache：该属性指定XSLT Result是否使用样式表缓存。当应用处于开发阶段时，该属性通常被设置为true；当应用处于产品使用阶段时，该属性通常被设置为false。

— struts.configuration.files：该属性指定Struts2框架默认加载的配置文件，如果需要指定默认加载多个配置文件，则多个配置文件的文件名之间以英文逗号（,）隔开。该属性的默认值为struts-default.xml,struts-plugin.xml,struts.xml，看到该属性值，读者应该明白为什么Struts2框架默认加载struts.xml文件了。

在有些时候，开发者不喜欢使用额外的struts.properties文件，Struts 2允许在struts.xml文件中管理Struts 2属性，在struts.xml文件中通过配置constant元素，一样可以配置这些属性。

struts.xml配置片段如下：

<?xmlversion="1.0" encoding="UTF-8" ?>

<!DOCTYPE strutsPUBLIC

"-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"

"http://struts.apache.org/dtds/struts-2.0.dtd">

<constantname=" struts.custom.i18n.resources " value="mess" />

...

</struts>

上面代码片段配置了一个常用属性：struts.custom.i18n.resources，该属性指定了应用所需的国际化资源文件的baseName为mess。

提示 Struts 2提供了两种方式来管理Struts 2的属性：既可以通过struts.properties文件来配置Struts 2属性，也可通过在struts.xml文件中配置constant元素来配置Struts 2属性。

3.5.4 struts.xml文件结构

struts.xml文件是整个Struts 2框架的核心，下面提供了一个最完整的struts.xml文件，这个文件没有任何实际意义，仅仅是一个struts.xml文件示范。

<?xml version="1.0"encoding="GBK"?>

<!DOCTYPE struts PUBLIC

"-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"

"http://struts.apache.org/dtds/struts-2.0.dtd">

<constantname="" value="" />

<beantype="" name="" class="" scope="" static=""optional="" />

<includefile="" />

<packagename="必填的包名"extends="" namespace="" abstract=""

externalReferenceResolver>

<result-types>

<result-typename="" class="" default="true|false">

<paramname="参数名">参数值</param>*

</result-type>

</result-types>

<!--该元素的interceptor元素和interceptor-stack至少出现其中之一，

也可以二者都出现 -->

<interceptorname="" class="">

<paramname="参数名">参数值</param>*

</interceptor>

<interceptor-stackname="">

<interceptor-refname="">

<paramname="参数名">参数值</param>*

</interceptor-ref>

</interceptor-stack>

</interceptors>

<default-interceptor-refname="">

<paramname="参数名">参数值</param>

</default-interceptor-ref>

<default-action-refname="">

<paramname="参数名">参数值</param>*

</default-action-ref>?

<global-results>

<resultname="" type="">

映射资源

<paramname="参数名">参数值</param>*

</result>

</global-results>

<global-exception-mappings>

<exception-mappingname="" exception="" result="">

异常处理资源

<paramname="参数名">参数值</param>*

</exception-mapping>

</global-exception-mappings>

<actionname="" class="" method="" converter="">

<paramname="参数名">参数值</param>*

<resultname="" type="">

映射资源

<paramname="参数名">参数值</param>*

</result>

<interceptor-refname="">

<paramname="参数名">参数值</param>*

</interceptor-ref>

<exception-mappingname="" exception="" result="">

异常处理资源

<paramname="参数名">参数值</param>*

</exception-mapping>

</action>

</package>*

上面的struts.xml配置文件是一个非常全面的配置文件，包含了Struts 2的全部配置元素。上面配置文件主要用于帮助对XML DTD不太熟悉的读者。

实际上，如果读者需要熟悉XML文件的DTD（元素类型定义）语法，通过查看Struts 2配置文件的DTD信息，同样可以了解Struts 2配置文件的结构。下面是Struts 2配置文件的DTD文件代码。

<!--

Struts configuration DTD.

Use the following DOCTYPE

<!DOCTYPE struts PUBLIC

"-//ApacheSoftware Foundation//DTD Struts Configuration 2.0//EN"

"http://struts.apache.org/dtds/struts-2.0.dtd">

-->

<!ELEMENT struts(package|include|bean|constant)*>

<!ELEMENT package (result-types?,interceptors?, default-interceptor-ref?, default-action-ref?, global-results?,global-exception-mappings?, action*)>

<!ATTLIST package

name CDATA #REQUIRED

extends CDATA #IMPLIED

namespace CDATA #IMPLIED

abstract CDATA #IMPLIED

externalReferenceResolverNMTOKEN #IMPLIED

<!ELEMENT result-types (result-type+)>

<!ELEMENT result-type (param*)>

<!ATTLIST result-type

name CDATA #REQUIRED

class CDATA #REQUIRED

default (true|false)"false"

<!ELEMENT interceptors(interceptor|interceptor-stack)+>

<!ELEMENT interceptor (param*)>

<!ATTLIST interceptor

name CDATA #REQUIRED

class CDATA #REQUIRED

<!ELEMENT interceptor-stack(interceptor-ref+)>

<!ATTLIST interceptor-stack

name CDATA #REQUIRED

<!ELEMENT interceptor-ref (param*)>

<!ATTLIST interceptor-ref

name CDATA #REQUIRED

<!ELEMENT default-interceptor-ref (param*)>

<!ATTLIST default-interceptor-ref

name CDATA #REQUIRED

<!ELEMENT default-action-ref (param*)>

<!ATTLIST default-action-ref

name CDATA #REQUIRED

<!ELEMENT global-results (result+)>

<!ELEMENT global-exception-mappings(exception-mapping+)>

<!ELEMENT action (param|result|interceptor-ref|exception-mapping)*>

<!ATTLIST action

name CDATA #REQUIRED

class CDATA #IMPLIED

method CDATA #IMPLIED

converter CDATA #IMPLIED

<!ELEMENT param (#PCDATA)>

<!ATTLIST param

name CDATA #REQUIRED

<!ELEMENT result (#PCDATA|param)*>

<!ATTLIST result

name CDATA #IMPLIED

type CDATA #IMPLIED

<!ELEMENT exception-mapping(#PCDATA|param)*>

<!ATTLIST exception-mapping

name CDATA #IMPLIED

exception CDATA #REQUIRED

result CDATA #REQUIRED

<!ELEMENT include (#PCDATA)>

<!ATTLIST include

file CDATA #REQUIRED

<!ELEMENT bean (#PCDATA)>

<!ATTLIST bean

type CDATA #IMPLIED

name CDATA #IMPLIED

class CDATA #REQUIRED

scope CDATA #IMPLIED

static CDATA #IMPLIED

optional CDATA #IMPLIED

<!ELEMENT constant (#PCDATA)>

<!ATTLIST constant

name CDATA #REQUIRED

value CDATA #REQUIRED