<-
Apache > HTTP Server > 文档 > 版本2.2 > 模块
   致谢 | 本篇译者:金步国 | 本页最后更新:2006年1月25日 | 获取最新版本

Apache模块 mod_headers

说明允许通过配置文件控制任意的HTTP请求和应答头信息
状态扩展(E)
模块名headers_module
源文件mod_headers.c
兼容性RequestHeader仅在 Apache 2.0 中有效

概述

这个模块提供了一些指令用于控制和修改HTTP请求头和应答头。这些头可以被合并、替换、删除。

top

处理顺序

mod_headers提供的指令几乎可以出现在配置文件的任何部分。并可以封装在配置段中以限制其作用范围。

指令的处理顺序很重要,它取决于指令本身在配置文件中的位置和所属配置段在配置文件中的位置。下面的指令如果颠倒一下顺序将会导致完全不同的结果:

RequestHeader append MirrorID "mirror 12"
RequestHeader unset MirrorID

当前顺序下,MirrorID头不会被设置。若颠倒一下顺序,MirrorID头将被设为"mirror 12"。

top

前处理和后处理

mod_headers可以应用在请求被处理之前或之后。通常的模式是"后处理",也就是在请求处理完毕之后、发送应答之前设置应答头。[原文:when Request Headers are set immediately before running the content generator and Response Headers just as the response is sent down the wire.]在实际工作的服务器上应当始终使用"后处理"模式。

"前处理"模式应当仅仅作为开发者使用的一种测试/调试辅助工具。可以在指令中使用early关键字启用"前处理"模式,此时将在处理请求之前设置请求头。这样就可以模拟各种不同的请求以协助调试。

由于"前处理"模式的指令在将URL映射到文件系统之前就生效了,不能依赖于所请求的路径。所以"前处理"模式的指令只能用在主服务器和虚拟主机部分的配置中,而不能用于<Directory><Location>配置段中。

top

示例

  1. 将所有以"TS"开头的请求头复制到应答头中:

    Header echo ^TS

  2. 在应答中添加一个MyHeader头来包含服务端接受到请求的时间戳和经过多少时间以后才完成对该请求的处理并作出应答。这个头可以让客户端知道瓶颈位于服务端还是位于服务端和客户端之间的线路。

    Header add MyHeader "%D %t"

    上面的设置将会添加如下应答头内容:

    MyHeader: D=3775428 t=991424704447256

  3. 向Joe问好(Hello):

    Header add MyHeader "Hello Joe. It took %D microseconds \
    for Apache to serve this request."

    上面的设置将会添加如下应答头内容:

    MyHeader: Hello Joe. It took D=3775428 microseconds for Apache to serve this request.

  4. 当且仅当"MyRequestHeader"出现在请求头中的时候才在应答中发送"MyHeader"头。这个对根据特定的客户端构造特定的应答头很有用。注意,下面的例子需要mod_setenvif模块的支持。

    SetEnvIf MyRequestHeader value HAVE_MyRequestHeader
    Header add MyHeader "%D %t mytext" env=HAVE_MyRequestHeader

    如果请求中出现"MyRequestHeader: value"头,应答中将会包含下面的头:

    MyHeader: D=3775428 t=991424704447256 mytext

top

Header 指令

说明配置HTTP应答头
语法Header [condition] set|append|add|unset|echo header [value] [early|env=[!]variable]
作用域server config, virtual host, directory, .htaccess
覆盖项FileInfo
状态扩展(E)
模块mod_headers

这个指令可以替换、合并、删除HTTP应答头。应答头紧跟在内容处理器和输出过滤器完工之后生成,这时候才能对头进行修改。

condition选项可以是onsuccessalways 。它决定了将对哪个内部头(internal header)表进行操作。onsuccess表示"2xx"状态码,always表示所有状态码(包含"2xx")。特别地,如果你想撤销由某个模块设置的头,你应当做做试验,以找到是那个表产生的影响。

该指令执行的动作是由第二个参数决定的。这个参数取值范围如下:

