Java实战之01Struts2-02配置文件
三、Struts2的配置文件
1、加载时机:
当应用被tomcat加载的时候,struts2的配置文件就已经被加载过了。
2、加载顺序
顺序 |
配置文件名 |
所在位置 |
说明 |
1 |
default.properties |
struts2-core-2.3.15.3.jar\org\apache\struts2 |
不能修改 |
2 |
struts-default.xml |
struts2-core-2.3.15.3.jar |
不能修改 |
3 |
strtuts-plugin.xml |
在struts2提供的插件jar包中 |
不能修改 |
4 |
struts.xml |
我们的应用中 |
我们修改的:推荐 |
5 |
struts.properties |
我们的应用中 |
我们修改的 |
6 |
web.xml |
我们的应用中 |
我们修改的,可以给过滤器配置参数 |
注意:
1、Struts2提供了两种配置的方式。一种是key=value的方式,即使用.properties文件。另一种是xml文件配置。我们推荐使用xml文件(它能描述层级关系)。
2、当多个配置文件中,有相同的参数,后面的会把前面的值给覆盖了。
四、Struts2框架提供的常量
1、常用的常量
常量定义在了default.properties配置文件中,体现形式都是key=value。所有的struts2应用都会用到这些常量。
常用的:
常量名 |
常量值 |
说明 |
struts.i18n.encoding |
UTF-8 |
应用中使用的编码 |
struts.objectFactory.spring.autoWire |
name |
和spring框架整合有关 |
struts.multipart.parser |
jakarta |
指定文件上传用的组件 |
struts.multipart.maxSize |
2097152 |
文件上传总文件大小限制:2M |
struts.action.extension |
action,, |
能进入Struts2框架内部的url地址后缀名。多个值用逗号分隔 |
struts.devMode |
false |
是否是开发模式。开发模式:改了配置文件,不需要重启。输出更多的错误信息。开发阶段建议为true。 |
struts.ui.theme |
xhtml |
页面展示用的主题 |
2、在struts.xml中覆盖常量
使用<constant name="" value=""></constant>元素进行覆盖
例如:
1 <!-- 修改struts2常量使用的元素是constant 2 属性name:对应的key 3 value:对应的值 4 --> 5 <!-- 开启开发者模式 --> 6 <constant name="struts.devMode" value="true"></constant> 7 <!-- 修改struts2默认拦截的url后缀 --> 8 <constant name="struts.action.extension" value="do"></constant>
3、创建struts.properties文件覆盖
在应用的构建路径中创建一个struts.properties的文件。
struts.action.extension=abc
可以覆盖默认访问动作方法后缀
4、在web.xml中配置过滤器参数
1 <filter> 2 <filter-name>struts2</filter-name> 3 <filter-class> 4 org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter 5 </filter-class> 6 <!-- 配置过滤器的初始化参数 --> 7 <init-param> 8 <param-name>struts.action.extension</param-name> 9 <param-value>html</param-value> 10 </init-param> 11 </filter> 12 <filter-mapping> 13 <filter-name>struts2</filter-name> 14 <url-pattern>/*</url-pattern> 15 </filter-mapping>
五、xml配置文件的主要元素
1、package元素
1.1、作用:
在struts2的配置文件中引入了面向对象思想,使用了分包管理。易于管理动作类。便于模块化开发动作类。
1.2、属性:
name:包的名称。必须写。且必须唯一。
extends:一般情况下需要继承struts-default包,但不是必须的。不过如果不继承的话,将无法使用struts2提供的核心功能。
struts-default.xml中定义着struts-default这个包。而struts-default.xml是在我们的struts.xml加载之前加载。
abstract:把包声明为抽象包,抽象包就是用来被继承的。只要是没有<action>元素的包,就可以声明为抽象包。
namespace:名称空间。
名称空间 + 动作名称 = 访问路径
1 <package name="p1" extends="struts-default"> 2 <!-- action元素的name属性只需要写页面上提供hello.action前面的部分。后缀不需要写,也不能写。--> 3 <action name="hello" class="cn.itcast.web.action.HelloAction" method="sayHello"> 4 <!-- 执行完成之后,还要响应浏览器 5 name属性的取值是和动作方法的返回值一致,且严格区分大小写。 6 --> 7 <result name="success" type="dispatcher">/success.jsp</result> 8 </action> 9 </package>
1.3、packege中的namespace
namespace的默认值:
a.不写该属性
b.写了该属性,取值是一个"".
注意:默认值不是/
动作类的搜索顺序:
先找名称空间,再找动作名称。
1 <!-- 2 package元素: 3 作用:把动作类都分包来管理。目的是便于我们更好的模块化开发。配置文件中引入了面向对象的思想。 4 属性: 5 name:指定包的名称。该属性必须写。名称取值要唯一。 6 extends:指定当前包的父包。子包自动具备父包定义的内容。一般我们都继承struts-default的包,该包定义着struts2的核心功能。 7 struts-default包在struts-default.xml配置文件中定义着。如果不继承struts-default包,struts2核心功能都用不了。 8 abstract:把当前包声明为抽象包。抽象包一般都定义公共的配置,而且就是用来被继承的。 9 注意:只有没有action元素的包,才能被声明为抽象包。 10 namespace:指定当前包的名称空间。模块化管理访问URL。 11 当我们配置了名称空间之后: 12 访问URL就变成了 名称空间+hello 13 struts2框架提供的名称空间,在不写的时候是有默认值得。 14 默认值是:"" 15 "/"不是默认的名称空间,而是根名称空间。 16 --> 17 <package name="p1" extends="struts-default" namespace="/n1"> 18 <action name="hello" class="cn.itcast.web.action.HelloAction" method="sayHello"> 19 <result name="success" type="dispatcher">/success.jsp</result> 20 </action> 21 </package>
2、action元素
2.1、作用:
配置动作用的。
2.2、属性:
name:动作名称
class:动作类全名。默认的动作类是:com.opensymphony.xwork2.ActionSupport
是在struts-default.xml中定义的
method:动作类中的方法名称。默认是public String execute(){}
要求:
1.public的
2.返回值必须是String
3.没有参数
2.3、动作类
a.方式一:动作类就是一个POJO,非常简单的javabean。
b.方式二:动作类实现com.opensymphony.xwork2.Action接口。
常量:给动作方法返回值用的。用常量可以使你的应用规范和统一。
常量变量名 |
对应的值 |
说明 |
SUCCESS |
success |
动作方法执行一切OK |
ERROR |
error |
动作方法执行时遇到了异常 |
INPUT |
input |
回显 |
LOGIN |
login |
一般转向登陆页面 |
NONE |
none |
不转向任何的视图 |
c.方式三:动作类继承com.opensymphony.xwork2.ActionSupport 推荐使用
2.4、动作的访问
a.使用通配符:
<package name="p1" extends="struts-default" namespace="/n1"> <!-- action元素: 作用:配置动作名称和动作类以及动作方法的对应关系。 name:指定的是动作名称。它是与页面上请求URL后面对应起来的。但是此处不要写后缀,也不能写后缀。 动作名称的要求:必须唯一 class:指定的是动作类的全类名。 method:指定的是动作方法名称。 动作类的三种定义方式: 第一种定义方式:无侵入式的 定义一个普通类,提供一个符合要求的动作方法。 动作方法的要求: 1、public 2、返回值是String 3、没有参数 --> <action name="hello" class="cn.itcast.web.action.HelloAction" method="sayHello"> <result name="success" type="dispatcher">/success.jsp</result> </action> <!-- 动作类的第二种定义方式: 实现Action接口。该接口中提供了一些常量 SUCCESS:一般多用于全部成功。 ERROR:当我们的动作方法运行出现执行异常时使用。 INPUT:当我们提交数据失败时,需要回显数据,一般使用INPUT。 LOGIN:一般返回登录界面。 NONE:不返回任何结果视图。一般多用于文件下载,输出json数据。 可以使用return null;来实现和return NONE一样的效果 --> <action name="hello1" class="cn.itcast.web.action.Hello1Action" method="sayHello"> <result name="none" type="dispatcher">/success.jsp</result> </action> <!-- 默认的动作方法:是Action接口中的execute方法。如果是执行该方法,可以不指定method属性。 --> <action name="helloAction" class="cn.itcast.web.action.Hello1Action"> <result name="none" type="dispatcher">/success.jsp</result> </action> <!-- 动作类的第三种定义方式:推荐的方式 继承ActionSupport的类,该类就是Action接口的实现类。 在我们的实际开发中: 一般动作类都要继承ActionSupport。 --> <action name="hello2" class="cn.itcast.web.action.Hello2Action" method="sayHello"> <result name="success" type="dispatcher">/success.jsp</result> </action> <!-- 默认的动作类:ActionSupport 默认的动作方法:execute() --> <action name="defaultAction"> <result name="success" type="dispatcher">/success.jsp</result> </action>
</package> <!--最基本版配置: <package name="user" extends="struts-default" namespace="/user"> <action name="addUser" class="cn.itcast.web.action.UserAction" method="addUser"> <result name="success" type="dispatcher">/addUser.jsp</result> </action> <action name="updateUser" class="cn.itcast.web.action.UserAction" method="updateUser"> <result name="success" type="dispatcher">/updateUser.jsp</result> </action> <action name="deleteUser" class="cn.itcast.web.action.UserAction" method="deleteUser"> <result name="success" type="dispatcher">/deleteUser.jsp</result> </action> <action name="findUser" class="cn.itcast.web.action.UserAction" method="findUser"> <result name="success" type="dispatcher">/findUser.jsp</result> </action> </package> --> <!-- 使用*通配符来匹配一个或者多个字符 {n}表明的是通配符出现的位置。从1开始。 <package name="user" extends="struts-default" namespace="/user"> <action name="*" class="cn.itcast.web.action.UserAction" method="{1}"> <result name="success" type="dispatcher">/{1}.jsp</result> </action> </package>--> <!-- 使用通配符的升级版本 所有的action,都适用于此配置。它是通配符的形式。 我们还可以写成全字符匹配,或者多字符匹配。 他们之间有优先级问题: 全字符匹配最高>多字符匹配>全使用通配符 --> <package name="user" extends="struts-default" namespace="/user"> <action name="*_*" class="cn.itcast.web.action.{2}Action" method="{1}{2}"> <result name="success" type="dispatcher">/{1}{2}.jsp</result> </action> <action name="add_User" class="cn.itcast.web.action.UserAction" method="deleteUser"> <result name="success" type="dispatcher">/success.jsp</result> </action> </package>
六、结果类型视图(逻辑结果视图)
前奏:该部分内容指的就是struts配置文件中的result元素的使用
1、result元素
作用:
为动作指定结果视图
属性:
name:逻辑视图的名称,对应着动作方法的返回值。默认值是success。
type:结果类型,指的就是用什么方式转到定义的页面。默认是dispatcher。
2、result元素中type的取值
type属性的取值在struts-default.xml中定义着。
常用结果类型介绍:
dispatcher:(默认值)使用请求转发,转向一个页面。
redirect:使用重定向,转向一个页面。
redirectAction:注意:使用的是重定向。
a.重定向到另一个相同名称空间的动作。
b.重定向到不同名称空间的动作
3、result元素中param子元素
在转发或者重定向到不同包下的动作时,都用到了result元素的子元素param。
param元素的作用:依赖注入(Dependence Injection)思想
我们通过struts-default.xml中的resultTypes元素中配置可以看出,每个结果类型视图其实都是靠一个类来实现的。而param元素就是将配置的参数,注入到该类中。
调用的是对应类的setter方法进行注入的。
例如:redirectAction结果视图
该类中肯定会有对actionName和namespace属性的注入方法(setter方法)。
4、全局视图和局部视图
4.1、局部视图
只能当前动作使用
4.2、全局视图
所有动作都可以使用
注意:优先级问题,先局部后全局。
七、在动作类中访问Servlet的API
使用ServletActionContext类
1 public class HelloAction extends ActionSupport{ 2 3 4 public String sayHello(){ 5 HttpServletRequest request = ServletActionContext.getRequest(); 6 HttpServletResponse response = ServletActionContext.getResponse(); 7 HttpSession session = request.getSession(); 8 ServletContext application = ServletActionContext.getServletContext(); 9 System.out.println(request); 10 System.out.println(response); 11 System.out.println(session); 12 System.out.println(application); 13 return "success"; 14 } 15 }
八、分文件编写框架配置文件
1、不分文件开发可能产生的问题
就类似于我们在写java类时,所有代码都写在一个类里,甚至写在一个方法里。
当3个人都checkout了struts.xml文件时,第一个人提交了,后面的人在没有更新就提交时,第一个人写的可能就白写了。
2、分文件编写Struts2的配置文件
1 <struts> 2 <!-- 开启开发者模式 --> 3 <constant name="struts.devMode" value="true"></constant> 4 5 6 <package name="myDefault" extends="struts-default" abstract="true"> 7 <global-results> 8 <result name="success">/success.jsp</result> 9 </global-results> 10 </package> 11 12 <!-- 导入其他配置文件 --> 13 <include file="struts-book.xml"></include> 14 <include file="struts-user.xml"></include> 15 </struts>
1 <struts> 2 <!-- 与用户相关的动作配置 --> 3 <package name="user" extends="myDefault" namespace="/user"> 4 <action name="addUser" class="cn.itcast.web.action.UserAction" method="addUser"></action> 5 </package> 6 </struts>
1 <struts> 2 <!-- 与图书相关的动作配置 --> 3 <package name="book" extends="myDefault" namespace="/book"> 4 <action name="addBook" class="cn.itcast.web.action.BookAction" method="addBook"></action> 5 </package> 6 </struts>