struts2:struts.properties配置文件介绍及常量加载顺序

时间:2021-06-28 21:28:05

1. 背景

struts2框架中有两个核心配置文件,其中struts.xml文件主要负责管理应用中的action映射,以及该action包含的result定义等。除此之外,struts2框架还包括一个struts.properties文件,该文件定义了struts2框架的大量属性,开发者可以通过改变这些属性来满足应用的需求。

说明:struts.properties文件中的属性同样也可以在struts.xml文件中配置,只是源于struts配置文件模块化管理思路,将其分文件管理,增加了程序的可读性,以及降低了后期维护的难度。小型的项目可以将属性直接配置在struts.xml文件中。

struts.proproties文件是一个标准的Properties文件,该文件包含了系列的key-value对象,每个key就是一个struts2属性,该key对应的vlaue就是一个struts2的属性值。 struts.properties文件通常放在Web应用的WEB-INF/classes路径下。

2. 属性列表

struts.configuration

该属性制定加载Struts 2配置文件的配置文件管理器。该属性的默认值是org.apache.struts2.config.DefaultConfiguration,这是Struts 2默认的配置文件管理器。如果需要实现自己的配置配置文件管理器,开发者可以实现一个实现Configuration接口的类,该类可以自己加载Struts 2配置文件。

struts.locale

指定Web应用的默认locale。

struts.il8n.encoding

该常量指定了Web应用的默认编码集。通常,由于使用中文字符集,将其设置为UTF-8。

struts.objectFactory

指定Struts 2默认的ObjectFactory Bean,该属性默认时Spring。

struts.objectFactory.spring.autoWire

指定Spring框架的自动装配模式,默认值时name,即默认根据Bean的name属性自动装配。

struts.objectFactroy.spring.useClassCache

指定整合Spring框架时,是否缓存Bean实例,该属性只允许使用true和false,默认值是true。通常不建议修改该属性值得。

struts.objectTypeDeterminer

指定Struts 2的类型检测机制,通常支持tiger和notiger两个属性值。

struts.multipart.parser

指定处理multipart/forma-data的MIME类型(文件上传)请求框架,该属性支持cos、pell、和jakarta等属性,即分别对应使用cos的文件上传框架、pell上传及common-fileupload文件上产框架。默认值是jakarta.

struts.multipart.saveDir

指定上传文件的临时保存路径,默认值是javax.servlet.context.tempdir。

struts.multipart.maxSize

该属性指定Struts 2文件上传中整个请求内容允许的最大字节数。

struts.custom.properties

指定Struts 2 应用加载用户自定义的属性文件,该自定义属性文件指定的属性不会覆盖struts.properties文件中指定的属性。如果需奥加载多个自定义属性文件,多个自定义属性文件的文件名以英文逗号(,)隔开。

struts.mapper.class

指定将HTTP请求映射到指定Action的映射器,Struts 2提供了默认的映射器:org.apache.struts2.dispatcher.mapper.DefaultActionMapper。默认映射器根据请求的前缀与Action的name属性完成映射。

struts.action.extension

指定需要Struts 2处理的请求后缀,默认值是action,即所有匹配*.action的请求都都由Struts2处理。如果用户需要指定多个请求后缀,则多个后缀之间以英文逗号(,)隔开。

struts.serve.satic

该属性设置是否通过JAR文件提供静态内容服务,该属性只支持true和false,默认值是false。

struts.serve.static.browserCache

该属性设置浏览器是否缓存静态内容。当应用处于开发间段时,我们希望每次请求都获得服务器的最新响应,则可设置该属性为false。

struts.enable.DynamicMethodInvocation

设置Struts 2是否支持动态方法调用,默认值是true。

struts.enable.SlashesInActionNames

设置Struts 2是否允许Action名中使用斜线,默认值为false。

struts.tag.altSyntax

指定是否允许在Struts 2标签中使用表达式语法,因为通常都会在标签中使用表达式语法,因此应该设置为true,默认值是true。

struts.devMode

指定Struts 2应用是否应用开发模式。如果该属性设置为true,则可以在应用出错时显示更多、更友好的出错提示。该属性只接受true和false,默认值是false。

struts.il8.reload

设置是否每次HTTP请求到达时,系统都重新加载资源文件。默认值是false。在开发阶段应该设置为true。每次请求都加载资源文件会大大降低应用的性能。

struts.ui.theme

指定试图标签默认的试图主题,默认值是xhtml。

struts.ui.templateDir

指定试图主题所需要模板文件的位置,默认值是tempate,即默认加载template路径下的模板文件。

struts.ui.templateSuffix

指定模板文件的后缀,默认值是ftl。该属性还允许使用ftl、vm、jsp,分别对应FreeMarker、velocity、 JSP模板。

struts.configuration.xml.reload

设置当struts.xml文件改变后,系统是否自动重新加载该文件。默认值是false。

struts.velocity.configfile

指定Velocity框架所需的velocity.properties文件位置。默认值为velocity.properties。

struts.velocity.contexts

指定Velocity框架的Context位置,如果该框架有多个Context,则多个Context之间以英文逗号隔开。

struts.velocity.toolboxlocation

指定Velocity框架的toolbox位置。

struts.url.http.port

指定web应用所在的监听端口。

struts.url.https.port

该属性类似于struts.url.http.port属性的作用,区别是该属性指定的是WEB应用的加密服务端口。

strust.url.includeParames

该属性指定Struts 2生成URL时是否包含请求参数。该属性接受none、ge 、all三个属性,分别对应不包含、仅包含GET类型请求参数和包含全部请求参数。

struts.custom.il8n.resources

该属性指定struts 2应用所需要的国际化资源文件,如果有多份国际化资源文件,则多个国际化资源文件的文件名以英文逗号隔开。

struts.dispatcher.parametersWorkaround

对于某些JAVA EE服务器,不支持HttpServletRequest调用getParameterMap()方法,此时可以设置该属性值为true来解决该问题。默认值是false。对于WebLogic、Orion、OC4J服务器,通常应该设置为true。

struts.freemarker.manager.classname

指定Struts 2使用的FreeMarker管理器。默认值是org.apache.struts2.views.freemarker.FreemarkerManager,这是Struts2内建的FreeMarker管理器。

struts.xslt.nocache

指定XSLT Result是否使用样式表缓存。当应用处于开发间段时,通常被设置为true。

struts.configuration.files

指定struts2框架默认加载的配置文件,如果需要指定默认加载多个配置文件,则多个配置文件的文件名以英文逗号隔开。默认值为struts-default.xml,strust-plugin.xml,struts.xml。

3. 直接在struts.xml文件中定义

如果是小型项目,可以通过struts.xml文件配置constant来实现。示范:

<?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> <constant name="struts.ui.theme" value="simple"></constant>
<constant name="struts.action.extension" value="action"></constant>
<constant name="struts.ognl.allowStaticMethodAccess" value="true" />
</struts>

4. Struts2框架按如下顺序加载常量

  1. struts-default.xml:在struts-core-2.x.x.x.jar文件中
  2. struts-plugin.xml:在struts-Xxx-2.x.x.x.jar等Struts2插件jar文件中
  3. struts.xml
  4. struts.properties
  5. web.xml

上述是Struts2框架搜索常量的顺序,当同一个常量出现在多个文件中时,后出现的常量值会覆盖前面的值。