Nginx map 使用方法

map指令是ngx_http_map_module模块提供的,默认情况下nginx有加载这个模块,除非手动--without-http_map_module

ngx_http_map_module模块可以创建变量,这些变量的值与另外的变量值相关联。允许分类或者同时映射多个值到多个不同值并储存到一个变量中,map指令用来创建变量,但是仅在变量被接受的时候执行视图映射操作,对于处理没有引用变量的请求时,这个模块并没有性能上的缺失。

语法: map $var1 $var2 {…}

默认值: -

配置段: http

map为一个变量设置的映射表。映射表由两列组成,匹配模式和对应的值。

在map块里的参数指定了源变量值和结果值的对应关系。

匹配模式可以是一个简单的字符串或者正则表达式,使用正则表达式要用(‘~’)。

一个正则表达式如果以“~”开头,表示这个正则表达式对大小写敏感。以“~*”开头,表示这个正则表达式对大小写不敏感。

1
2
3
4
5
map $http_user_agent $agent {
default "";
~curl curl;
~*apachebench" ab;
}

正则表达式里可以包含命名捕获和位置捕获,这些变量可以跟结果变量一起被其它指令使用。

1
2
3
4
5
map $uri $value {
/dingmingk_com /index.php;
~^/dingmingk_com/(?<suffix>.*)$ /boy/;
~/fz(/.*) /index.php?;
}

不能在map块里面引用命名捕获或位置捕获变量
~^/dingmingk_com/(.*) /boy/$1; 这样会报错`nginx:[emerg] unknown variable。

如果源变量值包含特殊字符如’~’,则要以’\’来转义。

1
2
3
4
map $http_referer $value {
Mozilla 111;
\~Mozilla 222;
}

如果变量可以是一个字符串也可以是另外一个变量。

1
2
3
4
map $num $limit {
1 $binary_remote_addr;
0 "";
}

map指令有三个参数:

  • default: 没有匹配结果将使用的默认值。如果没有设置default,将会用一个空的字符串作为默认的结果。
  • hostnames: 允许用前缀或者后缀掩码指定域名作为源变量值,这个参数必须写在映射列表的最前面。
  • include: 包含一个或多个含有映射值的文件。

如果匹配到多个特定的变量,如掩码和正则同时匹配,那么会按照下面的顺序进行选择:

  1. 没有掩码的字符串
  2. 最长的带前缀的字符串,如“*.example.com”
  3. 最长的带后缀的字符串,如“mail.*”
  4. 按顺序第一个先匹配的正则表达式(在配置文件中体现的顺序)
  5. 默认值

语法: map_hash_bucket_size size;

默认值: 32,64,128

配置段: http

指定一个映射表中的变量在哈希表中的最大值,这个值取决于处理器的缓存。

语法: map_hash_max_size size;

默认值: 2048

配置段: http

设置映射表对应的哈希表的最大值。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
http {
map $http_user_agent $agent {
~curl curl;
~*chrome chrome;
}
server {
listen 80;
server_name test.dingmingk.com;
location /hello {
default_type text/plain;
echo http_user_agent: $http_user_agent;
echo agent: agent:$agent;
}
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
http {
map $uri $match {
~^/hello/(.*) http://www.dingmingk.com/;
}
server {
listen 80;
server_name test.dingmingk.com;
location /hello {
default_type text/plain;
echo uri: $uri;
echo match: $match;
echo capture: $1;
echo new: $match$1;
}
}
}