第三章Struts配置

 

与Struts 1.X不同，Struts2引入了WebWork的配置机制，在很大程度上提高了配置的灵活度。通过使用配置可以配置如下内容：

配置类型	配置文件
Struts2 参数配置	struts.properties
Struts2 Action 配置	struts.xml
Struts2 Result 配置	struts.xml
Struts2 Exception Handling 配置	struts.xml
Struts2 Intercept 配置	struts.xml
Struts2 多配置文件	struts.xml

另外还说明了Action接口和ActionSupport类的一些情况。

3.1节 struts.properties配置

struts.properties文件在WEB-INF/classes目录下存放。

这个文件用来配置Struts2系统的一些基本规约，所有在struts.properties中配置的内容都可以在struts.xml中配置，或者web.xml中在struts2 filter中配置，例如：

Struts.properties中的如下配置：

struts.i18n.encoding=UTF-8

相当于struts.xml中的如下配置：

<constant name=“struts.i18n.encoding” value=“true” />

相当于web.xml中的如下配置：

<filter>

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

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

    <init-param>

        <param-name>struts.i18n.encoding</param-name>

        <param-value>true</param-value>

    </init-param>

</filter>

3.2 节 Actin配置

Package配置

使用package可以将逻辑上相关的一组Action，Result，Intercepter等组件分为一组，Package有些想对象，可以继承其他的Package，也可以被其他package继承，甚至可以定义抽象的Package。

Package的可以使用的属性：

属性	是否必须	说明
name	是	Package的表示，为了让其他的package引用
extends	否	从哪个package集成行为
namespace	否	参考Namespace配置说明 @TODO Namespace配置说明
abstract	否	定义这个package为抽象的，这个package中不需要定义action

 

由于struts.xml文件是自上而下解析的，所以被集成的package要放在集成package的前边。

 

Namespace配置

Namespace将action分成逻辑上的不同模块，每一个模块有自己独立的前缀。使用namespace可以有效的避免action重名的冲突，例如每一个package都可以有自己独立的Menu和Help action，但是事项方式各有不同。Struts2标签带有namespace选项，可以根据namespace的不同向服务器提交不同的package的action的请求。

 

“/”表示跟namespace，所有直接在应用程序上下文环境下的请求（Context）都在这个package中查找。

 

“”表示默认namespace，当所有的namespace中都找不到的时候就在这个namespace中寻找，例如我们上面的login应用程序。

 

例如，有如下配置：

<package name="default">

<action name="foo" class="mypackage.simpleAction>

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

           greeting.jsp

       </result>

    </action>

    <action name="bar" class="mypackage.simpleAction">

       <result name="success" type="dispatcher">bar1.jsp</result>

    </action>

</package>

 

<package name="mypackage1" namespace="/">

    <action name="moo" class="mypackage.simpleAction">

        <result name="success" type="dispatcher">moo.jsp</result>

    </action>

</package>

 

<package name="mypackage2" namespace="/barspace">

    <action name="bar" class="mypackage.simpleAction">

       <result name="success" type="dispatcher">bar2.jsp</result>

    </action>

</package>

 

1 如果请求为/barspace/bar.action

查找namespace/barspace，如果找到bar则执行对应的action，否则将会查找默认的namespace，在上面的例子中，在barspace中存在名字位bar的action，所以这个action将会被执行，如果返回结果为success，则画面将定为到bar2.jsp

2 如果请求为/ moo.action

根namespace（'/'）被查找，如果moo action存在则执行否则查询默认的namespace，上面的例子中，根namespace中存在moo action，所以改action被调用，返回success的情况下画面将定位到moo.jsp

 

Action配置

在struts2框架中每一个Action是一个工作单元。Action负责将一个请求对应到一个Action处理上去，每当一个Action类匹配一个请求的时候，这个Action类就会被Struts2框架调用。

 

一个Action配置示例：

<action name="Logon" class="tutorial.Logon">

 <result type="redirect-action">Menu</result>

 <result name="input">/tutorial/Logon.jsp</result>

</action>

每一个Action可以配置多个result，多个ExceptionHandler，多个Intercepter，但是只能有一个name，这个name和package的namespace来唯一区别一个Action。

 

每当struts2框架接受到一个请求的时候，他会去掉Host，Application和后缀等信息，得到Action的名字，例如如下的请求将得到Welcome这个Action。

http://www.planetstruts.org/struts2-mailreader/Welcome.action

 

在一个Struts2应用程序中，一个指向Action的链接通常有Struts Tag产生，这个Tag只需要指定Action的名字，Struts框架会自动添加诸如后缀等的扩展，例如：

