首页 > 代码库 > struts.xml详解

struts.xml详解

参考自:http://blog.csdn.net/zz_mm/article/details/5460397

 

1.    深入Struts2的配置文件
本部分主要介绍struts.xml的常用配置。
1.1.    包配置:
Struts2框架中核心组件就是Action、拦截器等,Struts2框架使用包来管理Action和拦截器等。每个包就是多个Action、多个拦截器、多个拦截器引用的集合。
在struts.xml文件中package元素用于定义包配置,每个package元素定义了一个包配置。它的常用属性有:
l name:必填属性,用来指定包的名字。
l extends:可选属性,用来指定该包继承其他包。继承其它包,可以继承其它包中的Action定义、拦截器定义等。
l namespace:可选属性,用来指定该包的命名空间。

 

<?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.enable.DynamicMethodInvocation" value="false"></constant>    <constant name="struts.devMode" value="true"></constant>        <package name="default" namespace="/" extends="struts-default">        <!-- 注册拦截器 -->        <interceptors>            <interceptor name="authi" class="interceptor.authInterceptor"></interceptor>            <!-- 自定义拦截器栈 -->            <interceptor-stack name="myStack">                <interceptor-ref name="defaultStack"></interceptor-ref>                <interceptor-ref name="authi"></interceptor-ref>            </interceptor-stack>        </interceptors>                <action name="auth">            <result>/WEB-INF/pages/manager.jsp</result>            <result name="login">/login.jsp</result>            <!-- 引用自定义拦截器栈 -->            <interceptor-ref name="myStack"></interceptor-ref>        </action>                <action name="login" class="action.loginAction" method="login">            <result name="success">/WEB-INF/pages/manager.jsp</result>            <result name="error">/login.jsp</result>        </action>    </package>    </struts>    

 

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

1.2.    命名空间配置:
考虑到同一个Web应用中需要同名的Action,Struts2以命名空间的方式来管理Action,同一个命名空间不能有同名的Action。
Struts2通过为包指定namespace属性来为包下面的所有Action指定共同的命名空间。
把上示例的配置改为如下形式:
<!DOCTYPE struts PUBLIC        "-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"        "http://struts.apache.org/dtds/struts-2.0.dtd"><struts>    <!-- struts2的action必须放在一个指定的包空间下定义 -->    <package name="qiujy" extends="struts-default">    <!-- 定义处理请求URL为login.action的Action -->        <action name="login" class="org.qiujy.web.struts2.action.LoginAction">        <!-- 定义处理结果字符串和资源之间的映射关系 -->            <result name="success">/success.jsp</result>            <result name="error">/error.jsp</result>        </action>    </package>       <package name="my" extends="struts-default" namespace="/manage">    <!-- 定义处理请求URL为login.action的Action -->        <action name="backLogin" class="org.qiujy.web.struts2.action.LoginAction">        <!-- 定义处理结果字符串和资源之间的映射关系 -->            <result name="success">/success.jsp</result>            <result name="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>    <include file="struts-default.xml"/>    <include file="struts-user.xml"/>    <include file="struts-book.xml"/>    <include file="struts-shoppingCart.xml"/>       ......   </struts>

 

1.4.    拦截器配置: 

见后面章节介绍。
1.5.    常量配置:
Struts2框架有两个核心配置文件,其中struts.xml文件主要负责管理应用中的Action映射, 及Action处理结果和物理资源之间的映射关系。除此之外,Struts2框架还包含了一个struts.properties文件,该文件主义了Struts2框架的大量常量属性。但通常推荐也是在struts.xml文件中来配置这些常量属性。
如:后面会讲到Struts2的国际化,它的资源文件位置就用常量属性来指定:

 

<struts>    ......    <constant name="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 LoginAction extends ActionSupport{    private String userName;    private String password;       private String msg; //结果信息属性       /**     *@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;       }    }}

 

 

 

 

2.2.    Action访问Servlet API:往success.jsp和error.jsp页面中添加 ${msg} EL表达式来显示结果信息。则最终效果跟以前一样。
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);            }                       return this.SUCCESS;        }else{            msg = "登录失败,用户名或密码错";            return this.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。

struts.xml详解