Struts2 XML配置详解

1.   深入Struts2的配置文件

本部分主要介绍struts.xml的常用配置。

1.1.   包配置：

Struts2框架中核心组件就是Action、拦截器等，Struts2框架使用包来管理Action和拦截器等。每个包就是多个Action、多个拦截器、多个拦截器引用的集合。

在struts.xml文件中package元素用于定义包配置，每个package元素定义了一个包配置。它的常用属性有：

l name：必填属性，用来指定包的名字。

l extends：可选属性，用来指定该包继承其他包。继承其它包，可以继承其它包中的Action定义、拦截器定义等。

l namespace：可选属性，用来指定该包的命名空间。

如上示例的配置，配置了一个名为default的包，该包下定义了一个Action。

<span style="color:#000000;">(struts.xml是struts的配置文件)
 <?xml version="1.0" encoding="UTF-8" ?>
 <!DOCTYPE struts PUBLIC "-//Apache Software Foundation//DTD Struts Configuration 2.1//EN" "http://struts.apache.org/dtds/struts-2.1.dtd">
 <struts>
     <!--常量配置-->
     <constant name="struts.devMode" value="false"></constant><!--打印出更多配置文件的信息-->
     <!-- package:管理action节点   extends：继承其他配置文件中的package<span style="font-size: 9pt;"> struts2</span><span style="font-size: 9pt;">的</span><span style="font-size: 9pt;">action</span><span style="font-size: 9pt;">必须放在一个指定的包空间下定义</span>-->
     <package name="s2" extends="struts-default">
         <!-- action:name(请求的路径，页面上是    name.action)  class:对应的处理类 -->
         <action name="user" class="cn.struts2.action.UserAction" >
             <span style="font-size: 9pt;"><!--</span><span style="font-size: 9pt;">定义处理结果字符串和资源之间的映射关系</span><span style="font-size: 9pt;"> --></span></span>

<span style="color:#000000;">         <result >success.jsp</result>        <!-- 返回的地址 --><!-- 默认name="success" -->
             <result name="fails">error.jsp</result>
         </action>
         <!-- 配置全局结果，多个action中共享. -->
         <global-results>
             <result>success.jsp</result>        <!-- 默认name="success" -->
         </global-results>
     </package>
 </struts>    
</span>

关于动态调用action类中的方法

（如果不动态调用，那么就是默认调用action类中的execute（）方法）

方式一：配置文件不用改，但是请求的路径要改为：action类名+！+方法名+.action
       比如，UserAction中有一个login方法，那么请求路径（表单中的action值）为:user!login.action
       方式二：需要修改配置文件，假设UserAction中有一个login方法，那么<action>节点就要加一个属性method，值等于login
       < action name="user" class="cn.struts2.action.UserAction" method="login"> ....(result节点) </action>

方式三：使用通配符的方式，
       比如：<action name="user_*" class="cn.struts2.action.UserAction" method="{1}">

这里的*是通配符，可以匹配任意字符，而method的值{1}就是*的内容，比如页面请求user_login.action，那么{1}就等于login，就是说 

 method="login",那么根据第二种方式，就会执行UserAction中的login方法同样，通配符可以用多个，
<action name="*_*" class="cn.struts2.action.UserAction" method="{2}">
页面上请求user_login同样可以调用login方法，但是这里method={2}，通配符是匹配的字符串，
这里第一个*相当于user，第二个*相当于login，所以method="{2}"
所以，当请求的方法是第n个*的内容时，method={n}

这三种方式，推荐使用前面两种，第三种很灵活，但是比较混乱，使程序可读性变差
注意：
动态方法调用是在配置文件中配置了的， struts.enable.DynamicMethodInvocation=true，默认值是true，所以不用改就可以动态调用
如果要禁用动态方法调用，那么可以再struts.properties文件（自己建的）里面修改struts.enable.DynamicMethodInvocation=false
或者在struts.xml中配置常量（使用constant节点配置常量）
<constant name="struts.enable.DynamicMethodInvocation" value="false"></constant>
这样就可以禁用动态方法调用。

关于action类中获取页面中表单元素的值注意，页面表单元素的name必须和后台对象属性的值相同！！！

方式一：

如果该action只使用几个表单元素的值，那么可以直接在该类中定义表单元素，然后提供get，set方法。
注意，名字须和表单元素的名字一样（通过反射机制动态调用set方法），
在调用set方法设置值后调用请求的方法

