Struts2 --- struts.xml配置文件详解

本文详细解析Struts2框架的配置文件加载流程,包括struts.xml的各个元素如<include>、<constant>、<bean>、<package>及其子元素,以及struts.properties文件的作用和常见配置。通过对这些配置的理解,有助于更好地管理和组织Struts2应用程序。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

一、Struts2配置文件加载流程

(1)web.xml配置filter

 

(2)通过InitOperations初始化Dispatcher

 

(3)Dispatcher初始化配置

 

(4)Dispatcher的init()

 

 

二、struts.properties文件

这个文件是struts2框架的全局属性文件,也是自动加载的文件。该文件包含了系列的key-value对。该文件完全可以配置在struts.xml文件中,使用constant元素。下面是这个文件中一些常见的配置项及说明。

 

### 指定加载struts2配置文件管理器,默认为org.apache.struts2.config.DefaultPropertiesProvider
### 开发者可以自定义配置文件管理器,该类要实现Configuration接口,可以自动加载struts2配置文件。

### 设置默认的locale和字符编码
# struts.locale=en_US
struts.i18n.encoding=UTF-8


### 指定struts的工厂类
# struts.objectFactory = spring

### 指定spring框架的装配模式
### 装配方式有: name, type, auto, and constructor (name 是默认装配模式)
struts.objectFactory.spring.autoWire = name

### 该属性指定整合spring时,是否对bean进行缓存,值为true or false,默认为true.
struts.objectFactory.spring.useClassCache = true

### 指定类型检查
#struts.objectTypeDeterminer = tiger
#struts.objectTypeDeterminer = notiger

### 该属性指定处理 MIME-type multipart/form-data,文件上传
# struts.multipart.parser=cos
# struts.multipart.parser=pell
struts.multipart.parser=jakarta
# 指定上传文件时的临时目录,默认使用 javax.servlet.context.tempdir 
struts.multipart.saveDir=
struts.multipart.maxSize=2097152

### 加载自定义属性文件 (不要改写struts.properties!)
# struts.custom.properties=application,org/apache/struts2/extension/custom

### 指定请求url与action映射器,默认为org.apache.struts2.dispatcher.mapper.DefaultActionMapper
#struts.mapper.class=org.apache.struts2.dispatcher.mapper.DefaultActionMapper

### 指定action的后缀,默认为action
struts.action.extension=action

### 被 FilterDispatcher使用
### 如果为 true 则通过jar文件提供静态内容服务. 
### 如果为 false 则静态内容必须位于 <context_path>/struts
struts.serve.static=true

### 被 FilterDispatcher使用
### 指定浏览器是否缓存静态内容,测试阶段设置为false,发布阶段设置为true.
struts.serve.static.browserCache=true

### 设置是否支持动态方法调用,true为支持,false不支持.
struts.enable.DynamicMethodInvocation = true

### 设置是否可以在action中使用斜线,默认为false不可以,想使用需设置为true.
struts.enable.SlashesInActionNames = false

### 是否允许使用表达式语法,默认为true.
struts.tag.altSyntax=true


### 设置当struts.xml文件改动时,是否重新加载.
### - struts.configuration.xml.reload = true
### 设置struts是否为开发模式,默认为false,测试阶段一般设为true.
struts.devMode = false

### 设置是否每次请求,都重新加载资源文件,默认值为false.
struts.i18n.reload=false

###标准的UI主题
### 默认的UI主题为xhtml,可以为simple,xhtml或ajax
struts.ui.theme=xhtml
###模板目录
struts.ui.templateDir=template
#设置模板类型. 可以为 ftl, vm, or jsp
struts.ui.templateSuffix=ftl

###定位velocity.properties 文件.  默认 velocity.properties
struts.velocity.configfile = velocity.properties

### 设置velocity的context.
struts.velocity.contexts =

### 定位toolbox.
struts.velocity.toolboxlocation=

### 指定web应用的端口.
struts.url.http.port = 80
### 指定加密端口
struts.url.https.port = 443
### 设置生成url时,是否包含参数.值可以为: none, get or all
struts.url.includeParams = get

