# 内容协商 Apache支持HTTP/1.1规范中定义的内容协商，它可以根据浏览器提供的参数选择一个资源最合适的媒体类型、语言、字符集和编码的表现方式。它还实现了一些对浏览器发送不完整内容协商信息进行智能处理的能力。 内容协商由`mod_negotiation`模块支持，并被默认编译进服务器。 ## 关于内容协商(Content Negotiation) 一个资源可能会有多种不同的表现形式，比如，可能会有不同语言或者媒体类型的版本甚至其组合。最常用的选择方法是提供一个索引页以供选择。但是由于浏览器可以在请求头信息中提供其首选项的表现形式，因此就有可能让服务器进行自动选择。比如，浏览器可以表明希望看见法语的信息，如果没有，英语的也行。如需仅请求法语的表现形式，浏览器可以发出： ``` Accept-Language: fr ``` 注意：此首选项信息仅当存在多种可选的语言表现形式时才有效。 下面是一个更复杂的请求，浏览器表明，可以接受法语和英语，但最好是法语；接受各种媒体类型，最好是HTML，但纯文件或其他文本类型也可以；最好是GIF或JPEG，但其他媒体类型也可以，并允许其他媒体类型作为最终表现形式： ``` Accept-Language: fr; q=1.0, en; q=0.5 Accept: text/html; q=1.0, text/*; q=0.8, image/gif; q=0.6, image/jpeg; q=0.6, image/*; q=0.5, */*; q=0.1 ``` Apache支持HTTP/1.1规范中定义的"服务器驱动"的内容协商， 可以完全地支持`Accept`、`Accept-Language`、`Accept-Charset`、`Accept-Encoding`请求头，这些是RFC2295和RFC2296中定义的实验协商协议，但是不支持这些RFC中定义的"功能协商"。 **资源(resource)**是一个在URI(RFC2396)中定义的概念上的实体。一个HTTP服务器，比如Apache，以**表现形式(representation)**提供对其名称空间中资源的访问，各种表现形式由已定义的媒体类型、字符集和编码的字节流构成。任何一个特定的时刻，一个资源可以没有，或者有一个，或者有多个表现形式。如果有多个表现形式存在，则称该资源是**可协商的(negotiable)**，其各种表现形式称为**变种(variant)**。而一个可协商的资源的各种变种的区别途径称为**变元(dimension)**。 ## Apache中的内容协商 可以使用下述两种途径之一向服务器提供有关各变种的信息，以实现对资源的协商： * 使用类型表(也就是一个 `*.var`文件)明确指定各变种的文件名。 * 使用"MultiViews"搜索，即服务器执行一个隐含的文件名模式匹配，并在其结果中选择。 ### 使用类型表文件 类型表是一个与`type-map`处理器关联的文档(或者兼容早期Apache配置的[MIME类型](#calibre_link-223 "see glossary")：`application/x-type-map` )。要使用这个功能，必须在配置中建立处理器，以定义一个文件后缀为`type-map`，最好的方法是在配置文件中这样设置： ``` AddHandler type-map .var ``` 类型表文件应该与所描述的资源同名，且对每个有效变种都有一个块(entry)，每个块由若干连续的HTTP头行组成，不同变种的块用空行分开，块中不允许有空行。习惯上，类型表都以一个描述总体性质的组合块作为开始(这不是必须的，如果有也会被忽略)。下例是一个描述资源`foo`的命名为`foo.var`的类型表文件： ``` URI: foo URI: foo.en.html Content-type: text/html Content-language: en URI: foo.fr.de.html Content-type: text/html;charset=iso-8859-2 Content-language: fr, de ``` 注意：即使将`MultiViews`设置为 `On` ，类型表仍然优先于文件后缀名。如果不同的变种具有不同的资源品质，就可以对媒体类型使用"qs"参数来表示这种不同。下例演示了一个图片的 jpeg, gif, ASCII-art 三个有效变种： ``` URI: foo URI: foo.jpeg Content-type: image/jpeg; qs=0.8 URI: foo.gif Content-type: image/gif; qs=0.5 URI: foo.txt Content-type: text/plain; qs=0.01 ``` qs的取值范围是0.000到1.000，取值为0.000的变种永远不会被选择，没有指定qs值的变种其qs值为1.0。qs值表示一个变种相对于其他变种的"品质"，比如在表现一张照片时，jpeg通常比字符构图有更高的品质；而如果要表现的本来就是一个ASCII-art ，那么当然字符构图就会比jpeg文件有更高的品质。因此，qs的值取决于变种所表现的资源本身。 [mod_negotation类型表](#calibre_link-554)文档中有完整的HTTP头的列表。 ### Multiviews `MultiViews`是一个针对每个目录的选项，也就是说可以在`httpd.conf`或`.htaccess`(如果正确设置了`AllowOverride`)文件中的`<Directory>`、`<Location>`、`<Files>`配置段中，用`Options`指令来指定。注意，`Options All` 并不会设置`MultiViews` ，你必须明确地指定。 `MultiViews`的效果是：如果服务器收到对`/some/dir/foo`的请求，而`/some/dir/foo`并_不_存在，但是如果`/some/dir`启用了`MultiViews` ，则服务器会查找这个目录下所有的foo.* 文件，并有效地伪造一个说明这些foo.* 文件的类型表，分配给他们相同的媒体类型及内容编码，并选择其中最合适的匹配返回给客户。 `MultiViews`还可以在服务器检索一个目录时，用于`DirectoryIndex`指令搜索的文件名。如果设置了： ``` DirectoryIndex index ``` 而`index.html`和`index.html3`并存，则服务器会作一个权衡；如果都没有，但是有`index.cgi` ，则服务器会执行它。 如果一个目录中没有任何文件具有`mod_mime`可以识别的表示其字符集、内容类型、语言和编码的后缀，那么其结果将取决于`MultiViewsMatch`指令的设置，这个指令决定了在MultiViews协商中将使用的处理器、过滤器和其他后缀类型。 ## 协商的方法 Apache从一个类型表或者某个目录的文件名中得到一个资源变种列表以后，会使用两种方法之一选择可能的"最佳"变种返回给客户。使用Apache的内容协商功能并不需要了解其细节，以下文档对这些方法加以详细说明，供有兴趣的人看看。 协商有两种方法： 1. **使用Apache算法的服务器驱动协商** 是通常情况下的默认方法。使用这个算法(下面有详细的描述)，为了得到更好的效果，Apache有时会"打乱"一个特定变元(dimension)的品质因子，其方法稍后会详细阐述。 2. **透明内容协商** 仅当浏览器明确地用RFC2295中定义的机制发出请求时才使用。这种方法可以给予浏览器对"最佳"变种选择的完全控制，因此其效果也取决于浏览器使用的算法。作为透明协商过程的一部分，浏览器可以要求Apache执行RFC2296中定义的"远程变种选择算法"。 ### 协商的变元(Dimension) | 变元 | 说明 | | --- | --- | | 媒体类型 | 浏览器在`Accept`头中指明首选项，其中各项与品质因子关联，变种描述也可以有品质因子(参数"qs")。 | | 语言 | 浏览器在`Accept-Language`头中指明首选项，其中各项与品质因子关联，变种可以与零个、一个或多个语言关联。 | | 编码 | 浏览器在`Accept-Encoding`头中指明首选项，其中各项与品质因子关联。 | | 字符集 | 浏览器在`Accept-Charset`头中指明首选项，其中各项与品质因子关联，变种可以指定一个字符集作为媒体类型的一个参数。 | ### Apache协商算法 Apache使用下述算法选择可能的"最佳"变种返回给浏览器。此算法不能被再配置。其过程如下： 1. 首先，对每个协商变元，检查其适当的_Accept*_ 头，并对每个变种指定一个品质。如果一个变元的_Accept*_ 头指示不接受这个变种，则被剔除。如果最终没有变种了，则转到步骤4。 2. 顺序执行以下的测试，使用逐步剔除的方法来选择"最佳"变种。不能通过测试的变种将被剔除。每个测试完成后，如果仅剩一个变种，则作为最佳匹配，转到步骤3；如果多于一个，则继续下一个测试。 1. 将`Accept`头的品质因子乘以该变种媒体类型的还原品质因子，选择乘积最高者。 2. 选择语言品质因子最高的变种。 3. 使用`Accept-Language`头中的语言顺序(如果存在的话)，或者使用`LanguagePriority`指令中的语言顺序(如果存在的话)选择最匹配的语言。 4. 选择最高"等级"媒体参数的变种(用以确定text/html的媒体类型)。 5. 选择`Accept-Charset`头中指定的最佳字符集媒体参数的变种。如果没有明确指定，则使用ISO-8859-1字符集。具有`text/*` 媒体类型而没有明确地与一个特定字符集关联的变种，将使用ISO-8859-1。 6. 选择与之关联字符集_不是_ISO-8859-1的变种，如果没有这样的变种，则选择所有的变种。 7. 选择最佳编码的变种。如果存在用户代理可以接受的编码的变种，则选择之；否则，如果存在混合编码的或者未编码的变种，则选择未编码的变种。如果所有的变种都是编码的，或者所有变种都是未编码的，则选择所有的变种。 8. 选择内容长度最小的变种。 9. 选择剩余变种的最前一个，这个变种或是类型表文件中的第一个，或从目录中读取变种被时，以ASCII编码顺序的第一个文件。 3. 这时，此算法已经选择了一个"最佳"变种，并将之返回作为响应。HTTP响应头的`Vary`会指明协商的变元(浏览器和缓存可以利用此信息缓存该资源)。 4. 如果没有一个变种被选择(因为没有一种可以被浏览器接受)，则返回一个状态值为406响应体，并包含一个HTML格式的有效变种列表，同样，在HTTP头的`Vary`中指明了变种的变元。 ## 打乱品质值 Apache有时会改变按照Apache协商算法应该被严格解析的品质值，从而在浏览器没有发送完整的精确的信息时获得更好的效果。有些很常用的浏览器在许多情况下，会发送导致变种选择错误的`Accept`头信息。如果一个浏览器发送了完整的且正确的信息，则不会有打乱操作。 ### 媒体类型与通配符 `Accept:` 请求头指明了媒体类型的首选项，也可以包含"通配"媒体类型，如"image/*"和匹配任何字符串的"*/*"。所以，如果一个请求包含： ``` Accept: image/*, */* ``` 会指明可以接受任何以"image/"开头的类型，和其他任何类型(因而前面的"image/*"就是多余的)。有些浏览器就会这样例行公事地在明确指定允许的类型后面附加通配类型，比如： ``` Accept: text/html, text/plain, image/gif, image/jpeg, */* ``` 其目的是表明，明确列出的是首选项，其他不同的表现也可以。这种用法不是不可以，但是"*/*"其实可以通配所有其他类型，所以不推荐这样用，而应该对"*.*"赋予一个较低的品质(首选)值0.01，如： ``` Accept: text/html, text/plain, image/gif, image/jpeg, */*; q=0.01 ``` 明确指定的类型没有品质值，所以其品质值是默认的最高值1.0，而"*/*"是较低的0.01，所以，只有在没有匹配明确指定类型的变种时，才会返回其他类型。 如果`Accept:` 头_没有_指定任何q因子，那么Apache设置"*/*"的q值为0.01来模拟上述推荐的行为，还会设置"type/*"的q值为0.02，使之优先于"*/*"。如果`Accept:` 头中任何媒体类型指定了q因子，则_不会_使用这些特殊值，以使正确发送信息的浏览器能正常运作。 ### 语言协商的例外 在Apache 2.0中的协商算法中，新增了一些例外的规则，以允许在语言协商匹配失败的情况下，作巧妙的妥协。 通常，当客户端向服务器请求一个不能与浏览器`Accept-language`所匹配的唯一的页面时，服务器会返回一个"No Acceptable Variant" 或者 "Multiple Choices" 响应。但是，有可能通过配置Apache，忽略这些情况下的`Accept-language` ，而返回一个不是非常匹配客户请求的文本，以避免这些错误信息的出现。`ForceLanguagePriority`指令可以屏蔽这两种错误信息，并接管由`LanguagePriority`指令控制的服务器裁定机制。 服务器还会在匹配失败时尝试用语言子集来匹配。例如，如果一个客户请求了一个语言是`en-GB`的英国英语的页面，而服务器只支持HTTP/1.1标准的简单的`en` 。(注意，在`Accept-Language`中指定`en-GB`而不是`en`几乎绝对是个错误，因为它似乎暗示阅读的人懂英国英语却不懂大众英语。而不幸的是，许多流行的客户端的默认配置却是这样的)。如果没有可以匹配的语言，服务器将会忽略其语言子集的设定，返回"No Acceptable Variants"错误，或者按`LanguagePriority`指令作妥协。Apache会隐含地在客户可接受语言的列表中附加一个具有很低品质值的父语言，但是，如果客户请求"en-GB; q=0.9, fr; q=0.8" 那么将返回"fr"的文本，这对遵循HTTP/1.1标准以使正确配置的浏览器能正常工作是必须的。 为了支持用于确定用户首选语言的高级技术(比如cookies或特殊的URL路径)，从2.0.47版本起`mod_negotiation`模块开始支持`prefer-language`环境变量`模块将会尝试选择一个匹配的变种。如果不存在这样的变种，将会使用上述通常的协商过程。 ### 示例 ``` SetEnvIf Cookie "language=(.+)" prefer-language=$1 ``` ## 透明内容协商的扩展 Apache在变种列表中使用了一个新的`{encoding ..}`元素来标记变种，从而扩展了透明内容协商协议(RFC2295)。实现RVSA/1.0算法(RFC2296)的目的是识别列表中被编码的变种，作为可以被`Accept-Encoding`请求头接受的候选变种。在选择最佳变种之前，RVSA/1.0的实现不会对品质因子作四舍五入的运算。 ## 超链和名称转换说明 如果使用语言协商，由于文件可以有不止一个后缀，因此就可以选择不同的名称转换，其后缀顺序通常是无关紧要的(参见[mod_mime](#calibre_link-347)文档)。 一个典型的有MIME类型后缀的文件(如`html`)，其后缀可以是编码后缀(如`gz`)，也可以是语言变种后缀(如`en`) 例如： * foo.en.html * foo.html.en * foo.en.html.gz 文件名和有效及无效超链的例子： | 文件名 | 有效超链 | 无效超链 | | --- | --- | --- | | _foo.html.en_ | foo foo.html | - | | _foo.en.html_ | foo | foo.html | | _foo.html.en.gz_ | foo foo.html | foo.gz foo.html.gz | | _foo.en.html.gz_ | foo | foo.html foo.html.gz foo.gz | | _foo.gz.html.en_ | foo foo.gz foo.gz.html | foo.html | | _foo.html.gz.en_ | foo foo.html foo.html.gz | foo.gz | 可以看出，上表中使用没有任何后缀的超链(如`foo`)总是可行的，其优点是可以隐藏rsp. 文件的真实类型，而可以在将来作更改，比如，不用修改超链本身，而改变`html`为`shtml`或`cgi` 。 如果希望在超链中继续使用MIME类型(如`foo.html`)，则语言后缀(还包括一个编码后缀)必须出现在MIME类型后缀的右边(如`foo.html.en`)。 ## 缓冲说明 如果缓存中有一个与特定URL关联的表现形式(representation)，那么下一次该URL被请求时，缓存就可以使用它。但是，如果这个资源在服务器端是可协商的，则可能只有第一次请求的变种是正确的，而其后由于缓存中命中而取出的结果是错误的。为避免这种情况的发生，Apache通常把内容协商之后返回的响应标记为不可以被HTTP/1.1客户端缓冲。另外Apache还支持HTTP/1.1协议的功能以允许缓冲已协商的请求。 对来自HTTP/1.0客户端的请求(浏览器或缓存)，`CacheNegotiatedDocs`指令可以允许缓存服从协商的请求。此指令应该出现在主服务器或虚拟主机的配置中，没有参数，并且对来自HTTP/1.1客户端的请求没有影响。 对于遵守HTTP/1.1规范的客户端，Apache发送一个`Vary`应答头以指定该应答的协商变元。缓存可以使用这个信息来判断一个其后的请求是否可以从本地副本中提供服务。为了鼓励缓存使用本地副本而不是协商变元，请设置`force-no-vary`[环境变量](#calibre_link-556)。 ## 更多信息 更多有关内容协商的信息，可以参见Alan J. Flavell的[Language Negotiation Notes](http://ppewww.ph.gla.ac.uk/~flavell/www/lang-neg.html)，但是注意，此文档可能没有升级以包含Apache2.0中的改变。