方式二：

如果值较多，那么需要通过一个vo对象来封装，在action类中定义那个vo对象（不需要实例化），然后为该vo对象提供get，set方法
这里请求进来时，会先进get方法，发现vo对象为空，（没有实例化），那就实例化一个vo对象，然后调用set方法，然后在调用get方法，
这时vo对象是已经实例化了的。然后调用请求的方法
注意，这种方式在页面的表单元素的name值需要加上该vo对象的名字的前缀
比如，action中的vo对象是private UserVo user；UserVo中有个属性是username
那么表单中<input name="user.username">

方式三：（模型驱动方式）

这里action类需要实现ModelDriven接口（com.opensymphony.xwork2.ModelDriven包中的）
然后定义一个封装对象的vo类，这里的vo对象必须实例化，否则报错（空指针）
然后实现接口中的方法
public Object getModel() {
    return 你的vo对象;
}
然后，数据会自动封装好，然后调用你请求的方法。
注意，这里和第二种方式不同，在页面表单中name属性不需要加vo对象的前缀

1.2.   命名空间配置：

考虑到同一个Web应用中需要同名的Action，Struts2以命名空间的方式来管理Action，同一个命名空间不能有同名的Action。

Struts2通过为包指定namespace属性来为包下面的所有Action指定共同的命名空间。

把上示例的配置改为如下形式：

<!DOCTYPEstrutsPUBLIC         "-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"         "http://struts.apache.org/dtds/struts-2.0.dtd"> <struts>     <!-- struts2的action必须放在一个指定的包空间下定义 -->     <packagename="qiujy"extends="struts-default">     <!--定义处理请求URL为login.action的Action -->         <actionname="login"class="org.qiujy.web.struts2.action.LoginAction">         <!--定义处理结果字符串和资源之间的映射关系 -->             <resultname="success">/success.jsp</result>             <resultname="error">/error.jsp</result>         </action>     </package>         <packagename="my"extends="struts-default"namespace="/manage">     <!--定义处理请求URL为login.action的Action -->        <actionname="backLogin"class="org.qiujy.web.struts2.action.LoginAction">         <!--定义处理结果字符串和资源之间的映射关系 -->             <resultname="success">/success.jsp</result>             <resultname="error">/error.jsp</result>         </action>     </package></struts>

如上配置了两个包：default和my，配置my包时指定了该包的命名空间为/manage。

对于包default：没有指定namespace属性。如果某个包没有指定namespace属性，即该包使用默认的命名空间，默认的命名空间总是""。

对于包my：指定了命名空间/manage，则该包下所有的Action处理的URL应该是“命名空间/Action名”。如上名为backLogin的Action，它处理的URL为：

http://localhost:8080/userlogin_struts2/manage/backLogin.action

Struts2的命名空间的作用等同于struts1里模块的作用。

1.3.   包含配置：

在Struts2中可以将一个配置文件分解成多个配置文件，那么我们必须在struts.xml中包含其他配置文件。

<struts>     <includefile="struts-default.xml"/>     <includefile="struts-user.xml"/>     <includefile="struts-book.xml"/>     <includefile="struts-shoppingCart.xml"/>         ......    </struts>

1.4.   拦截器配置：

见后面章节介绍。

1.5.   常量配置：

Struts2框架有两个核心配置文件，其中struts.xml文件主要负责管理应用中的Action映射， 及Action处理结果和物理资源之间的映射关系。除此之外，Struts2框架还包含了一个struts.properties文件，该文件主义了Struts2框架的大量常量属性。但通常推荐也是在struts.xml文件中来配置这些常量属性。

如：后面会讲到Struts2的国际化，它的资源文件位置就用常量属性来指定：

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

表示指定了资源文件的放置在classes目录下，基本名是messages，则在classes目录下您就应该放置类似messages_zh_CN.properties，message_en.properties名的文件。

2.   Struts2的Action

2.1.   实现Action类：

Struts2中Action是核心内容，它包含了对用户请求的处理逻辑，我们也称Action为业务控制器。

Struts2中的Action采用了低侵入式的设计，Struts2不要求Action类继承任何的Struts2的基类或实现Struts2接口。(但是，我们为了方便实现Action，大多数情况下都会继承com.opensymphony.xwork2.ActionSupport类，并重写此类里的public String execute() throws Exception方法。因为此类中实现了很多的实用接口，提供了很多默认方法，这些默认方法包括获取国际化信息的方法、数据校验的方法、默认的处理用户请求的方法等，这样可以大大的简化Action的开发。)

