模块 ngx_http_xslt_module
示例配置 指令 xml_entities xslt_last_modified xslt_param xslt_string_param xslt_stylesheet xslt_types |
ngx_http_xslt_module
(0.7.8+) 是一个过滤器,它使用一个或多个 XSLT 样式表来转换 XML 响应。
此模块默认情况下未构建,应使用 --with-http_xslt_module
配置参数启用它。
此模块需要 libxml2 和 libxslt 库。
示例配置
location / { xml_entities /site/dtd/entities.dtd; xslt_stylesheet /site/xslt/one.xslt param=value; xslt_stylesheet /site/xslt/two.xslt; }
指令
语法 |
xml_entities |
---|---|
默认值 | — |
上下文 |
http 、server 、location |
指定声明字符实体的 DTD 文件。此文件在配置阶段编译。由于技术原因,模块无法使用已处理 XML 中声明的外部子集,因此它被忽略,而使用专门定义的文件代替。此文件不应描述 XML 结构。仅声明必需的字符实体就足够了,例如
<!ENTITY nbsp " ">
语法 |
xslt_last_modified |
---|---|
默认值 |
xslt_last_modified off; |
上下文 |
http 、server 、location |
此指令出现在 1.5.1 版中。
允许在 XSLT 转换期间保留原始响应中的“Last-Modified”标头字段,以方便响应缓存。
默认情况下,由于响应的内容在转换期间被修改,并且可能包含独立于原始响应而更改的动态生成元素或部分,因此会删除标头字段。
语法 |
xslt_param |
---|---|
默认值 | — |
上下文 |
http 、server 、location |
此指令出现在 1.1.18 版中。
定义 XSLT 样式表的参数。value
被视为 XPath 表达式。value
可以包含变量。要将字符串值传递给样式表,可以使用 xslt_string_param 指令。
可能有多个 xslt_param
指令。当且仅当当前级别上未定义 xslt_param
和 xslt_string_param 指令时,这些指令才会从上一个配置级别继承。
语法 |
xslt_string_param |
---|---|
默认值 | — |
上下文 |
http 、server 、location |
此指令出现在 1.1.18 版中。
定义 XSLT 样式表的字符串参数。value
中的 XPath 表达式不会被解释。value
可以包含变量。
可能存在多个 xslt_string_param
指令。当且仅当当前级别上未定义 xslt_param 和 xslt_string_param
指令时,这些指令才会从上一个配置级别继承。
语法 |
xslt_stylesheet |
---|---|
默认值 | — |
上下文 |
位置 |
定义 XSLT 样式表及其可选参数。样式表在配置阶段编译。
参数可以单独指定,也可以使用“:
”分隔符分组在一行中。如果参数包含“:
”字符,则应将其转义为“%3A
”。此外,libxslt
要求将包含非字母数字字符的参数用单引号或双引号引起来,例如
param1='http%3A//www.example.com':param2=value2
参数描述可以包含变量,例如,整行参数可以从单个变量中获取
location / { xslt_stylesheet /site/xslt/one.xslt $arg_xslt_params param1='$value1':param2=value2 param3=value3; }
可以指定多个样式表。它们将按指定顺序依次应用。
语法 |
xslt_types |
---|---|
默认值 |
xslt_types text/xml; |
上下文 |
http 、server 、location |
除了“text/xml
”之外,还启用对具有指定 MIME 类型的响应进行转换。特殊值“*
”匹配任何 MIME 类型 (0.8.29)。如果转换结果是 HTML 响应,则其 MIME 类型将更改为“text/html
”。