1. 深入Struts2的配置文件
本部分主要介绍struts.xml的经常使用配置。
1.1. 包配置：
Struts2框架中核心组件就是Action、拦截器等，Struts2框架使用包来管理Action和拦截器等。每一个包就是多个Action、多个拦截器、多个拦截器引用的集合。
在struts.xml文件里package元素用于定义包配置，每一个package元素定义了一个包配置。它的经常使用属性有：
l name：必填属性。用来指定包的名字。
l extends：可选属性，用来指定该包继承其他包。继承其他包，能够继承其他包中的Action定义、拦截器定义等。
l namespace：可选属性。用来指定该包的命名空间。
<!DOCTYPEstruts PUBLIC "-//Apache Software Foundation//DTD Struts Configuration 2.0//EN" "http://struts.apache.org/dtds/struts-2.0.dtd"> <struts> <!-- struts2的action必须放在一个指定的包空间下定义 --> <packagename="default"extends="struts-default"> <!--定义处理请求URL为login.action的Action --> <actionname="login"class="org.qiujy.web.struts.action.LoginAction"> <!--定义处理结果字符串和资源之间的映射关系 --> <resultname="success">/success.jsp</result> <resultname="error">/error.jsp</result> </action> </package> </struts> |
如上演示样例的配置。配置了一个名为default的包，该包下定义了一个Action。
1.2. 命名空间配置：
考虑到同一个Web应用中须要同名的Action，Struts2以命名空间的方式来管理Action，同一个命名空间不能有同名的Action。
Struts2通过为包指定namespace属性来为包以下的全部Action指定共同的命名空间。
把上演示样例的配置改为例如以下形式：
<!DOCTYPEstruts PUBLIC "-//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 ="登录失败，username或password错"; 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中是否已经存放了username，假设存放了：说明已经登录了； //否则说明是第一次登录成功 if(null != context.getSession().get("uName")){ msg =this.userName +"：你已经登录过了!!!"; }else{ context.getSession().put("uName",this.userName); }
returnthis.SUCCESS; }else{ msg ="登录失败，username或password错"; 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中是否已经存放了username。假设存放了：说明已经登录了； //否则说明是第一次登录成功 if(null != context.getSession().get("uName")){ msg =this.userName +"：你已经登录过了!!!"; }else{ context.getSession().put("uName",this.userName); }
returnthis.SUCCESS; }else{ msg ="登录失败，username或password错"; returnthis.ERROR; } }
public String regist()throws Exception{ //将username，password加入到数据库中 //... msg ="注冊成功。"; returnthis.SUCCESS; } }
|
2. struts.xml文件：没有什么变化，跟曾经一样配置
<!DOCTYPEstruts PUBLIC "-//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>username：</td> <td><inputtype="text"name="userName"/></td> </tr> <tr> <td>password：</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>username：</td> <td><inputtype="text"name="userName"/></td> </tr> <tr> <td>password：</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方法。
<!DOCTYPEstruts PUBLIC "-//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。
5. 属性驱动和模型驱动
无论属性驱动还是模型驱动，Struts2框架都是通过拦截器负责提取请求參数，并将请求数据封装到对应的Action实例的属性或专门的模型的属性。
5.1. 属性驱动：
属性驱动就是属性(property)作为贯穿MVC流程的信息携带者。
简单的说。就是使用Action实例来封装请求參数和处理结果信息。
前面我们做的演示样例都属于属性驱动模式。
5.2. 模型驱动：
模型驱动就是使用单独的javaBean作为贯穿整个MVC流程的信息携带者。
也就是说。使用单独的VO(值对象)来封装请求參数和处理结果信息。
演示样例：继续改动用户登录验证：
1. 新增一用户域模型对象：User.java
package org.qiujy.domain;
publicclass User { private StringuserName; private Stringpassword; /** *@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; } } |
2. 业务控制器：UserAction.java
package org.qiujy.web.struts2.action;
import org.qiujy.domain.User; import com.opensymphony.xwork2.ActionContext; import com.opensymphony.xwork2.ActionSupport;
publicclass UserActionextends ActionSupport{ //定义用于封装请求參数的模型对象 private Useruser =new User();
private Stringmsg;//结果信息属性
/** *@returntheuser */ public User getUser() { returnuser; } /** *@paramusertheusertoset */ publicvoid setUser(User user) { this.user = user; } /** *@returnthemsg */ public String getMsg() { returnmsg; } /** *@parammsgthemsgtoset */ publicvoid setMsg(String msg) { this.msg = msg; }
/** *处理用户请求的login()方法 *@return结果导航字符串 *@throwsException */ public String login()throws Exception{ String userName = user.getUserName(); String password = user.getPassword();
if("test".equals(userName) && "test".equals(password)){ msg ="登录成功，欢迎" + userName; //获取ActionContext实例，通过它来訪问Servlet API ActionContext context = ActionContext.getContext(); //看session中是否已经存放了username，假设存放了：说明已经登录了；否则说明是第一次登录成功 if(null != context.getSession().get("uName")){ msg = userName +"：你已经登录过了!!!"; }else{ context.getSession().put("uName", userName); }
returnthis.SUCCESS; }else{ msg ="登录失败。username或password错"; returnthis.ERROR; } }
public String regist()throws Exception{ //将username，password加入到数据库中 //... msg ="注冊成功。"; returnthis.SUCCESS; } } |
3. 配置文件：struts.xml
<!DOCTYPEstruts PUBLIC "-//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="userOpt"class="org.qiujy.web.struts2.action.UserAction"> <resultname="success">/success.jsp</result> <resultname="error">/error.jsp</result> </action> </package> </struts> |
4. 页面：
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>username：</td> <td><inputtype="text"name="user.userName"/></td> </tr> <tr> <td>password：</td> <td><input type="password" name="user.password"/></td> </tr> <tr> <tdcolspan="2"> <inputtype="submit"value="确定 "/> </td> </tr> </table> </form> </body> </html> |
其他页面略。
5. 执行效果：同曾经一样。
6. 源码：
6. Struts2的异常处理机制：
不论什么成熟的MVC框架都应该提供成就的异常处理机制。Strut2也不例外。
Struts2提供了一种声明式的异常处理方式。
Struts2也是通过配置的拦截器来实现异常处理机制的。
Struts2的异常处理机制通过在struts.xml文件里配置<exception-mapping …>元素完毕的，配置该元素时，须要指定两个属性：
exception：此属性指定该异常映射所设置的异常类型。
result：此属性指定Action出现该异常时，系统转入result属性所指向的结果。
6.1. 异常映射也分为两种：
l 局部异常映射：<exception-mapping…>元素作为<action…>元素的子元素配置。
l 全局异常映射：<exception-mapping…>元素作为<global-exception-mappings>元素的子元素配置。
6.2. 输出异常信息：
使用Struts2的标签来输出异常信息：
l <s:property value="exception.message"/> ： 输出异常对象本身。
l <s:property value="exceptionStack"/> ： 输出异常堆栈信息。
6.3. 演示样例：
还是改动用户登录演示样例：
1) 把UserAciton.java中的regist方法改成：
public String regist()throws Exception{ //将username。password加入到数据库中 //... //msg = "注冊成功。"; if(true){ throw new java.sql.SQLException("没有数据库驱动程序"); }
return this.SUCCESS; } |
2) 改动struts.xml文件：
<!DOCTYPEstruts PUBLIC "-//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"> <!--定义全局处理结果 --> <global-results> <!--逻辑名为sql的结果，映射到/exception.jsp页面 --> <resultname="sql">/exception.jsp</result> </global-results>
<global-exception-mappings> <!--当Action抛出SQLException异常时，转入名为sql的结果 --> <exception-mappingexception="java.sql.SQLException" result="sql"/> </global-exception-mappings>
<actionname="userOpt"class="org.qiujy.web.struts2.action.UserAction"> <resultname="success">/success.jsp</result> <resultname="error">/error.jsp</result> </action> </package> </struts> |
3) 新增一页面：exception.jsp
<%@ pagelanguage="java"pageEncoding="utf-8"%> <%@ tagliburi="/struts-tags"prefix="s"%> <html> <head> <title>异常信息</title> </head>
<body> <h2> 出现异常啦 </h2> <hr/> <h3style="color:red"> <!--获得异常对象 --> <s:propertyvalue="exception.message"/> </h3> <br/> <!--异常堆栈信息 --> <s:propertyvalue="exceptionStack"/> </html> |
4) 执行regist.jsp调试：
