Struts2初学 struts.xml详解一
Struts2初学 Struts.xml详解二
Struts2初学 struts.xml详解 一
(2012-10-16 20:49:15) 标签: struts.xml各元素详解 | 分类: Struts2 |
一、简介
Struts 2是一个MVC框架,以WebWork设计思想为核心,吸收了Struts 1的部分优点
二、详解
首先让我们看一下一个简单的struts.xml文件的结构
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE struts PUBLIC
"-//Apache Software Foundation//DTD Struts Configuration 2.3//EN"
"http://struts.apache.org/dtds/struts-2.3.dtd">
<struts>
<package name="struts2" extends="struts-default">
<action name="login" class="com.action.LoginAction">
<result name="success">/welcom.jsp</result>
<result name="fail">/index.jsp</result>
</action>
</package>
</struts>
A、struts.xml中各个节点以及属性的含义
package节点类似JAVA中的包,STRUTS2引用包的概念;
name属性就是包名,可以根据业务或功能分类定义不同的包,避免命名冲突;
namespace类似于命名空间,决定内部所有的ACTION访问URL的父级地址,
如(namespace=“/demo/page”,以下访问的路径就需要加上“http://localhost:8080/项目名/demo/page/”);
extends属性必须写上,而且值必须是“struts-default”,这样才能够实现struts2的功能。
ction节点可以有多个,表示同个包中多个动作指向URL;
action节点中的name属性是指定访问时的URL文件名,如上所示的的完整URL 是:http://localhost:8080/项目名/demo/page/hello;
class属性是指定当前URL所指向的action的完整类名,如果不指定值,则默认是XWORK包中的ActionSupport类;
method属性是指向action类中的执行方法,该方法可以自定义,但返回值必须是字符串,如果不指定值,默认是:excute方法。
result节点中的name属性值是指定action类中的method所指定的方法返回的字符串值,节点中的文本是指向当接收到name的值时转发的URL路径。
B、Action名称的搜索顺序
1.获得请求路径的URI,例如url是:http://localhost:8080/struts2/path1/path2/path3/test.action
2.首先寻找namespace为/path1/path2/path3的package,如果存在这个package,则在这个package中寻找名字为test的action,如果不存在这个package则转步骤3;
3.寻找namespace为/path1/path2的package,如果存在这个package,则在这个package中寻找名字为test的action,如果不存在这个package,则转步骤4;
4.寻找namespace为/path1的package,如果存在这个package,则在这个package中寻找名字为test的action,如果仍然不存在这个package,就去默认的namaspace的package下面去找名字为test的action(默认的命名空间为空字符串"" ),如果还是找不到,页面提示找不到action。
C、Action配置中的各项默认值
1>如果没有为action指定class,默认是ActionSupport。
2>如果没有为action指定method,默认执行action中的execute() 方法。
3>如果没有指定result的name属性,默认值为success。
D、配置Result
一个result代表了一个可能的输出。当Action类的方法执行完成时,它返回一个字符串类型的结果码,框架根据这个结果码选择对应的result,向用户输出。
在com.opensymphony.xwork2.Action接口中定义了一组标准的结果代码,可供开发人员使用,如下所示:
public interface Action
{
public static final String SUCCESS = “success”;
public static final String NONE = “none”;
public static final String ERROR = “error”;
public static final String INPUT = “input”;
public static final String LOGIN = “login”;
}
在Struts2中,预定义了一些Result的字符串常量,如下:
SUCCESS:表示Action执行成功,显示结果视图给用户,值为字符串"success"。
NONE:表示Action执行成功,不需要显示视图给用户,值为字符串"none"。
ERROR:表示Action执行失败,显示错误页面给用户,值为字符串"error"。
INPUT:表示执行Action需要更多的输入信息,回到input对应的页面,值为字符串"input"。
LOGIN:表示因用户没有登陆而没有正确执行,将返回该登陆视图,值为字符串"login"。
当然,你可以不使用这些字符串常量,而是使用自己定义的字符串,这样做是没有问题的,只要你在Action里面返回的字符串,跟在struts.xml里面配置的result的name属性值一样就可以了。
##################################################
Struts 2 "input"视图有以下各种用法:
1、当所配置的action返回"input"字符串时,strust 2 会将其定向到input视图。
2、当从客户端发送信息到服务器到会话进入所对应的action类方法前有错误(如action的hasError方法返回true)和异常发生,例如:struts 2容器给对应action的各变量赋值时发生发生类型匹配、数据验证没有通过、或者有拦截器抛出异常等。
3、如果在定向到input视图前有错误(如action的hasError方法返回true)和异常发生,且返回的input视图的type为"chain"(即返回到另一个action)时,这个action的方法必须为input,否则这个方法不会执行,而是会直接定位到物理视图。
E、配置 result映射
在result映射的配置中,在指定实际资源的位置时,可以使用绝对路径,也可以使用相对路径。
绝对路径以斜杠(/)开头,相对于当前的Web应用程序的上下文路径;
相对路径不以斜杠(/)开头,相对于当前执行的action的路径。
例如:
<package name="default" extends="struts-default" namespace="/admin">
<action name="login" class="com.ibm.LoginAction">
<result>success.jsp</result>
<result name="error">/error.jsp</result>
</action>
</package>
如果当前Web应用程序的上下文路径是/Shop,那么请求/Shop/admin/login.action,执行成功后,转向的页面路径为:/Shop/admin/success.jsp;执行失败后,转向的页面路径为/Shop/error.jsp.
F、result结果类型
在框架调用Action对请求进行处理之后,就要向用户呈现一个结果视图。Struts2支持多种类型的视图,这些视图是由不同的结果类型来管理的。一个结果类型就是实现了com.opensymphony.xwork2.Result接口的类,在struts2中,预定义了多种结果类型,如表:
结果类型在包中使用result-type元素来定义,上面的结果类型都是在框架的默认配置文件struts-default.xml中定义的。
result节点中有type属性,用于指定指向URL路径的方式,主要值有:dispatcher(默认值),redirect,redirectAction,plainText等。
其中当使用redirectAction值时,是直接写重定向到其他action,如果是指向当前包下面的其他ACTION,则中间节点直接写ACTION名称即可,如果是指向其他包中的ACTION,则需要添加PARAM节点,如:
<param name="actionName">其他ACTION的名称</param>
<param name="namespace">ACTION所在的命名空间</param>
其中当使用plainText值时,一般是应用于将某个页面的源代码(含有服务器段代码)直接输出到页面,如:
<result type="plainText">
<param name="location">/index.jsp</param>
<param name="charset">utf-8</param>
</result>
二、详解
<!DOCTYPE struts PUBLIC
<struts>
</struts>
A、struts.xml中各个节点以及属性的含义
B、Action名称的搜索顺序
2.首先寻找namespace为/path1/path2/path3的package,如果存在这个package,则在这个package中寻找名字为test的action,如果不存在这个package则转步骤3;
3.寻找namespace为/path1/path2的package,如果存在这个package,则在这个package中寻找名字为test的action,如果不存在这个package,则转步骤4;
4.寻找namespace为/path1的package,如果存在这个package,则在这个package中寻找名字为test的action,如果仍然不存在这个package,就去默认的namaspace的package下面去找名字为test的action(默认的命名空间为空字符串"" ),如果还是找不到,页面提示找不到action。
C、Action配置中的各项默认值
D、配置Result
一个result代表了一个可能的输出。当Action类的方法执行完成时,它返回一个字符串类型的结果码,框架根据这个结果码选择对应的result,向用户输出。
在com.opensymphony.xwork2.Action接口中定义了一组标准的结果代码,可供开发人员使用,如下所示:
public interface Action
{
}
在Struts2中,预定义了一些Result的字符串常量,如下:
SUCCESS:表示Action执行成功,显示结果视图给用户,值为字符串"success"。
NONE:表示Action执行成功,不需要显示视图给用户,值为字符串"none"。
ERROR:表示Action执行失败,显示错误页面给用户,值为字符串"error"。
INPUT:表示执行Action需要更多的输入信息,回到input对应的页面,值为字符串"input"。
LOGIN:表示因用户没有登陆而没有正确执行,将返回该登陆视图,值为字符串"login"。
当然,你可以不使用这些字符串常量,而是使用自己定义的字符串,这样做是没有问题的,只要你在Action里面返回的字符串,跟在struts.xml里面配置的result的name属性值一样就可以了。
##################################################
E、配置 result映射
在result映射的配置中,在指定实际资源的位置时,可以使用绝对路径,也可以使用相对路径。
绝对路径以斜杠(/)开头,相对于当前的Web应用程序的上下文路径;
相对路径不以斜杠(/)开头,相对于当前执行的action的路径。
例如:
如果当前Web应用程序的上下文路径是/Shop,那么请求/Shop/admin/login.action,执行成功后,转向的页面路径为:/Shop/admin/success.jsp;执行失败后,转向的页面路径为/Shop/error.jsp.
F、result结果类型
结果类型在包中使用result-type元素来定义,上面的结果类型都是在框架的默认配置文件struts-default.xml中定义的。
result节点中有type属性,用于指定指向URL路径的方式,主要值有:dispatcher(默认值),redirect,redirectAction,plainText等。
其中当使用redirectAction值时,是直接写重定向到其他action,如果是指向当前包下面的其他ACTION,则中间节点直接写ACTION名称即可,如果是指向其他包中的ACTION,则需要添加PARAM节点,如:
其中当使用plainText值时,一般是应用于将某个页面的源代码(含有服务器段代码)直接输出到页面,如:
Struts2初学 Struts.xml详解二
(2012-10-17 22:24:44) 标签: struts.xml各元素详解 | 分类: Struts2 |
A、使用继承实现设置全局视图
package节点中还可以设置全局的视图,如:
<global-results>
<result name="err">/err.jsp</result>
</global-results>
但如果其他包也想实现这样的视图,就需要使用继承的方式实现,如:
<package name="base" namespace="" extends="struts-default">
<global-results>
<result name="err">/err.jsp</result>
</global-results>
</package>
然后其他包分别继承当前的基础包,如:
<package name="demo" namespace="" extends="base">
<action name="hello" method="excute" class="action.HelloAction">
<result name="ok">/index.jsp</result>
</action>
</package>
B、依赖注入属性
Struts2为Action中的属性提供了依赖注入功能,在struts2的配置文件中,我们可以很方便地为Action中的属性注入值。注意:属性必须提供setter方法。
public class HelloAction{
private String savePath;
public String getSavePath() {
return savePath;
}
public void setSavePath(String savePath) {
this.savePath = savePath;
}
}
<action name="hello" method="excute" class="action.HelloAction“>
<!--这里的param就是提供了依赖注入的功能,其中name的值为savePath,则对应的就是ACTION类中添加的set和get属性的方法名称
<param name="savePath">/upload</param>
<result name="ok">/index.jsp</result>
</action>
C、指定struts2处理请求的后缀
struts2可以通过设置常量“struts.action.extension”进行修改所请求的路径后缀,如:
<constant name="struts.action.extension" value="do,go"/>
以上的value属性指的意思,如果用户请求的文件后缀分别是.do或.go都将进入struts2来处理,设置多个以英文逗号隔开。
D、struts2的常量
1、常量可以在struts.xml或struts.properties两个文件中配置,建议使用struts.xml中配置,
在struts.xml中的配置常量如下:
<constant name="常量名称" value="值"/>
在struts.properties中配置常量如下:
常量名称=值
因为常量可以在下面多个配置文件中进行定义,所以需要了解struts2加载常量的搜索顺序:
struts-default.xml
struts-plugin.xml
struts.xml
struts.properties
web.xml
如果在多个文件中配置了同一个常量,则后一个文件中配置的常量值会覆盖前面文件中配置的常量值。
2、struts2的常量
常用的常量介绍:
struts.i18n.encoding=utf-8 :指定默认编码集,作用于httpservletrequest的setcharacterencoding方法
struts.action.extension=do,action:指定需要struts2处理的请求后缀,该属性的默认值是action,即所以的匹配.action 的请求都由struts2处理.
如果用户需要指定多个请求后缀,则多个后缀之间用英文逗号隔开.
struts.serve.static.browserCache=true:设置浏览器是否缓存静态内容,默认值是true(生产环境下使用),开发阶段最好关闭
struts.configuration.xml.reload=true:当struts的配置文件修改后,系统是否自动重新加载该文件,默认值为false,开发阶段设置为true
struts.devMode=true:开发模式下使用,这样可以打印出更详细的错误信息,
该属性的默认值是false。通常,应用在开发阶段,将该属性设置为true,当进入产品发布阶段后,则该属性设置为false。
struts.ui.theme=simple:
该属性指定视图标签默认的视图主题,该属性的默认值是xhtml。struts.objectFactory=spring:与spring集成时,指定由spring负责 action对象的创建
struts.enable.DynamicMethodlnvocation=false:该属性设置struts2是否支持动态方法调用,默认值是true
struts.multipart.maxSize=10240000:用于限制上传文件的大小
struts.multipart.allowedTypes=.xls,.zip:用于限制上传文件类型
struts.multipart.parser=pell:解决上传空文件的报错问题
--------------以下都是不常使用的
struts.multipart.parser=jakarta:该属性指定处理multipart/form-data的MIME类型(文件上传)请求的框架,该属性支持cos,pell和jakarta等属性值, 即分别对应使用cos的文件上传框架,pell上传及common-fileupload文件上传框架.该属性的默认值为jakarta.
注意:如果需要使用cos或者pell的文件上传方式,则应该将对应的JAR文件复制到Web应用中.例如,使用cos上传方式,则需要自己下载cos框架的JAR文件,并将该文件放在WEB-INF/lib路径下
struts.multipart.saveDir:该属性指定上传文件的临时保存路径,该属性的默认值是javax.servlet.context.tempdir
如:
//指定默认编码集,作用于 HttpServletRequest的setCharacterEncoding方法和freemarker,velocity的输出
<constant name="struts.i18n.encoding" value="UTF-8/GBK"/>
//指定需要struts2处理的请求后缀,该属性的默认值是action,即所以的匹配.action 的请求都由struts2处理.
如果用户需要指定多个请求后缀,则多个后缀之间用英文逗号隔开.
<constant name="struts.action.extension" value="do,action"/>
// 设置浏览器是否缓存静态内容,默认值为true(生产环境下使用),开发阶段最好关闭
<constant name="struts.serve.static.browserCache " value="false" />
//当struts的配置文件修改后,系统是否自动重新加载该文件,默认值为false(生产环境下使用),开发阶段最好打开.
<constant name="struts.configuration.xml.reload" value="true"/>
//开发模式下使用,这样可以打印出更详细的错误信息
<constant name="struts.devMode" value="true"/>
//默认的视图主题
<constant name="struts.ui.theme" value="simple"/>
//与Spring集成时,指定由spring负责action对象的创建
<constant name="struts.objectFactory" value="spring"/>
//设置struts2是否支持动态方法调用,该属性的默认值是true,如果需要关闭动态方法调用,则可设置该属性为false
<constant name="struts.enable.DynamicMethodInvocation" value="false"/>
//上传文件的大小限制
<constant name="struts.multipart.maxSize" value="10701096"/>最大为5M(上传的文件的总大小,并不是单个文件的大小)
//上传文件的类型限制
<constant name="struts.multipart.allowedTypes" value="'.txt','.xls','.csv','.zip'" />
// 这个应该可以解决上传空文件的报错问题
<constant name="struts.multipart.parser" value="pell" />
更详细的struts2常量请参看: http://wing123.iteye.com/blog/352596
http://hi.baidu.com/hduzhou/item/8c0c50035cb0c629a1312d6e
E、为应用指定多个struts配置文件
在大部分应用里,随着应用规模的增加,系统中的action的数量也会大量增加,导致struts.xml配置文件非常庞大,可读性及维护性差,所以可以将一个struts.xml文件分解成多个配置文件,然后在struts.xml中包含其他配置文件,
如:
<struts>
<include file="struts-user.xml"/>
<include file="struts-order.xml"/>
</struts>
F、动态方法的调用和使用通配符定义action
如果action中存在多个方法时,可以使用“!+方法名”调用指定方法(前提是:D的2中动态方法调用要设为true),如下:
public class HelloAction{
public String execute(){}
public String other(){}
}
如果访问上面的action的URL路径为:/abc/hello,如果要访问other()方法,可以这样调用:
/abc/hello!other,如果不想使用动态方法调用,可以通过设置常量关闭。
当D的2中动态方法调用要设为关闭时,也可以使用通配符定义action,如下:
<action name="hello_*" class="action.helloaction" method="{1}">
</action>
如果要访问other()方法,可以通过这样的URL访问:/abc/hello_other,其中{1}为占位符
但如果其他包也想实现这样的视图,就需要使用继承的方式实现,如:
<package name="base" namespace="" extends="struts-default">
</package>
然后其他包分别继承当前的基础包,如:
<package name="demo" namespace="" extends="base">
</package>
B、依赖注入属性
public class HelloAction{
}
<!--这里的param就是提供了依赖注入的功能,其中name的值为savePath,则对应的就是ACTION类中添加的set和get属性的方法名称
C、指定struts2处理请求的后缀
以上的value属性指的意思,如果用户请求的文件后缀分别是.do或.go都将进入struts2来处理,设置多个以英文逗号隔开。
D、struts2的常量
在struts.xml中的配置常量如下:
<constant name="常量名称" value="值"/>
在struts.properties中配置常量如下:
常量名称=值
因为常量可以在下面多个配置文件中进行定义,所以需要了解struts2加载常量的搜索顺序:
struts-default.xml
struts-plugin.xml
struts.xml
struts.properties
web.xml
如果在多个文件中配置了同一个常量,则后一个文件中配置的常量值会覆盖前面文件中配置的常量值。
struts.i18n.encoding=utf-8 :指定默认编码集,作用于httpservletrequest的setcharacterencoding方法
struts.action.extension=do,action:指定需要struts2处理的请求后缀,该属性的默认值是action,即所以的匹配.action 的请求都由struts2处理.
如果用户需要指定多个请求后缀,则多个后缀之间用英文逗号隔开.
struts.serve.static.browserCache=true:设置浏览器是否缓存静态内容,默认值是true(生产环境下使用),开发阶段最好关闭
struts.configuration.xml.reload=true:当struts的配置文件修改后,系统是否自动重新加载该文件,默认值为false,开发阶段设置为true
struts.devMode=true:开发模式下使用,这样可以打印出更详细的错误信息,
该属性的默认值是false。通常,应用在开发阶段,将该属性设置为true,当进入产品发布阶段后,则该属性设置为false。
struts.ui.theme=simple:
该属性指定视图标签默认的视图主题,该属性的默认值是xhtml。struts.objectFactory=spring:与spring集成时,指定由spring负责 action对象的创建
struts.enable.DynamicMethodlnvocation=false:该属性设置struts2是否支持动态方法调用,默认值是true
struts.multipart.maxSize=10240000:用于限制上传文件的大小
struts.multipart.allowedTypes=.xls,.zip:用于限制上传文件类型
struts.multipart.parser=pell:解决上传空文件的报错问题
--------------以下都是不常使用的
struts.multipart.parser=jakarta:该属性指定处理multipart/form-data的MIME类型(文件上传)请求的框架,该属性支持cos,pell和jakarta等属性值, 即分别对应使用cos的文件上传框架,pell上传及common-fileupload文件上传框架.该属性的默认值为jakarta.
注意:如果需要使用cos或者pell的文件上传方式,则应该将对应的JAR文件复制到Web应用中.例如,使用cos上传方式,则需要自己下载cos框架的JAR文件,并将该文件放在WEB-INF/lib路径下
struts.multipart.saveDir:该属性指定上传文件的临时保存路径,该属性的默认值是javax.servlet.context.tempdir
如:
//指定默认编码集,作用于 HttpServletRequest的setCharacterEncoding方法和freemarker,velocity的输出
<constant name="struts.i18n.encoding" value="UTF-8/GBK"/>
//指定需要struts2处理的请求后缀,该属性的默认值是action,即所以的匹配.action 的请求都由struts2处理.
如果用户需要指定多个请求后缀,则多个后缀之间用英文逗号隔开.
<constant name="struts.action.extension" value="do,action"/>
// 设置浏览器是否缓存静态内容,默认值为true(生产环境下使用),开发阶段最好关闭
<constant name="struts.serve.static.browserCache " value="false" />
//当struts的配置文件修改后,系统是否自动重新加载该文件,默认值为false(生产环境下使用),开发阶段最好打开.
<constant name="struts.configuration.xml.reload" value="true"/>
//开发模式下使用,这样可以打印出更详细的错误信息
<constant name="struts.devMode" value="true"/>
//默认的视图主题
<constant name="struts.ui.theme" value="simple"/>
//与Spring集成时,指定由spring负责action对象的创建
<constant name="struts.objectFactory" value="spring"/>
//设置struts2是否支持动态方法调用,该属性的默认值是true,如果需要关闭动态方法调用,则可设置该属性为false
<constant name="struts.enable.DynamicMethodInvocation" value="false"/>
<constant name="struts.multipart.maxSize" value="10701096"/>最大为5M(上传的文件的总大小,并不是单个文件的大小)
//上传文件的类型限制
<constant name="struts.multipart.allowedTypes" value="'.txt','.xls','.csv','.zip'" />
// 这个应该可以解决上传空文件的报错问题
<constant name="struts.multipart.parser" value="pell" />
更详细的struts2常量请参看: http://wing123.iteye.com/blog/352596
E、为应用指定多个struts配置文件
如:
<struts>
</struts>
F、动态方法的调用和使用通配符定义action
public class HelloAction{
}
如果访问上面的action的URL路径为:/abc/hello,如果要访问other()方法,可以这样调用:
/abc/hello!other,如果不想使用动态方法调用,可以通过设置常量关闭。
当D的2中动态方法调用要设为关闭时,也可以使用通配符定义action,如下:
<action name="hello_*" class="action.helloaction" method="{1}">
</action>
如果要访问other()方法,可以通过这样的URL访问:/abc/hello_other,其中{1}为占位符