<s:form action="Hello">

    <s:textfield label="Please enter your name" name="name"/>

    <s:submit/>

</s:form>

将产生一个如下的链接的请求:

http://Hostname:post/appname/Hello.action

 

在定义Action的名字的时候不要使用.和/来明明，最好使用英文字母和下划线。

 

Action中的方法

Action的默认入口方法由xwork2的Action接口来定义，代码清单为：

public interface Action {

    public String execute() throws Exception;

}

 

有些时候我们想指定一个Action的多个方法，我们可以做如下两步：

<!--[if !supportLists]-->1    <!--[endif]-->建立一些execute签名相同的方法，例如：

Public String forward() throws Exception

<!--[if !supportLists]-->2    <!--[endif]-->在Action配置的时候使用method属性，例如：

    <action name="delete" class="example.CrudAction" method="delete">

 

Action中的方法通配符

有些时候对Action中方法的调用满足一定的规律，例如edit Action对应edit方法，delete Action对应 delete方法，这个时候我们可以使用方法通配符，例如：

<action name="*Crud" class="example.Crud" method="{1}">

这时，editCrud Action的引用将调用edit方法，同理，deleteCrud Action的引用将调用delete 方法。

 

另外一种比较常用的方式是使用下划线分割，例如：

<action name="Crud_*" class="example.Crud" method="{1}">

这样当遇到如下调用的时候可以找到对应的方法。

"action=Crud_input"  => input方法

"action=Crud_delete"　=> delete方法

通配符和普通的配置具有相同的地位，可以结合使用框架的所有其他功能。

 

默认的Action

当我们没有指定Action的class属性的时候，例如：

<action name="Hello">

我们默认使用com.opensymphony.xwork.ActionSupport

ActionSupport有两个方法input和execute，每个方法都是简单的返回SUCCESS。

 

Post-Back Action

可以使用如下画面达到字画面刷新的效果

<s:form>

    <s:textfield label="Please enter your name" name="name"/>

    <s:submit/>

</s:form>

 

默认Action

通常情况下，请求的Action不存在的情况下，Struts2框架会返回一个Error画面：“404 - Page not found”，有些时候或许我们不想出现一个控制之外的错误画面，我们可以指定一个默认的Action，在请求的Action不存在的情况下，调用默认的Action，通过如下配置可以达到要求：

<package name="Hello" extends="action-default">

 

<default-action-ref name="UnderConstruction">

 

<action name="UnderConstruction">

 <result>/UnderConstruction.jsp</result>

</action>"

 

默认通配符

<action name="*" >

 <result>/{1}.jsp</result>

</action>

每个Action将会被映射到以自己名字明明的JSP上。

3.3节 Result配置

Action里提供了五个默认的返回值：

String SUCCESS = "success";

String NONE    = "none";

String ERROR   = "error";

String INPUT   = "input";

String LOGIN   = "login";

 

默认的一些配置

在package下有如下配置

<result-types>

<result-type name="dispatcher"

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

    default="true" />

</result-types>

 

如果一个Result的type没有设定的话，默认为dispthcher。Dispatcher的意思是转向一个JSP等的资源。

另外如果Result的name没有设定的话，默认为SUCCESS。

 

一个完整的Result的声明如下：

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

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

</result>

考虑到默认值可以写成：

<result>

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

</result>

另外也可以简写为：

<result>/ThankYou.jsp</result>

 

另外为了方便，可以在package中设置一些全局的result，例如：

<global-results>

 <result name="error">/Error.jsp</result>

 <result name="invalid.token">/Error.jsp</result>

 <result name="login" type="redirect-action">Logon_input</result>

</global-results>

 

动态结果

有些时候，在Action执行完毕之后才知道Result的指向，可以使用如下的方法：

Action

private String nextAction;

public String getNextAction() {

    return nextAction;

}

public String execute() throws Exception {

 return “next”;

}

 

struts.xml

<action name="fragment" class="FragmentAction">

 <result name="next" type="redirect-action">${nextAction}</result>

</action>

 

 

3.4节 ActionSupport

Action类不一定非要实现Action接口或者集成ActionSupport类，也就是说Action可以是一个POJO对象，只不过提供一个返回String的方法。如果Action类不实现Action接口，也不从ActionSupport集成，则Struts框架通过Java的反射机制（Reflection）来调用Action类中的处理方法。

Action类的处理方法需要满足以下要求

1 public

2 返回String，框架根据返回值决定迁移的目的

3 （可选）抛出Exception，让Struts框架统一处理异常

 

 

3.5节 Exception Handling

