struts2 xml配置/struts.xml文件结构
转载注明出处:http://write.blog.csdn.net/postedit/8896764
1.struts.xml文件
struts.xml文件是整个Struts2框架的核心。
struts.xml文件内定义了Struts2的系列Action,定义Action时,指定该Action的实现类,并定义该Action处理结果与视图资源之间的映射关系。
struts.xml文件内定义了Struts2的系列Action,定义Action时,指定该Action的实现类,并定义该Action处理结果与视图资源之间的映射关系。
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE struts PUBLIC
"-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"
"http://struts.apache.org/dtds/struts-2.0.dtd">
<struts>
<package name="example" namespace="/example" extends="struts-default">
<!-- 定义一个Action名称为HelloWorld,实现类为example.HelloWorld.java-->
<action name="HelloWorld" class="example.HelloWorld">
<!-- 任何情况下都转入到/example/HelloWorld.jsp -->
<result>/example/HelloWorld.jsp</result>
</action>
<action name="Login_*" method="{1}" class="example.Login">
<!-- 返回input时,转入到/example/login.jsp -->
<result name="input">/example/Login.jsp</result>
<!-- 重定向到Menu的Action -->
<result type="redirect-action">Menu</result>
</action>
<action name="*" class="example.ExampleSupport">
<result>/example/{1}.jsp</result>
</action>
</package>
</struts>
关于<result name="input">/example/Login.jsp</result> 以上表示当execute方法返回input的字符串时,跳转到/example/Login.jsp。定义rusult元素时,可以指定两个属性:type和name。其中name指定了execute方法返回的字符串,而type指定转向的资源类型,此处转向的资源可以是JSP,也可以是FreeMarker等,甚至是另一个Action。
2.加载子配置文件
Struts2框架的核心配置文件就是struts.xml配置文件,该文件主要负责管理Struts2框架的业务控制器Action。在默认情况下,Struts2框架将自动加载放在WEB-INF/classes路径下的struts.xml文件。为了避免随着应用规模的增加,而导致的struts.xml文件过于庞大,臃肿,从而是该文件的可读性下降。我们可以将一个struts.xml配置文件分解成多个配置文件 ,然后在struts.xml文件中包含其他配置文件。
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE struts PUBLIC
"-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"
"http://struts.apache.org/dtds/struts-2.0.dtd">
<struts>
<constant name="struts.enable.DynamicMethodInvocation" value="false" />
<constant name="struts.devMode" value="false" />
<!--通过include元素导入其他元素-->
<include file="myStruts.xml"/>
</struts>
通过这种方式,Struts2提供了一种模块化的方式来管理struts.xml配置文件。 3.package配置
package元素用于定义包配置,每个package元素定义了一个包配置。Struts2框架使用包来管理Action和拦截器等。每个包就是多个Action、多个拦截器、多个拦截器引用的集合。使用package可以将逻辑上相关的一组Action,Result,Intercepter等组件分为一组,package有些像对象,可以继承其他的package,也可以被其他package继承,甚至可以定义抽象的package。
package的可以使用的属性:
属性 是否必须 说明
name 是 package的表示,指定包的名字,该名字是该包(package)被其他包引用的key。
extends 否 指定该包继承其他包。继承其他包,可以继承其他包中的Action定义、拦截器定义等。
namespace 否 定义该包的命名空间。
abstract 否 可选,它指定该包是否是一个抽象包。抽象包不能包含Action定义。
由于struts.xml文件是自上而下解析的,所以被继承的package要放在继承package的前边。
4.namespace配置(命名空间配置)
Struts2以命名空间的方式来管理Action,同一个命名空间里不能有同名的Action,不同的命名空间里可以有同名的Action。Struts2不支持为单独的Action设置命名空间,而是通过为包指定namespace属性来为包下面的所有Action指定共同的命名空间。
namespace将action分成逻辑上的不同模块,每一个模块有自己独立的前缀。使用namespace可以有效的避免action重名的冲突,例如每一个package都可以有自己独立的Menu和Help action,但是实现方式各有不同。Struts2标签带有namespace选项,可以根据namespace的不同向服务器提交不同的package的action的请求。
“/”表示根namespace,所有直接在应用程序上下文环境下的请求(Context)都在这个package中查找。
“”表示默认namespace,当所有的namespace中都找不到的时候就在这个namespace中寻找.
例如,有如下配置:
查找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。
又例:
需要注意的问题有两个:
1)默认命名空间里的Action可以处理任何模块下的Action请求。
即:如果存在URL为/book/GetBooks.action的请求,并且/book的命名空间没有名为GetBooks的Action,则默认命名空间下名为GetBooks的Action也会处理用户请求。
2)当某个包指定了命名空间后,该包下所有的Action处理的URL应该是: 命名空间+Action名。
以上面的get包为例,该包下包含了名为getBooks的Action,则该Action处理的URL为:
http://localhost:8080/AppName/book/getBooks.action
*AppName是应用名,book是该Action所有包对应的命名空间,getBooks是Action名。
5.Action配置
配置Action就是让Struts2容器知道该Action的存在,并且能调用该Action来处理用户请求。因此,我们认为:Action是Struts2的基本“程序单位”。即,在struts2框架中每一个Action是一个工作单元。Action负责将一个请求对应到一个Action处理上去,每当一个Action类匹配一个请求的时候,这个Action类就会被Struts2框架调用。Action只是一个控制器,它并不直接对浏览器生成任何响应,因此,Action处理完用户请求后,Action需要将指定的视图资源呈现给用户. 因此,配置Action时,应该配置逻辑视图和物理视图资源之间的映射。
Struts2使用包来组织Action,因此,将Action的定义是放在包定义下完成的,定义Action通过使用package下的action子元素来完成。至少需要指定该Action的name属性,该name属性既是该Action的名字,也是该Action需要处理的URL的前半部分。除此之外,通常还需要为action元素指定一个class属性,其中class属性指定了该Action的实现类。
一个简单的例子:
每当struts2框架接受到一个请求的时候,他会去掉Host,Application和后缀等信息,得到Action的名字,例如如下的请求将得到Welcome这个Action: http://www.planetstruts.org/struts2-mailreader/Welcome.action
在一个Struts2应用程序中,一个指向Action的链接通常有Struts Tag产生,这个Tag只需要指定Action的名字,Struts框架会自动添加诸如后缀等的扩展,例如:
http://Hostname:post/appname/Hello.action
在定义Action的名字的时候不要使用.和/来命名,最好使用英文字母和下划线。
5.1.Action中的方法
Action的默认入口方法由xwork2的Action接口来定义,代码清单为:
1)建立一些execute签名相同的方法,例如:
Public String forward() throws Exception
2)在Action配置的时候使用method属性,例如:
<action name="delete" class="example.CrudAction" method="delete">
5.2.Action中的方法通配符
有些时候对Action中方法的调用满足一定的规律,例如editAction对应edit方法,deleteAction对应delete方法,这个时候我们可以使用方法通配符,例如:
<action name="*Crud" class="example.Crud" method="{1}">
这时,editCrudAction的引用将调用edit方法,同理,deleteCrudAction的引用将调用delete 方法。
另外一种比较常用的方式是使用下划线分割,例如:
<action name="Crud_*" class="example.Crud" method="{1}">
这样当遇到如下调用的时候可以找到对应的方法。
"action=Crud_input" => input方法
"action=Crud_delete"=> delete方法
name 是 package的表示,指定包的名字,该名字是该包(package)被其他包引用的key。
extends 否 指定该包继承其他包。继承其他包,可以继承其他包中的Action定义、拦截器定义等。
namespace 否 定义该包的命名空间。
abstract 否 可选,它指定该包是否是一个抽象包。抽象包不能包含Action定义。
由于struts.xml文件是自上而下解析的,所以被继承的package要放在继承package的前边。
4.namespace配置(命名空间配置)
Struts2以命名空间的方式来管理Action,同一个命名空间里不能有同名的Action,不同的命名空间里可以有同名的Action。Struts2不支持为单独的Action设置命名空间,而是通过为包指定namespace属性来为包下面的所有Action指定共同的命名空间。
namespace将action分成逻辑上的不同模块,每一个模块有自己独立的前缀。使用namespace可以有效的避免action重名的冲突,例如每一个package都可以有自己独立的Menu和Help action,但是实现方式各有不同。Struts2标签带有namespace选项,可以根据namespace的不同向服务器提交不同的package的action的请求。
“/”表示根namespace,所有直接在应用程序上下文环境下的请求(Context)都在这个package中查找。
“”表示默认namespace,当所有的namespace中都找不到的时候就在这个namespace中寻找.
例如,有如下配置:
<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。
又例:
<struts>
<constant name="struts.custom.i18n.resources" value="messageResource"/>
<package name="lee" extends="struts-default">
<action name="login" class="lee.LoginAction">
<result name="input">/login.jsp</result>
<result name="error">/error.jsp</result>
<result name="success">/welcome.jsp</result>
</action>
</package>
<package name="get" extends="struts-default" namespace="/book">
<action name="getBooks" class="lee.GetBooksAction">
<result name="login">/login.jsp</result>
<result name="success">/showBook.jsp</result>
</action>
</package>
</struts>
以上代码配置了两个包:lee和get,配置get包时,指定了该包的命名空间为/book。对于名为lee的包而言,没有指定namespace属性。如果某个包没有指定namespace属性,即该包使用默认的命名空间,则默认的命名空间总是""。 需要注意的问题有两个:
1)默认命名空间里的Action可以处理任何模块下的Action请求。
即:如果存在URL为/book/GetBooks.action的请求,并且/book的命名空间没有名为GetBooks的Action,则默认命名空间下名为GetBooks的Action也会处理用户请求。
2)当某个包指定了命名空间后,该包下所有的Action处理的URL应该是: 命名空间+Action名。
以上面的get包为例,该包下包含了名为getBooks的Action,则该Action处理的URL为:
http://localhost:8080/AppName/book/getBooks.action
*AppName是应用名,book是该Action所有包对应的命名空间,getBooks是Action名。
5.Action配置
配置Action就是让Struts2容器知道该Action的存在,并且能调用该Action来处理用户请求。因此,我们认为:Action是Struts2的基本“程序单位”。即,在struts2框架中每一个Action是一个工作单元。Action负责将一个请求对应到一个Action处理上去,每当一个Action类匹配一个请求的时候,这个Action类就会被Struts2框架调用。Action只是一个控制器,它并不直接对浏览器生成任何响应,因此,Action处理完用户请求后,Action需要将指定的视图资源呈现给用户. 因此,配置Action时,应该配置逻辑视图和物理视图资源之间的映射。
Struts2使用包来组织Action,因此,将Action的定义是放在包定义下完成的,定义Action通过使用package下的action子元素来完成。至少需要指定该Action的name属性,该name属性既是该Action的名字,也是该Action需要处理的URL的前半部分。除此之外,通常还需要为action元素指定一个class属性,其中class属性指定了该Action的实现类。
一个简单的例子:
<package name="lee" extends="struts-default">
<action name="login" class="lee.LoginAction">
<result name="input">/login.jsp</result>
<result name="error">/error.jsp</result>
<result name="success">/welcome.jsp</result>
</action>
</package>
一个较全面的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的名字的时候不要使用.和/来命名,最好使用英文字母和下划线。
5.1.Action中的方法
Action的默认入口方法由xwork2的Action接口来定义,代码清单为:
public interface Action {
public String execute() throws Exception;
}
有些时候我们想指定一个Action的多个方法,我们可以做如下两步: 1)建立一些execute签名相同的方法,例如:
Public String forward() throws Exception
2)在Action配置的时候使用method属性,例如:
<action name="delete" class="example.CrudAction" method="delete">
5.2.Action中的方法通配符
有些时候对Action中方法的调用满足一定的规律,例如editAction对应edit方法,deleteAction对应delete方法,这个时候我们可以使用方法通配符,例如:
<action name="*Crud" class="example.Crud" method="{1}">
这时,editCrudAction的引用将调用edit方法,同理,deleteCrudAction的引用将调用delete 方法。
另外一种比较常用的方式是使用下划线分割,例如:
<action name="Crud_*" class="example.Crud" method="{1}">
这样当遇到如下调用的时候可以找到对应的方法。
"action=Crud_input" => input方法
"action=Crud_delete"=> delete方法
默认通配符
通配符和普通的配置具有相同的地位,可以结合使用框架的所有其他功能。
5.3.默认的Action
当我们没有指定Action的class属性的时候,例如:<action name="Hello"> 我们默认使用com.opensymphony.xwork.ActionSupport.ActionSupport有两个方法input和execute,每个方法都是简单的返回SUCCESS。
<action name="*" >
<result>/{1}.jsp</result>
</action>
每个Action将会被映射到以自己名字命名的JSP上。通配符和普通的配置具有相同的地位,可以结合使用框架的所有其他功能。
5.3.默认的Action
当我们没有指定Action的class属性的时候,例如:<action name="Hello"> 我们默认使用com.opensymphony.xwork.ActionSupport.ActionSupport有两个方法input和execute,每个方法都是简单的返回SUCCESS。
通常情况下,请求的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>
</package>
5.4.Post-Back Action
可以使用如下画面达到字画面刷新的效果
可以使用如下画面达到字画面刷新的效果
<s:form>
<s:textfield label="Please enter your name" name="name"/>
<s:submit/>
</s:form>