### 设置要加载的国际化资源文件,以逗号分隔.
# struts.custom.i18n.resources=testmessages,testmessages2

### 对于一些web应用服务器不能处理HttpServletRequest.getParameterMap()
### 像 WebLogic, Orion, and OC4J等,须设置成true,默认为false.
struts.dispatcher.parametersWorkaround = false

### 指定freemarker管理器
#struts.freemarker.manager.classname=org.apache.struts2.views.freemarker.FreemarkerManager

### 设置是否对freemarker的模板设置缓存
### 效果相当于把template拷贝到 WEB_APP/templates.
struts.freemarker.templatesCache=false

### 通常不需要修改此属性.
struts.freemarker.wrapper.altMap=true

### 指定xslt result是否使用样式表缓存.开发阶段设为true,发布阶段设为false.
struts.xslt.nocache=false

### 设置struts自动加载的文件列表.
struts.configuration.files=struts-default.xml,struts-plugin.xml,struts.xml

### 设定是否一直在最后一个slash之前的任何位置选定namespace.
struts.mapper.alwaysSelectFullNamespace=false

 

 

 

 

 

三、struts.xml文件

该文件也是struts2框架自动加载的文件,在这个文件中可以定义一些自己的action,interceptor,package等,该文件的package 通常继承struts-default包。下面是这个文件的格式。

 

<?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>
	
	<!-- 
		include节点是struts2中组件化的方式 可以将每个功能模块独立到一个xml配置文件中 然后用include节点引用
	 -->
	<include file="struts-default.xml"></include>
	<include file="struts-login.xml"></include>

	<!-- 
		设置struts2的全局属性
	 -->
	<!-- 设置struts是否为开发模式,默认为false,测试阶段一般设为true -->
    <constant name="struts.devMode" value="true" />  
    <!-- 设置默认的locale和字符编码 -->
	<constant name="struts.i18n.encoding" value="UTF-8"></constant>
	<!-- 设置是否支持动态方法调用,true为支持,false不支持. -->
	<constant name="struts.enable.DynamicMethodInvocation" value="false" />
	<!-- 设置是否每次请求,都重新加载资源文件,默认值为false. -->  
    <constant name="struts.i18n.reload" value="true" />
    <!-- 设置当struts.xml文件改动时,是否重新加载 -->  
    <constant name="struts.configuration.xml.reload" value="true" ></constant>  
	
	<!-- 设置Bean -->
	<bean name="helloWorldAction" class="com.test.struts2.action.HelloWorldAction"></bean>

	<!-- 
		package提供了将多个Action组织为一个模块的方式,package的名字必须是唯一的,package可以extends一个package
		extends自另一个package时该package会在本身配置的基础上加入extends的package的配置父package必须在子package前配置 
		
		name: package名称 
		extends: 继承的父package名称 
		abstract: 用于声明package属性为抽象包,然后其它package继承此package,抽象的package不能定义action
		namespace: 定义package命名空间 该命名空间影响到url的地址
	 -->
	<package name="helloworld" extends="struts-default" namespace="/">
		
		<!-- 定义拦截器 -->
		<interceptors>
			<!-- 定义拦截器 name:拦截器名称 class:拦截器类路径 -->
			<interceptor name="timer" class="com.test.struts2.filter.timer"></interceptor>
			<interceptor name="logger" class="com.test.struts2.filter.logger"></interceptor>
			<!-- 定义拦截器栈 -->
			<interceptor-stack name="mystack">
				<interceptor-ref name="timer"></interceptor-ref>
				<interceptor-ref name="logger"></interceptor-ref>
			</interceptor-stack>
		</interceptors>

		<!-- 定义默认的拦截器 每个Action都会自动引用 如果Action中引用了其它的拦截器 默认的拦截器将无效 -->
		<default-interceptor-ref name="mystack"></default-interceptor-ref>

		<!-- 全局results配置 -->
		<global-results>
			<result name="error">/error.jsp</result>
		</global-results>

		<!-- 
			Action配置 一个Action可以被多次映射(只要action配置中的name不同) 
			name:action名称 
			class: 对应的类的路径 
			method: 调用Action中的方法名,默认调用execute
		 -->
		<action name="helloWorldAction" class="helloWorldAction" method="execute">
			<!-- 引用拦截器 name:拦截器名称或拦截器栈名称 -->
			<interceptor-ref name="timer"></interceptor-ref>

			<!-- 
				result配置:
				name : result名称 和Action中返回的值相同 
				type : result类型 不写则选用superpackage的type 
				struts-default.xml中的默认为dispatcher
			 -->
			<result name="success" type="dispatcher">/talk.jsp</result>
			
			<!-- 参数设置 name:对应Action中的get/set方法 -->
			<param name="url">http://www.sina.com</param>
		</action>
	</package>
	
	