Struts2中通常直接使用Action来封装HTTP请求参数，因此，Action类里还应该包含与请求参数对应的属性，并且为属性提供对应的getter和setter方法。(当然，Action类中还可以封装处理结果，把处理结果信息当作一属性，提供对应的getter和setter方法)

修改第一部分的用户登录示例：把Action改成如下：

package org.qiujy.web.struts2.action;   import com.opensymphony.xwork2.ActionSupport;   /**  *@authorqiujy  *@version1.0  */ publicclass LoginActionextends ActionSupport{     private StringuserName;     private Stringpassword;         private Stringmsg;//结果信息属性         /**      *@returnthemsg      */     public String getMsg() {         returnmsg;     }     /**      *@parammsgthemsgtoset      */     publicvoid setMsg(String msg) {         this.msg = msg;     }     /**      *@returntheuserName      */     public String getUserName() {         returnuserName;     }     /**      *@paramuserNametheuserNametoset      */     publicvoid setUserName(String userName) {         this.userName = userName;     }     /**      *@returnthepassword      */     public String getPassword() {         returnpassword;     }     /**      *@parampasswordthepasswordtoset      */     publicvoid setPassword(String password) {         this.password = password;     }         /**      *处理用户请求的excute()方法      *@return结果导航字符串      *@throwsException      */     public String execute()throws Exception{        if("test".equals(this.userName) && "test".equals(this.password)){            msg ="登录成功，欢迎" +this.userName;            returnthis.SUCCESS;        }else{            msg ="登录失败，用户名或密码错";            returnthis.ERROR;        }     } }

往success.jsp和error.jsp页面中添加 ${msg} EL表达式来显示结果信息。则最终效果跟以前一样。

2.2.   Action访问Servlet API：

Struts2中的Action并没有和任何Servlet API耦合，这样框架更具灵活性，更易测试。

但是，对于web应用的控制器而言，不访问Servlet API几乎是不可能的，例如跟踪HTTP Session状态等。Struts2框架提供了一种更轻松的方式来访问Servlet API。Struts2中提供了一个ActionContext类(当前Action的上下文对象)，通过这个类可以访问Servlet API。下面是该类中提供的几个常用方法：

l public static ActionContext getContext() ：获得当前Action的ActionContext实例。

l public Object get(Object key) ：此方法类似于调用HttpServletRequest的getAttribute(String name)方法。

l public void put(Object key, Object value) ：此方法类似于调用HttpServletRequest 的setAttribute(String name, Object o)。

l public Map getParameters() ：获取所有的请求参数。类似于调用HttpServletRequest对象的getParameterMap() 方法。

l public Map getSession() ：返回一个Map对象，该Map对象模拟了HttpSession实例。

l public void setSession(Map session) ： 直接传入一个Map实例，将该Map实例里的key-value对转换成session的属性名－属性值对。

l public Map getApplication() ：返回一个Map对象，该对象模拟了该应用的ServletContext实例。

l public void setApplication(Map application) ：直接传入一个Map实例，将该Map实例里的key-value对转换成application的属性名－属性值对。

修改以上用户登录验证示例的Action类中的execute方法：

public String execute()throws Exception{         if("test".equals(this.userName) && "test".equals(this.password)){             msg ="登录成功，欢迎" +this.userName;             //获取ActionContext实例，通过它来访问Servlet API             ActionContext context = ActionContext.getContext();             //看session中是否已经存放了用户名，如果存放了：说明已经登录了； //否则说明是第一次登录成功             if(null != context.getSession().get("uName")){                 msg =this.userName +"：你已经登录过了!!!";             }else{                 context.getSession().put("uName",this.userName);             }                         returnthis.SUCCESS;         }else{             msg ="登录失败，用户名或密码错";             returnthis.ERROR;         }     }

       Struts2中通过ActionContext来访问Servlet API，让Action彻底从Servlet API 中分离出来，最大的好处就是可以脱离Web容器测试Action。

       另外，Struts2中还提供了一个ServletActionContext类，Action只要继承自该类，就可以直接访问Servlet API。具体方法参看struts2的API文档。

3.   一个Action内包含多个请求处理方法的处理

Struts1提供了DispatchAction，从而允许一个Action内包含多个请求处理方法。Struts2也提供了类似的功能。处理方式主要有以下三种方式：

3.1.   动态方法调用：

DMI：Dynamic Method Invocation 动态方法调用。

动态方法调用是指：表单元素的action不直接等于某个Action的名字，而是以如下形式来指定对应的动作名：

<form method="post" action="userOpt!login.action">

则用户的请求将提交到名为”userOpt”的Action实例，Action实例将调用名为”login”方法来处理请求。同时login方法的签名也是跟execute()一样，即为public String login() throws Exception。

注意：要使用动态方法调用，必须设置Struts2允许动态方法调用，通过设置struts.enable.DynamicMethodInvocation常量来完成，该常量属性的默认值是true。

3.1.1.     示例：

修改用户登录验证示例，多增加一个注册用户功能。

1.      修改Action类：

package org.qiujy.web.struts2.action;   import com.opensymphony.xwork2.ActionContext; import com.opensymphony.xwork2.ActionSupport;   /**  *@authorqiujy  *@version1.0  */ publicclass LoginActionextends ActionSupport{     private StringuserName;     private Stringpassword;         private Stringmsg;//结果信息属性         /**      *@returnthemsg      */     public String getMsg() {         returnmsg;     }     /**      *@parammsgthemsgtoset      */     publicvoid setMsg(String msg) {         this.msg = msg;     }     /**      *@returntheuserName      */     public String getUserName() {         returnuserName;     }     /**      *@paramuserNametheuserNametoset      */     publicvoid setUserName(String userName) {         this.userName = userName;     }     /**      *@returnthepassword      */     public String getPassword() {         returnpassword;     }     /**      *@parampasswordthepasswordtoset      */     publicvoid setPassword(String password) {         this.password = password;     }         /**      *处理用户请求的login()方法      *@return结果导航字符串      *@throwsException      */     public String login()throws Exception{         if("test".equals(this.userName) && "test".equals(this.password)){             msg ="登录成功，欢迎" +this.userName;             //获取ActionContext实例，通过它来访问Servlet API             ActionContext context = ActionContext.getContext();             //看session中是否已经存放了用户名，如果存放了：说明已经登录了； //否则说明是第一次登录成功             if(null != context.getSession().get("uName")){                 msg =this.userName +"：你已经登录过了!!!";             }else{                 context.getSession().put("uName",this.userName);             }                         returnthis.SUCCESS;         }else{             msg ="登录失败，用户名或密码错";             returnthis.ERROR;         }     }         public String regist()throws Exception{         //将用户名，密码添加到数据库中         //...         msg ="注册成功。";         returnthis.SUCCESS;     } }

2.      struts.xml文件：没有什么变化，跟以前一样配置

<!DOCTYPEstrutsPUBLIC         "-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"         "http://struts.apache.org/dtds/struts-2.0.dtd"> <struts>     <packagename="my"extends="struts-default"namespace="/manage">     <!--定义处理请求URL为login.action的Action -->         <actionname="userOpt"class="org.qiujy.web.struts2.action.LoginAction">         <!--定义处理结果字符串和资源之间的映射关系 -->             <resultname="success">/success.jsp</result>             <resultname="error">/error.jsp</result>         </action>     </package> </struts>

3.      页面：

index.jsp

<%@ pagelanguage="java"pageEncoding="UTF-8"%> <html>  <head>     <title>用户登录页面</title>  </head>    <body>   <h2>用户入口</h2>   <hr>     <formaction="manage/userOpt!login.action"method="post">     <tableborder="1">          <tr>              <td>用户名：</td>              <td><inputtype="text"name="userName"/></td>          </tr>          <tr>              <td>密码：</td>              <td><inputtype="password"name="password"/></td>          </tr>          <tr>              <tdcolspan="2">                  <inputtype="submit"value="确定 "/>              </td>          </tr>     </table>     </form>  </body> </html>

regist.jsp

<%@ pagelanguage="java"pageEncoding="UTF-8"%> <html>  <head>     <title>用户注册页面</title>  </head>    <body>   <h2>用户注册</h2>   <hr>     <formaction="manage/userOpt!regist.action"method="post">     <tableborder="1">          <tr>              <td>用户名：</td>              <td><inputtype="text"name="userName"/></td>          </tr>          <tr>              <td>密码：</td>              <td><inputtype="password"name="password"/></td>          </tr>          <tr>              <tdcolspan="2">                  <inputtype="submit"value="注册 "/>              </td>          </tr>     </table>     </form>  </body> </html>

4.      运行结果：

3.2.   为Action配置method属性：

将Action类中的每一个处理方法都定义成一个逻辑Action方法。

<!DOCTYPEstrutsPUBLIC         "-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"         "http://struts.apache.org/dtds/struts-2.0.dtd"> <struts>     <packagename="my"extends="struts-default"namespace="/manage">         <actionname="userLogin"class="org.qiujy.web.struts2.action.LoginAction"method="login">             <resultname="success">/success.jsp</result>             <resultname="error">/error.jsp</result>         </action>                 <actionname="userRegist"class="org.qiujy.web.struts2.action.LoginAction"method="regist">             <resultname="success">/success.jsp</result>             <resultname="error">/error.jsp</result>         </action>     </package> </struts>

如上，把LoginAction中的login和regist方法都配置成逻辑Action。要调用login方法，则相应的把index.jsp中表单元素的action设置为"manage/userLogin.action"；要调用regist方法，把regist.jsp中表单元素的action设置为"manage/userRegist.action"。

3.3.   使用通配符映射(wildcard mappings)方式：

在struts.xml文件中配置<action…>元素时，它的name、class、method属性都可支持通配符，这种通配符的方式是另一种形式的动态方法调用。

当我们使用通配符定义Action的name属性时，相当于用一个元素action定义了多个逻辑Action：

<actionname="user_*" class="org.qiujy.web.struts2.action.UserAction"method="{1}">             <resultname="success">/success.jsp</result>             <resultname="error">/error.jsp</result>         </action>

如上，<action name=”user_*”>定义一系列请求URL是user_*.action模式的逻辑Action。同时method属性值为一个表达式{1}，表示它的值是name属性值中第一个*的值。例如：用户请求URL为user_login.action时，将调用到UserAction类的login方法；用户请求URL为user_regist.action时，将调用到UserAction类的regist方法。

4.   处理结果

Struts2的Action处理完用户请求后，将返回一个普通字符串，整个普通字符串就是一个逻辑视图名。Struts2通过配置逻辑视图名和物理视图资源之间的映射关系，一旦系统收到Action返回的某个逻辑视图名，系统就会把对应的物理视图资源呈现给浏览者。

4.1.   配置处理结果：

Struts2的Action处理用户请求结束后，返回一个普通字符串－逻辑视图名，必须在struts.xml文件中完成逻辑视图和物理视图资源的映射，才可让系统转到实际的视图资源。

Struts2通过在struts.xml文件中使用<result …/>元素来配置结果。Struts2提供了两种结果。

l 局部结果：将<result …/>作为<action …>元素的子元素配置。

l 全局结果：将<result …/>作为<global-results …>元素的子元素配置。

在package元素中配置<global-results>子元素：

<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>

4.2.   处理结果类型：

Struts2提供了对不同种类返回结果的支持，常见的有JSP，FreeMarker，Velocity等。

Struts2支持的不同类型的返回结果为：

名字	说明
chain	用来处理Action链
dispatcher	用来转向页面，通常处理JSP，这是默认的结果类型
freeMarker	处理FreeMarker模板
httpHeader	用来控制特殊的Http行为
redirect	重定向到一个URL
redirect-action	重定向到一个Action
stream	向浏览器发送InputSream对象，通常用来处理文件下载
velocity	处理Velocity模板
xslt	处理XML/XLST模板
plaintext	显示原始文件内容，例如文件源代码
tiles	结合Tile使用

另外第三方的Result类型还包括JasperReports Plugin，专门用来处理JasperReport类型的报表输出；Jfreechart Plugin；JSF Plugin。

4.3.   动态返回结果

有些时候，只有当Action执行完毕的时候我们才知道要返回哪个结果，这个时候我们可以在Action内部定义一个属性，这个属性用来存储Action执行完毕之后的result值，例如：

private String nextAction;   public String getNextAction() {     return nextAction; }

在strutx.xml配置文件中，我们可以使用${nextAction}来引用到Action中的属性，通过${nextAction}表示的内容来动态的返回结果，例如：

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

上述Action的execute方法返回next的时候，还需要根据nextAction的属性来判断具体定位到哪个Action。