set
设置新的或修改已经存在的同名应答头。value可以是一个格式字符串。
append
向同名应答头添加新内容而不修改原来已经存在的旧内容。当向一个已经存在的头添加新值时,将用逗号与原来已经存在的旧值分开。这是向HTTP头赋以多个值的标准方法。
add
向应答中添加新的头而不修改原来已经存在的头(即使同名)。这将可能导致有两个或更多的应答头具有相同的名字,从而导致意想不到的后果,所以通常不使用这种方法而用append来代替它。
unset
去除应答中同名的头(若存在的话)。如果有多个头同名,则会被全部去除。value必须被省略。
echo
将请求中同名的头复制到应答中。header可以是一个正则表达式value必须被省略。

这个参数后面必须要跟一个header名字(结尾的冒号可要可不要)。set, append, add, unset是大小写无关的。用于echoheader是大小写敏感的,并且可以是一个正则表达式

对于add, append, set来说,value是第三个参数。如果value包含空格则必须用双引号(")括起来。value可以是一个普通字符串或包含格式说明符的字符串,value支持下列格式字符串:

格式描述
%%百分号(%)
%t接收到请求的微秒时间戳(相对于1970-1-1 00:00:00 UCT),外加一个"t="前缀。
%D从接收到请求到完成对该请求的处理并作出应答共花费了多少微秒,外加一个"D="前缀。
%{FOOBAR}e环境变量FOOBAR的内容
%{FOOBAR}sSSL环境变量FOOBAR的内容(如果启用了mod_ssl)

注意

"%s"格式符仅在Apache 2.1及以后的版本中可用。它可以代替"%e"以避免"SSLOptions +StdEnvVars"带来的额外开销。如果因为别的原因必须开启"SSLOptions +StdEnvVars",那么"%e"将比"%s"更加合适。

Header后面可以跟一个用于指定生效条件的额外参数(或者用early表示"前处理")。如果在"env=..."参数中指定的环境变量存在(或用"env=!..."表示不存在),那么Header指令指定的动作将会生效,否则将不会生效。

除非使用early模式,否则Header指令将在应答最后被发送到网络前处理。这意味着可以设置和改写绝大多数应答头,除了自己添加的应答头。

top

RequestHeader 指令

说明配置HTTP请求头
语法RequestHeader set|append|add|unset header [value] [early|env=[!]variable]
作用域server config, virtual host, directory, .htaccess
覆盖项FileInfo
状态扩展(E)
模块mod_headers
兼容性仅在 Apache 2.0 中有效

这个指令可以替换、合并、删除HTTP应答头。请求头将会在内容处理器运行之前被修改。修改的动作由第一个参数决定,其取值范围如下:

set
设置新的或修改已经存在的同名请求头。
append
向同名请求头添加新内容而不修改原来已经存在的旧内容。当向一个已经存在的头添加新值时,将用逗号与原来已经存在的旧值分开。这是向HTTP头赋以多个值的标准方法。
add
向请求中添加新的头而不修改原来已经存在的头(即使同名)。这将可能导致有两个或更多的请求头具有相同的名字,从而导致意想不到的后果,所以通常不使用这种方法而用append来代替它。
unset
去除请求中同名的头(若存在的话)。如果有多个头同名,则会被全部去除。value必须被省略。

这些参数后面必须要跟一个header名(结尾的冒号可要可不要,且大小写无关)。对于add, append, set来说,value是第三个参数。如果value包含空格则必须用双引号(")括起来。对于unset来说则不需要value参数。value可以是一个普通字符串或包含格式说明符的字符串,格式字符串的用法与Header指令一样。

RequestHeader后面可以跟一个用于指定生效条件的额外参数(或者用early表示"前处理")。如果在"env=..."参数中指定的环境变量存在(或用"env=!..."表示不存在),那么RequestHeader指令指定的动作将会生效,否则将不会生效。

除非使用early模式,否则RequestHeader将在请求被处理之前生效。这样,由浏览器和Apache输入过滤器产生的请求头都可以被该指令处理。