Struts2配置文件讲解

Struts2用于处理用户请求的Action,没有与Servlet API耦合,显示无法处理用户请求,而Struts2提供了系列拦截器,该系列拦截器负责将HttpServletRequest请求中的请求参数解析出来,传入到Action中,并调用Action的execute方法来处理用户的请求.Struts2框架中使用包来管理action,避免了Servlet在web.xml中难以管理的与维护的局面.

 

配置包时必须指定name属性,该name属性值可以任意取名,但必须唯一,如果其他包要继承该包,必须通过该属性进行引用,包的namespace属性用于定义该包的命名空间,命名空间作用为访问该包下的action路径的一部分,见示例.namespace属性可以不配置,如果不指定该属性,默认的命名空间为””

通常每个包都应该继承struts-default包,因为struts2很多核心功能都是拦截来实现的,如,从请求中把请求参数封闭到action,文件上传和数据验证等都是通过拦截器实现的,struts-default定义了这些拦截器和Result类型,可以这么说,当包继承了struts-default才能使用struts2提供的核心功能,struts-default包是在struts2-core-2.xx.jar文件中的struts-defalut.xml中定义,struts-default.xml也是struts2默认配置文件,struts2每次都会自动加载struts-default.xml文件.

package还有一个abstract=”true”属性,指定此包为抽象包,和抽象类的概念差不多,说明此包只能被其他包继承,则它里面不允许包含action元素.

<action name="HelloWorld" class="chapter1.action.Chapter1Action" method="execute">
<result name="success">/WEB-INF/JspPage/chapter1/HelloWorld.jsp</result>
</action>
Action 元素method属性,默认值为method=”execute”,也就是当action接收到请求后,交给哪个方法去处理,默认的是交给execute方法去处理,当然,也可以交给其他方法,后面会讲解到.

<result name="success">/WEB-INF/JspPage/chapter1/HelloWorld.jsp</result>
result元素主要定义视图的跳转和返回的行为及类型,后面会详细介绍.

struts.xml文件的分离

在实例开发中也是这样做的,通过一个主文件中,打开全局开关,引入其他子配置文件,如:
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE struts PUBLIC
"-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"
"http://struts.apache.org/dtds/struts-2.0.dtd">

<struts>
<constant name="struts.enable.DynamicMethodInvocation" value="false"/>
<constant name="struts.devMode" value="false"/>
<constant name="struts.i18n.encoding" value="UTF-8"/>
<constant name="struts.serve.static.browserCache " value="false"/>

<include file="chapter1.xml"/>
</struts>

常用开关的介绍
<constant name="struts.i18n.encoding" value="UTF-8"/>
指定Web应用的默认编码集，相当于调用HttpServletRequest的setCharacterEncoding方法

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

<constant name="struts.serve.static.browserCache " value="false"/>
设置浏览器是否缓存静态内容，默认值为true，开发阶段最好false

<constant name="struts.configuration.xml.reload" value="true"/>
当struts的配置文件修改后，系统是否自动重新加载该文件，默认值为false，开发阶段最好true

<constant name="struts.devMode" value="true"/>
开发模式下设为true，这样可以打印出更详细的错误信息

<constant name="struts.enable.DynamicMethodInvocation" value="false"/>
动态方法调用,可以解决多个请求对应一个Servlet的问题,后面详细讲解,默认为true,关闭则设为false.

 

<constant name="struts.enable.SlashesInActionNames" value="false"/>

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

<constant name="struts.tag.altSyntax" value="true"/>

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

<constant name="struts.i18n.reload" value="false"/>

struts.i18n.reload该属性设置是否每次HTTP请求到达时，系统都重新加载资源文件。该属性默认值是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应用所在的监听端口。该属性通常没有太大的用户，只是当Struts 2需要生成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 对于某些Java EE服务器，不支持HttpServlet Request调用getParameterMap()方法，此时可以设置该属性值为true来解决该问题。该属性的默认值是false。对于WebLogic、Orion和OC4J服务器，通常应该设置该属性为true。

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

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

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

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

Action配置中的各项默认值

请看下面的代码
<action name="Login">
<result>/WEB-INF/JspPage/chapter1/Login.jsp</result>
</action>
我们发现,当我们请求的路径为http://localhost:8080/Struts2/chapter1/Login时,同样可以实现页面的跳转,这是怎么回事呢?

如果没有为action指定class,默认是ActionSupport类
<action name="Login">
相当于
<action name="Login" class="com.opensymphony.xwork2.ActionSupport">