Struts可以以声明的方式处理Action类抛出的异常。以声明的方式处理是指：所有的Action类的处理方法抛出的Exception会被框架统一处理，之后定向到预先定义的Result。处理这些异常的Action，Result等可以动态的配置。

Struts2自带一个默认的配置：struts-default.xml，在这个文件中预先定义了一些基本的操作，其中Exception Handling也在其中，参看下述代码：

 

...

<interceptors>

    ...

    <interceptor name="exception"

          class="com.opensymphony.xwork.interceptor.ExceptionMappingInterceptor"/>

    ...

</interceptors>

 

<interceptor-stack name="defaultStack">

    <interceptor-ref name="exception"/>

    <interceptor-ref name="alias"/>

    <interceptor-ref name="servlet-config"/>

    <interceptor-ref name="prepare"/>

    <interceptor-ref name="i18n"/>

    <interceptor-ref name="chain"/>

    <interceptor-ref name="debugging"/>

    <interceptor-ref name="profiling"/>

    <interceptor-ref name="scoped-model-driven"/>

    <interceptor-ref name="model-driven"/>

    <interceptor-ref name="fileUpload"/>

    <interceptor-ref name="checkbox"/>

    <interceptor-ref name="static-params"/>

    <interceptor-ref name="params"/>

    <interceptor-ref name="conversionError"/>

    <interceptor-ref name="validation">

        <param name="excludeMethods">input,back,cancel,browse</param>

    </interceptor-ref>

    <interceptor-ref name="workflow">

        <param name="excludeMethods">input,back,cancel,browse</param>

    </interceptor-ref>

</interceptor-stack>

...

 

要使用Struts2声明式异常处理，只需要将异常映射到result就可以了，可以用两种方法配置，一种方法是全局配置，针对所有的Action有效，另一种是针对具体的Action做配置，只针对具体的Action有效。

参看如下struts.xml 配置文件片段：

<package name="default">

      ...

      <global-results>

          <result name="login" type="redirect">/Login.action</result>

          <result name="Exception">/Exception.jsp</result>

      </global-results>

 

      <global-exception-mappings>

          <exception-mapping

exception="java.sql.SQLException" result="SQLException"/>

          <exception-mapping

exception="java.lang.Exception" result="Exception"/>

      </global-exception-mappings>

      ...

      <action name="DataAccess" class="com.company.DataAccess">

          <exception-mapping

exception="com.company.SecurityException" result="login"/>

          <result name="SQLException" type="chain">SQLExceptionAction</result>

          <result>/DataAccess.jsp</result>

      </action>

      ...

</package>

 

上述配置有如下结果

1 一个java.sql.SQLException异常将链接到SQLExceptionAction （上述文件中没有说明）

2 一个com.company.SecurityException将重新定位到login.action

3 其他从java.lang.Exception继承而来的Exception将会被定为到/Exception.jsp页面

 

3.6节 Intercepter拦截器

拦截器的运行时机在Action类运行之前和之后。拦截器使用Filter模式，将你需要执行的代码放在Action类处理方法之前或者之后执行。拦截器在开发程序的时候功能非常强大，通过使用拦截器可以完成校验，属性设置，安全，日志，程序剖析等功能。

 

拦截器可以彼此链接构成一个拦截器的栈，每一个拦截器本质上是一个Java类，都有一个常常的类名，为了方便使用，可以在Struts2框架中注册这些拦截器，例如：

<interceptor name="security" class="com.jpleasure.security.SecurityInterceptor"/>

 <interceptor-stack name="secureStack">

    <interceptor-ref name="security"/>

    <interceptor-ref name="defaultStack"/>

 </interceptor-stack>

</interceptors>

拦截器和拦截器栈可以混合使用来定义新的拦截器栈，在调用过程中，框架按照在拦截器栈中的顺序逐个调用这些拦截器。

 

可以在Package中定义默认的拦截器栈，例如：

<default-interceptor-ref name="secureStack"/>

当然每一个Action类也可以定义自己的拦截器栈，例如：

<action name="VelocityCounter"

                         class="org.apache.struts2.example.counter.SimpleCounter">

    <result name="success">...</result>

    <interceptor-ref name="defaultComponentStack"/>

</action>

 

3.7节 分离配置文件

可以在struts.xml中使用include标记将配置文件分离成不同的部分。

例如：

<!DOCTYPE struts PUBLIC

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

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

<struts>

    <include file="Home.xml"/>

    <include file="Hello.xml"/>

    <include file="Simple.xml"/>

    <include file="/util/POJO.xml"/>

</struts>