</struts>

 

 

 

 

 

struts.xml中常用标签介绍:

3.1、<include>

利用include标签,可以将一个struts.xml配置文件分割成多个配置文件,然后在struts.xml中使用<include>标签引入其他配置文件。

属性:

file:文件路径

 

示例:

 

<include file="struts-login.xml"></include>

 

 

 

 

 

3.2、<constant>

在之前提到struts.properties配置文件的介绍中,我们曾经提到所有在struts.properties文件中定义的属性,都可以配置在struts.xml文件中。而在struts.xml中,是通过<constant>标签来进行配置的

属性:

name:常量的名称

value:常量的值

 

示例:

 

<!-- 设置struts是否为开发模式,默认为false,测试阶段一般设为true -->
    <constant name="struts.devMode" value="true" />  
    <!-- 设置默认的locale和字符编码 -->
	<constant name="struts.i18n.encoding" value="UTF-8"></constant>
	<!-- 设置是否支持动态方法调用,true为支持,false不支持. -->
	<constant name="struts.enable.DynamicMethodInvocation" value="false" />
	<!-- 设置是否每次请求,都重新加载资源文件,默认值为false. -->  
    <constant name="struts.i18n.reload" value="true" />
    <!-- 设置当struts.xml文件改动时,是否重新加载 -->  
    <constant name="struts.configuration.xml.reload" value="true" ></constant>

 

 

 

 

 

3.3、<bean>

用于定义bean

属性:

class:必填属性,指定Bean实例的实现类

name:可选属性,该属性指定Bean实例的名字,对于有相同type类型的多个Bean,name属性不能相同

type:可选属性,指定Bean实例实现的struts2的规范,该规范通常是通过某个接口来体现,因此该属性的值通常是一个struts2接口。如果需要将Bean实例作为struts2组件来使用,则应该指定该属性的值

scope:可选属性,该属性指定Bean实例的作用域,属性值只能是default、singleton、request、session或thread之一。

static:可选属性,该属性指定Bean是否使用静态方法注入,通常而言,当指定了type属性时,该属性值不应该指定为true。

optional:可选属性,该属性指定该Bean是否是一个可选的Bean。

 

示例:

 

<!-- 设置Bean -->
	<bean name="helloWorldAction" class="com.test.struts2.action.HelloWorldAction" ></bean>

 

 

 

 

 

3.4、<package>

struts2使用包来组织区分各个模块

属性:

name:必填属性,包的名字

extends:可选属性,如果继承了某个包可以使用其中所有的配置,通常情况下可继承struts-default、struts-default这个包在struts2-core-2.3.1.2.jar --- struts-default.xml文件中定义

namespase:可选属性,命名空间,默认为“/”,namespace主要是针对大型项目中Action的管理,更重要的是解决Action重名问题,因为不在同一个命名空间的Action可以使用相同的Action名的。

abstract:可选属性,表示抽象的包,用于其他包extends

externalReferenceResolver:可选属性

 

示例:

 

