xwork配置详述

XWork配置详述

XWork配置文件是以“xwork”命名的.xml文件，它必需放到类路径（classPath）的根目录， Web应用一般放在classes目录中，它需要遵守DTD的规范（现在是xwork-1.0.dtd）。这个文件定义了我们的Action，Interceptor，Result的配置和相互之间的映射。下面我们看看用户注册的完整XWork配置文件：

<!DOCTYPE xwork PUBLIC "-//OpenSymphony Group//XWork 1.0//EN" "http://www.opensymphony.com/xwork/xwork-1.0.dtd">

 

<xwork>

 

    <include file="webwork-default.xml"/>

   

    <package name="example" extends="webwork-default">

       <action name="register" class="example.register.RegisterAction" >

           <result name="success" type="dispatcher">

              <param name="location">/register-result.jsp</param>

           </result>

           <interceptor-ref name="params"/>

       </action>

      

       <action name="registersupport" class="example.register.RegisterActionSupport" >

           <result name="success" type="dispatcher">

              <param name="location">/register-result.jsp</param>

           </result>

           <result name="input" type="dispatcher">

              <param name="location">/registerSupport.jsp</param>

           </result>

           <interceptor-ref name="validationWorkflowStack"/>

       </action>

      

    </package>

 

</xwork>

xwork.xml文件的标签元素

Xwork：xwork配置文件的所有内容，都是定义在<xwork>标签中，它的直接子标签有<package>和<include>。

Package：我们的Action，Interceptor，Result都是在此标签中定义。<package>标签有一个必需的属性“name”，它用来标识唯一的一个package。属性“extends”是可选的，它用来继承前面定义的一个或一个以上package配置信息，包括所有的interceptor、interceptor-stack和action的配置信息。注意，配置文件按文档的顺序，由上向下执行，因此，用“extends”引用的package必需在引用之前定义。属性“sbstract”是可选的，它用来设置package为抽象的package，它可以被继承同时它的Action配置信息在运行时将不可见。

属性namespace也是可选的，它用来分隔不同package定义的action，让这些action处于不同的命名空间（namespaces）。这样，我们不同的package可以有相同的action命名，因为可以通过命名空间来区分。如果不指定namespace，默认的是空字符串。命名空间也可以被用在安全控制方面，它可以根据不同的命名空间指定不同的访问权限。

属 性	是否必需	描   述
name	是	用来标识package的名称
extends	否	继承它所扩展的package配置信息
namespace	否	指定package的命名空间，默认是””
abstract	否	声明package是抽象的

 

Result-type：用来定义输出结果类型的Class，它用简单的名－值对来定义。当然，我们自己写的输出结果类型也必需在这里定义。例如：

<result-type name="dispatcher" class="com.opensymphony.webwork.dispatcher.ServletDispatcherResult" default="true"/>，default="true"表示如果在Action的result中不指定result-type，就使用这个默认的result-type。

 

Interceptors：它是一个简单的<interceptors>  <interceptors/>标签，我们的interceptor和interceptor-stack都在此标签内定义。

 

Interceptor：当然，就是用来定义我们的拦截器。它的定义非常简单，名－值对的形式。例如：<interceptor name="timer" class="com.opensymphony.xwork.interceptor.TimerInterceptor"/>。在action中，可以通过<interceptor-ref />来直接引用前面定义了的拦截器。

 

Interceptor-stack：用来将上面定义的interceptor组织成堆栈的形式，这样我们就可以创建一组标准的interceptor，让它按照顺序执行。在我们的Action中直接引用这个interceptor堆栈就可以了，不用逐个interceptor去引用。

例如：

<interceptor-stack name="validationWorkflowStack">

               <interceptor-ref name="defaultStack"/>

                <interceptor-ref name="validation"/>

                <interceptor-ref name="workflow"/>

            </interceptor-stack>

Interceptor Param：我们的interceptor是在ActionConfig级别被实例化和存储的，也就是说一个Action引用的每个interceptor都会有相应的实例。这样，我们在定义和引用interceptor的时候都可以为它设置相应的参数值。例如：

<interceptor name="test" class="com.opensymphony.xwork.TestInterceptor">

    <param name="foo">expectedFoo</param>

</interceptor>

在Action或Interceptor-stack中引用时也可以设置参数，例如：

<interceptor-ref name="test">

    <param name="expectedFoo">expectedFoo</param>

</interceptor-ref>

注意：在Action引用的时候，如果引用的是Interceptor-stack，则不允许设置参数，否则会报错。

 

Global-results：它允许我们定义全局的输出结果（global result），比如登陆页面、操作错误处理页面。只要继承它所在的package，这些输出结果都是可见的。

例如：

<global-results>

           <result name="login" type="dispatcher">

              <param name="location">/login.jsp</param>

           </result>

           <result name="error" type="dispatcher">

              <param name="location">/error.jsp</param>

           </result>

       </global-results>

如果我们的Action执行完返回“login”，它将调用上面的这个输出结果，将输出派遣到根目录下的login.jsp页面。

 

Action：用来配置Action的名称（name）和它对应的Class。我们将通过这个Action的名称和它所在package的namespace去配置文件中取得这个Action的配置信息。它可以通过<param>来设置参数，Action在执行的时候会取得配置文件里设置的参数（通过拦截器StaticParametersInterceptor）。

Action可以配置一个或多个输出结果(result)。一个输出结果的名称，对应于Action执行完成返回的字符串。<result>标签的type属性，对应我们前面定义过的result-type，说明reslut的类型。例如：

<action name="register" class="example.register.RegisterAction" >

           <result name="success" type="dispatcher">

              <param name="location">/register-result.jsp</param>

           </result>

           <interceptor-ref name="params"/>

       </action>

当然，我们的Action用到的拦截器也是在这里配置的，通过<interceptor-ref>标签，属性“name”的值，对应前面定义的interceptor或interceptor-stack。如果Action中没有用<interceptor-ref>标签指定拦截器，它将使用默认的<default-interceptor-ref>标签定义的拦截器。

 

Include：xwork..xml文件可以被分成好几个不同的文件，xwork..xml通过<include>标签引用被包含的文件，例如：<include file="webwork-default.xml"/>。被包含的文件必需是package标签里的内容，我们看看<include>标签在配置文件里的位置就知道了。如果要继承被包含文件的package，我们必需将<include>标签放在其上面，因为配置文件是按照由上而下的顺序解析的。