如果没有为action指定method,默认执行action中的execute()方法
<action name="Login">
相当于
<action name="Login" class="com.opensymphony.xwork2.ActionSupport"
method="execute">

如果没有指定result的name属性,默认值为success.
<result>
相当于
<result name="success">

提出一个问题ActionSupport这个类到底是个什么类呢?
首先要肯定的一点是他是一个具有execute方法的类,并且execute方法返回”success”字符串,因为只有这样,前面的运行结果才能说的通. ActionSupport还实现了很多其他的结果,提供了许多定制的功能.
ActionSupport类的作用
struts2不要求我们自己设计的action类继承任何的struts基类或struts接口，但是我们为了方便实现我们自己的action，大多数情况下都会继承com.opensymphony.xwork2.ActionSupport类，并重写此类里的public String execute() throws Exception方法。因为此类中实现了很多的实用借口，提供了很多默认方法，这些默认方法包括国际化信息的方法、默认的处理用户请求的方法等，这样可以大大的简化Acion的开发。
Struts2中通常直接使用Action来封装HTTP请求参数，因此，Action类里还应该包含与请求参数对应的属性，并且为属性提供对应的getter和setter方法。

 

3、<package>

 

1、包属性介绍

 

在Struts2框架中是通过包来管理action、result、interceptor、interceptor-stack等配置信息的。包属性如下：

 

属性	是否必需	描述
name	是	包名，作为其它包应用本包的标记
extends	否	设置本包继承其它包
namespace	否	设置包的命名空间
abstact	否	设置为抽象包

 

2、extends属性的详解

• 当一个包通过配置extends属性继承了另一个包的时候，该包将会继承父包中所有的配置，包括action、result、interceptor等。
• 由于包信息的获取是按照配置文件的先后顺序进行的，所以父包必须在子包之前被定义。
• 通常我们配置struts.xml的时候，都继承一个名为“struts-default.xml”的包，这是struts2中内置的包。

3、namespace的详解

namespace主要是针对大型项目中Action的管理，更重要的是解决Action重名问题，因为不在同一个命名空间的Action可以使用相同的Action名的。

 

1）如果使用命名空间则URL将改变

 

比如我们有一下配置文件

1 2 3 4 5

<packagename="wwfy"extends="struts-default">     <actionname="login"class="wwfy.action.LoginAction">         <result>/success.jsp</result>     </action> </package>

 

则此配置下的Action的URL为http://localhost:8080/login.action

 

假如为这个包指定了命名空间

1 2 3 4 5

<packagename="wwfy"extends="struts-default"namespace="/user">     <actionname="login"class="wwfy.action.LoginAction">         <result>/success.jsp</result>     </action> </package>

 

则此配置下的Action的URL为http://localhost:8080/user/login.action

 

2)默认命名空间

 

Struts2中如果没有为某个包指定命名空间,该包使用默认的命名空间,默认的命名空间总是""。

 

3）指定根命名空间

 

当设置了命名空间为“/”，即指定了包的命名空间为根命名空间时，此时所有根路径下的Action请求都会去这个包中查找对应的资源信息。

 

假若前例中路径为http://localhost:8080/login.action则所有http://localhost:8080/*.action都会到设置为根命名空间的包中寻找资源。

4、<action>与<result>

1、<action>属性介绍

 

属性名称	是否必须	功能描述
name	是	请求的Action名称
class	否	Action处理类对应具体路径
method	否	指定Action中的方法名
converter	否	指定Action使用的类型转换器

 

如果没有指定method则默认执行Action中的execute方法。

 

2、<result>属性介绍

 

属性名称	是否必须	功能描述
name	否	对应Action返回逻辑视图名称，默认为success
type	否	返回结果类型，默认为dispatcher,不同类型代表不同输出

 

 配置Result
一个result代表了一个可能的输出。当一个Action类的方法执行完成时，它返回一个字符串类型的结果码，框架根据这个结果码选择对应的result，向用户输出。
Results配置由两部分组成：一部分是result映射，另一部分是result类型。 
1．结果映射
         在struts.xml文件中，使用result元素来配置result映射。result元素有两个可选的属
性：    
属性      是否必须 说明
name    否            指定result的逻辑名
type      否            指定result的类型,不同类型的result代表了不同类型的结果输出. 
 
 在Struts2中允许定义一个默认的Result类型，这是通过result-type元素来定义的。在
框架的默认配置文件struts-default.xml中，在struts-default.xml包中有如下的一个配置：
         <result-types>
             <result-type name="dispatcher"