<!-- 
		package提供了将多个Action组织为一个模块的方式,package的名字必须是唯一的,package可以extends一个package
		extends自另一个package时该package会在本身配置的基础上加入extends的package的配置父package必须在子package前配置 
		
		name: package名称 
		extends: 继承的父package名称 
		abstract: 用于声明package属性为抽象包,然后其它package继承此package,抽象的package不能定义action
		namespace: 定义package命名空间 该命名空间影响到url的地址
	 -->
	<package name="helloworld" extends="struts-default" namespace="/" >
		
		<!-- 定义拦截器 -->
		<interceptors>
			<!-- 定义拦截器 name:拦截器名称 class:拦截器类路径 -->
			<interceptor name="timer" class="com.test.struts2.filter.timer"></interceptor>
			<interceptor name="logger" class="com.test.struts2.filter.logger"></interceptor>
			<!-- 定义拦截器栈 -->
			<interceptor-stack name="mystack">
				<interceptor-ref name="timer"></interceptor-ref>
				<interceptor-ref name="logger"></interceptor-ref>
			</interceptor-stack>
		</interceptors>

		<!-- 定义默认的拦截器 每个Action都会自动引用 如果Action中引用了其它的拦截器 默认的拦截器将无效 -->
		<default-interceptor-ref name="mystack"></default-interceptor-ref>

		<!-- 全局results配置 -->
		<global-results>
			<result name="error">/error.jsp</result>
		</global-results>

		<!-- 
			Action配置 一个Action可以被多次映射(只要action配置中的name不同) 
			name:action名称 
			class: 对应的类的路径 
			method: 调用Action中的方法名,默认调用execute
		 -->
		<action name="helloWorldAction" class="helloWorldAction" method="execute">
			<!-- 引用拦截器 name:拦截器名称或拦截器栈名称 -->
			<interceptor-ref name="timer"></interceptor-ref>

			<!-- 
				result配置:
				name : result名称 和Action中返回的值相同 
				type : result类型 不写则选用superpackage的type 
				struts-default.xml中的默认为dispatcher
			 -->
			<result name="success" type="dispatcher">/talk.jsp</result>
			
			<!-- 参数设置 name:对应Action中的get/set方法 -->
			<param name="url">http://www.sina.com</param>
		</action>
	</package>

 

 

 

 

 

3.4.1、<action>

配置Action的访问路径

属性:

name:必填属性,请求的Action的名称

class:可选属性,默认值为com.opensymphony.xwork2.ActionSupport,对应的action类的相对文件路径

method:可选属性,默认值为execute, 对应action中的方法

converter:可选属性,指定Action使用的类型转换器

 

 

3.4.2、<default-action-ref>

在请求无效或错误时将请求指引到错误页面。

属性:

name:指定访问的Action

 

3.4.3、<default-class-ref>

当我们在配置Action的时候,如果没有为某个Action指定具体的class值时,系统将自动引用<default-class-ref>标签中所指定的类。在Struts2框架中,系统默认的class为com.opensymphony.xwork2.ActionSupport,该配置我们可以在xwork的核心包下的xwork-default.xml文件中找到。

属性:

class:指定Action实现类

 

 

3.4.4、<default-interceptor-ref>

该标签用来设置整个包范围内所有Action所要应用的默认拦截器信息。事实上我们的包继承了struts-default包以后,使用的是Struts的默认设置。我们可以在struts-default.xml中找到相关配置:

<default-interceptor-ref name="defaultStack"/>

 

 

3.4.5、<global-exception-mappings>

定义全局异常,用于处理Action未捕获的的异常

子标签:

 

  • 3.4.5.1、<exception-mapping>
  • 属性:
  • name:可选属性,exception-mapping名称
  • result:结果
  • exception:异常类

 

示例:

 

<global-results>  
	        <result name="sql">/internal_Error.jsp</result>  
	        <result name="test">/invalid_Input.jsp</result>  
	        <result name="naming">/internal_Error.jsp</result>  
	    </global-results>  
	    <global-exception-mappings>  
	        <exception-mapping result="sql" exception="java.sql.SQLException"></exception-mapping>  
	        <exception-mapping result="test" exception="cn.test.exception.TestException"></exception-mapping>  
	        <exception-mapping result="naming" exception="javax.naming.NamingException"></exception-mapping>  
	    </global-exception-mappings>

 

 

 

 

 

