Module ngx_http_map_module

ngx_http_map_module模块创建变量,其值取决于其他变量的值。

Example Configuration

map $http_host $name {
    hostnames;

    default       0;

    example.com   1;
    *.example.com 1;
    example.org   2;
    *.example.org 2;
    .example.net  3;
    wap.*         4;
}

map $http_user_agent $mobile {
    default       0;
    "~Opera Mini" 1;
}

Directives

Syntax:map string $variable { ... }
Default:
Context:http

创建一个新变量,其值取决于第一个参数中指定的一个或多个源变量的值。

Note

在 0.9.0 版之前,只能在第一个参数中指定单个变量。

Note

由于仅在使用变量时才对它们进行求值,因此即使是大量“ map”变量的简单声明也不会为请求处理增加任何额外成本。

map块中的参数指定源值和结果值之间的映射。

源值指定为字符串或正则表达式(0.9.6)。

匹配字符串时忽略大小写。

对于大小写敏感的匹配,正则表达式应从“ ~”符号开始,对于大小写敏感的匹配,则应从“ ~*”符号(1.0.4)开始。正则表达式可以包含命名捕获和位置捕获,这些捕获可稍后与结果变量一起在其他指令中使用。

如果源值与下述特殊参数的名称之一匹配,则应在其前面加上“ \”符号。

结果值可以包含文本,变量(0.9.0)及其组合(1.11.0)。

还支持以下特殊参数:

  • default value

    • 如果源值与指定的变体都不匹配,则设置结果值。如果未指定default,则默认结果值为空字符串。
  • hostnames

    • 指示源值可以是带有前缀或后缀掩码的主机名:
*.example.com 1;
example.*     1;

以下两条记录

example.com   1;
*.example.com 1;

可以组合:

.example.com  1;

该参数应在值列表之前指定。

  • include file

    • 包括带有值的文件。可能有几个内含物。

volatile

  • 表示该变量不可缓存(1.11.7)。

如果源值匹配多个指定变体之一,例如无论是掩码匹配还是正则表达式匹配,都将按照以下优先级顺序选择第一个匹配变体:

  • 不带掩码的字符串值

  • 带有前缀掩码的最长字符串值,例如“ *.example.com

  • 带后缀掩码的最长字符串值,例如“ mail.*

  • 第一个匹配的正则表达式(按在配置文件中出现的顺序)

  • default value

Syntax:map_hash_bucket_size size;
Default:map_hash_bucket_size 32|64|128;
Context:http

设置map变量哈希表的存储区大小。默认值取决于处理器的缓存行大小。设置哈希表的详细信息在单独的document中提供。

Syntax:map_hash_max_size size;
Default:map_hash_max_size 2048;
Context:http

设置map个变量哈希表中的最大size个。设置哈希表的详细信息在单独的document中提供。