class="org.apache.struts2.dispatcher.ServletDispatcherResult" default="true"/>
         </result-types>
         result-type元素的default属性指定名为dispatcher的结果类型，
dispatcher结果类型使用ServletAPI中的ResultDispatcher将请求导向到目 标资源(通常是JSP页面)。如果在使用result元素配置result映射时，没有使用 type类型，那么框架就将使用默认的dispatcher类型。
  由于Struts2中的包是可以继承的，所以我们定义的package只要继承了 struts-default包，因此也继承了默认的结果类型，所以可以省略result元素的 type属性。 
 如果没有指定result元素的name属性，那么框架将把它命名为”success”。 2.结果类型
         在框架调用Action对请求进行处理之后，就要向用户呈现一个结果视图，Struts2
支持多种类型的视图，这些视图是由不同的结果类型来管理的。 
一个结果类型就是实现了com.opensymphony.xwork2.Result接口的类，在Struts2中定义了多种结果类型，如下表所示： 结果类型 说明
chain 用于Action链式处理
dispatcher 用于Web资源的集成，包括JSP的集成

freemarker 用于FreeMarker的集成

httpheader 用于控制特殊的HTTP行为
redirect 用于重定向到另外的URL(Web资源)
redirectAction 用于重定向到另外的action资源
stream 用于向浏览器返回一个InputStream(通常用于文件下载)

velocity 用于Velocity集成

xslt 用于XML/XSLT

plainText：用于显示某个特定页面(例如JSP,HTML)的原始内容(即页面的代码)

 

结果类型在包中使用result-type元素定义，以下列出的结果类型都是在框架的默认配置文件struts-default.xml中定义的。
   <result-types>
            <result-type name="chain"
class="com.opensymphony.xwork2.ActionChainResult"/>
            <result-type name="dispatcher"
class="org.apache.struts2.dispatcher.ServletDispatcherResult" default="true"/>
            <result-type name="freemarker"
class="org.apache.struts2.views.freemarker.FreemarkerResult"/>
            <result-type name="httpheader"
class="org.apache.struts2.dispatcher.HttpHeaderResult"/>
            <result-type name="redirect"
class="org.apache.struts2.dispatcher.ServletRedirectResult"/>
            <result-type name="redirectAction"
class="org.apache.struts2.dispatcher.ServletActionRedirectResult"/>
            <result-type name="stream"
class="org.apache.struts2.dispatcher.StreamResult"/>
            <result-type name="velocity"
class="org.apache.struts2.dispatcher.VelocityResult"/>
            <result-type name="xslt"
class="org.apache.struts2.views.xslt.XSLTResult"/>
            <result-type name="plainText"
class="org.apache.struts2.dispatcher.PlainTextResult" />  </result-types>
   我们也可以创建自己的结果类型注册到引用程序中。首先需要编写一个实现了  com.opensymphony.xwork2.Result接口的类，然后在struts.xml文件中使用result-type元素来注册你的结果类型。自定义的结果类型可以生成E-mail，或者生成JMS消息，也可以生成图像等。 
3.常用结果类型
   1> dispatcher结果类型：
        Struts2在后台使用Servlet API的RequestDispatcher来转发请求，因此在用户的整个请求/相应过程中，目标Servlet/JSP接收到的request/response对象，与最初的Servlet/JSP相同。
  disptcher结果类型的实现类是： 
org.apache.struts2.dispatcher.ServletDispatcherResult
       该类有两个属性：location和parse，这两个属性可以通过struts.xml
配置文件中的result元素的param子元素来设置。param元素的name属性

 

3、通配符的使用

随着result的增加，struts.xml文件也会随之变得越来越复杂。那么就可以使用通配符来简化配置：

例如下面这个案例：

Action为Test.java

 

1 2 3 4 5 6 7 8 9 10 11 12 13

publicclassTest {     publicString test1(){         return"result1";     }            publicString test2(){         return"result2";     }            publicString test3(){         return"result3";     } }

 

struts.xml中配置为

 

1 2 3 4 5

<packagename="wwfy"extends="struts-default">     <actionname="test*"class="wwfy.action.test{1}">         <resultname="result{1}">/result{1}.jsp</result>     </action> </package>

 

4、访问Action方法的另一种实现方式

 

在Struts2中如果要访问Action中的指定方法，还可以通过改变URL请求来实现，将原本的“Action名称.action”改为“Action名称！方法名称.action”在struts.xml中就不需要指定方法名了。

 

5、<exception-mapping>与<global-exception-mapping>

 

