规则集引用 rule-set-reference
图像服务支持基于正则表达式匹配和替换规则的简单请求预处理机制。
预处理规则集合(规则集)可以附加到图像目录或默认目录。 仅当请求未标识特定的主图像目录时,默认目录中的规则才适用。
请求预处理规则可在Platform Server的解析器处理请求之前修改请求的路径和查询部分,包括处理路径、添加命令、更改命令值以及应用模板或宏。 规则还可用于配置和覆盖某些安全功能,这些功能通常仅通过目录属性进行控制,例如请求模糊处理、标记水印,以及将服务限制到特定客户端IP地址。
规则集存储为XML文档文件。 必须在attribute::RuleSetFile
中指定规则集文件的相对路径或绝对路径。
常规结构 section-8bcbd91ea8a946f28051bde8ad21827f
<?xml version="1.0" encoding="UTF-8"?>
<ruleset>
<rule>
<expression>
<varname>
expression
</varname></expression>
<substitution>
<varname>
substitution
</varname></substitution>
<addressfilter>
<varname>
addressFilter
</varname></addressfilter>
<header>
<varname>
headerValue
</varname></header>
</rule>
</ruleset>
有效规则集XML文件中始终需要<?xml>
和<ruleset>
元素,即使未定义实际规则也是如此。
允许一个包含任意数量的<rule>
元素的<ruleset>
元素。
预处理规则文件的内容区分大小写。
规则集验证 section-d8d101a0b4d74580835e37d128d05567
RuleSet.xsd的副本在目录文件夹中提供,应在catalog.ini文件中注册之前用来验证规则集文件。 请注意,图像服务使用RuleSet.xsd的内部副本进行验证。
URL预处理 section-2c09a2d79ada46b994857c6a7fb4c13a
在任何其他处理之前,将部分解析传入的HTTP请求,以确定应应用哪个图像目录。 标识目录后,将应用选定目录(如果没有标识特定目录,则为默认目录)的规则集。
<rule>
元素按指定的顺序搜索,以查找与<expression>
元素(expression
)内容的匹配。
如果<rule>
匹配,则应用可选的 substitution
,并将修改后的请求字符串传递到服务器的请求分析器以进行正常处理。
如果在到达<ruleset>
的结尾时没有成功匹配,则请求将传递到分析器而不进行修改。
OnMatch属性 section-ed952fa55d99422db0ee68a2b9d395d3
可以使用<rule>
元素的OnMatch
属性修改默认行为。 OnMatch
可以设置为break
(默认)、continue
或error
。
覆盖目录属性 section-3f1e33a65c5346d1b4a69958c61432f3
rule
元素可以选择定义在成功匹配规则时覆盖相应目录属性的属性。 如果多个匹配的规则设置了相同的属性,则最后一个规则优先。 有关可以使用规则控制的属性列表,请参阅规则元素。
正则表达式 section-3f77bb9a265147b38c645f63ab1bad8b
简单字符串匹配适用于非常基本的应用程序,但在大多数情况下都需要正则表达式。 虽然正则表达式是符合行业标准的,但具体的实施因实例而异。
package java.util.regex描述了图像服务使用的特定正则表达式实现。
捕获的子字符串 section-066e659406d5403599cd26ae35e80d68
为了便于进行复杂的URL修改,可通过用圆括号(…)将子字符串括起来,从而在表达式中捕获子字符串。 捕获的子字符串根据前导圆括号的位置从1开始按顺序编号。 捕获的子字符串可以使用 $ *
n*
插入替换中,其中 n
是捕获的子字符串的序列号。
管理规则集文件 section-0598a608e4044bb4805fe93ceebe10a9
可以将一个规则集文件附加到具有目录属性attribute::RuleSetFile
的每个图像目录。 虽然您可以随时编辑规则集文件,但图像服务器仅在重新加载关联的图像目录时才识别更改。 当平台服务器启动或重新启动时,以及当修改或“接触”具有.ini文件后缀的主目录文件以更改文件日期时,都会发生这种重新加载。
示例 section-aa769437d967459299b83a4bf34fe924
示例A. 定义如果图像名称的后缀为“_hg”,则增加图像质量设置的规则:
<rule>
<expression>(?i)_hg$</expression>
<substitution>\?&qlt=95,1&resmode=bicub</substitution>
</rule>
规则表达式在URL字符串的末尾指定不区分大小写的“_hg”匹配项。 后缀被替换为指定的查询字符串,该字符串会更改图像质量设置。 请注意,替换字符串中的?
字符会被转义,因为这是正则表达式中的特殊字符。
<substitution><![CDATA[&qlt=95,1&resmode=bicub]]></substitution>
示例B. 特定Web应用程序不允许查询字符串。 定义一个将结尾路径元素small
、medium
或large
转换为模板的规则,使用路径的其余部分作为图像名称。 例如,myCat/myImage/small
将转换为myCat/smallTemplate?src=myCat/myImage
。
我们可以使用子字符串来重构请求:
<rule>
<expression>([^/]+)/(small|medium|large)$</expression>
<substitution>$2Template?src=sample/$1</substitution>
</rule>