3.4.6、<global-results>

该标签用于设置包范围内的全局结果集。在多个Action返回相同逻辑视图的情况下,可以通过<global-results>标签统一配置这些物理视图所对应的逻辑视图。

 

子标签:

 

  • 3.4.6.1、<result>
  • 属性:
  • name:必填属性,结果集名称
  • type:结果集类型

示例:

同上

 

 

3.4.7、<interceptors>

通过该标签可以向Struts2框架中注册拦截器或者拦截器栈,一般多用于自定义拦截器或拦截器栈的注册。

 

子标签:

 

  • 3.4.7.1、<interceptor> --- 拦截器
  • 属性:
  • name:必填属性,拦截器名称
  • class:必填属性,拦截器实例实现类
  •  
  • 子标签:
  • 3.4.7.1.1、<param>
  • 属性:
  • name:必填属性,指定参数名称 
  •  
  • 3.4.7.2、<interceptor-stack> --- 拦截器栈
  • 属性:
  • name:必填属性,拦截器名称
  •  
  • 子标签:
  • 3.4.7.2.1、<interceptor-ref>
  • 属性:
  • name:名称
  •  
  • 子标签:
  • 3.4.7.2.1.1、<param>
  • 属性:
  • name:参数名称

 

示例:

 

 

<!-- 定义拦截器 -->
		<interceptors>
			<!-- 定义拦截器 name:拦截器名称 class:拦截器类路径 -->
			<interceptor name="timer" class="com.test.struts2.filter.timer">
				<param name="baidu">http://www.baidu.com</param>
			</interceptor>
			<interceptor name="logger" class="com.test.struts2.filter.logger"></interceptor>
			<!-- 定义拦截器栈 -->
			<interceptor-stack name="mystack">
				<interceptor-ref name="timer">
					<param name="baidu">http://www.baidu.com</param>
				</interceptor-ref>
				<interceptor-ref name="logger"></interceptor-ref>
			</interceptor-stack>
		</interceptors>

 

 

 

 

 

 

3.4.8、<result-types>

在struts2-core.jar/struts-default.xml中,我们可以找到关于result-type的一些配置信息,从中可以看出struts2组件默认为我们提供了这 些result-type 

 

<result-types> 
            <result-type name="chain" class="com.opensymphony.xwork2.ActionChainResult"/> 
            <result-type name="dispatcher" class="org.apache.struts2.dispatcher.ServletDispatcherResult" default="true"/> 
            <result-type name="freemarker" class="org.apache.struts2.views.freemarker.FreemarkerResult"/> 
            <result-type name="httpheader" class="org.apache.struts2.dispatcher.HttpHeaderResult"/> 
            <result-type name="redirect" class="org.apache.struts2.dispatcher.ServletRedirectResult"/> 
            <result-type name="redirectAction" class="org.apache.struts2.dispatcher.ServletActionRedirectResult"/> 
            <result-type name="stream" class="org.apache.struts2.dispatcher.StreamResult"/> 
            <result-type name="velocity" class="org.apache.struts2.dispatcher.VelocityResult"/> 
            <result-type name="xslt" class="org.apache.struts2.views.xslt.XSLTResult"/> 
            <result-type name="plainText" class="org.apache.struts2.dispatcher.PlainTextResult" /> 
            <!-- Deprecated name form scheduled for removal in Struts 2.1.0. The camelCase versions are preferred. See ww-1707 --> 
            <result-type name="redirect-action" class="org.apache.struts2.dispatcher.ServletActionRedirectResult"/>
        </result-types>


说明:

 

chain:用来处理Action链

dispatcher:用来转向页面,通常处理JSP

freemarker:处理FreeMarker模板

httpheader:用来控制特殊的Http行为

redirect:重定向到一个URL

redirectAction:重定向到一个Action

stream:向浏览器发送InputStream对象,通常用来处理文件下载

velocity:处理Velocity模板

xslt:处理XML/XLST模板

plainText:显示原始文件内容,例如文件源代码

 

 

 

 

 

 

 

 

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值