这两个标签都是用来配置发生异常时对应的视图信息的,只不过一个是Action范围的,一个是包范围的,当同一类型异常在两个范围都被配置时,Action范围的优先级要高于包范围的优先级.这两个标签包含的属性也是一样的:

 

属性名称	是否必须	功能描述
name	否	用来表示该异常配置信息
result	是	指定发生异常时显示的视图信息,这里要配置为逻辑视图
exception	是	指定异常类型

 

两个标签的示例代码为:

 

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15

<?xmlversion="1.0"encoding="UTF-8"?> <!DOCTYPE struts PUBLIC     "-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"     "http://struts.apache.org/dtds/struts-2.0.dtd">    <struts>     <packagename="default"extends="struts-default">         <global-exception-mappings>             <exception-mappingresult="逻辑视图"exception="异常类型"/>         </global-exception-mappings>         <actionname="Action名称">             <exception-mappingresult="逻辑视图"exception="异常类型"/>         </action>     </package> </struts>

 

6、<default-class-ref>

 

当我们在配置Action的时候，如果没有为某个Action指定具体的class值时，系统将自动引用<default-class-ref>标签中所指定的类。在Struts2框架中，系统默认的class为ActionSupport，该配置我们可以在xwork的核心包下的xwork-default.xml文件中找到。

 

有特殊需要时，可以手动指定默认的class

 

1 2 3 4 5 6 7

packagewwfy.action;    publicclassDefaultClassRef {     publicvoidexecute(){         System.out.println("默认class开始执行……");     } }

 

在struts.xml中配置

1 2 3 4 5 6 7 8 9 10 11 12 13 14

<?xmlversion="1.0"encoding="UTF-8"?> <!DOCTYPE struts PUBLIC     "-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"     "http://struts.apache.org/dtds/struts-2.0.dtd">    <struts>     <packagename="wwfy"extends="struts-default">         <!-- 指定默认class为Test -->         <default-class-refclass="wwfy.action.DefaultClassRef"/>         <actionname="test1">             <result>/index.jsp</result>         </action>     </package> </struts>

 

7、<default-action-ref>

如果在请求一个没有定义过的Action资源时，系统就会抛出404错误。这种错误不可避免，但这样的页面并不友好。我们可以使用<default-action-ref>来指定一个默认的Action，如果系统没有找到指定的Action，就会指定来调用这个默认的Action。

 

1 2 3 4 5 6 7 8 9 10 11 12 13 14

<?xmlversion="1.0"encoding="UTF-8"?> <!DOCTYPE struts PUBLIC     "-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"     "http://struts.apache.org/dtds/struts-2.0.dtd">    <struts>     <packagename="wwfy"extends="struts-default">                    <default-action-refname="acctionError"></default-action-ref>         <actionname="acctionError">             <result>/jsp/actionError.jsp</result>         </action>     </package> </struts>

 

8、<default-interceptor-ref>

 

该标签用来设置整个包范围内所有Action所要应用的默认拦截器信息。事实上我们的包继承了struts-default包以后，使用的是Struts的默认设置。我们可以在struts-default.xml中找到相关配置：

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

 

在实际开发过程中，如果我们有特殊的需求是可以改变默认拦截器配置的。当时一旦更改这个配置，“defaultStack”将不再被引用，需要手动最加。

9、<interceptors>

 

通过该标签可以向Struts2框架中注册拦截器或者拦截器栈，一般多用于自定义拦截器或拦截器栈的注册。该标签使用方法如下：

1 2 3 4 5 6

<interceptors>     <interceptorname="拦截器名"class="拦截器类"/>     <interceptor-stackname="拦截器栈名">         <interceptor-refname="拦截器名">     </interceptor-stack> </interceptors>

 

10、<interceptor-ref>

通过该标签可以为其所在的Action添加拦截器功能。当为某个Action单独添加拦截器功能后，<default-interceptor-ref>中所指定的拦截器将不再对这个Action起作用。

 

11、<global-results>

该标签用于设置包范围内的全局结果集。在多个Action返回相同逻辑视图的情况下，可以通过<global-results>标签统一配置这些物理视图所对应的逻辑视图。

1 2 3 4 5 6 7 8 9 10 11 12

<?xmlversion="1.0"encoding="UTF-8"?> <!DOCTYPE struts PUBLIC     "-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"     "http://struts.apache.org/dtds/struts-2.0.dtd">    <struts>     <packagename="wwfy"extends="struts-default">         <global-results>             <resultname="test">/index.jsp</result>         </global-results>     </package> </struts>