Nginx 如何自定义变量?

之前的两篇文章 Nginx 变量介绍以及利用 Nginx 变量做防盗链 讲的是 Nginx 有哪些变量以及一个常见的应用。那么如此灵活的 Nginx 怎么能不支持自定义变量呢,今天的文章就来说一下自定义变量的几个模块以及 Nginx 的 keepalive 特性。

通过映射新变量提供更多的可能性:map 模块

功能:基于已有变量,使用类似 switch {case: … default: …} 的语法创建新变量,为其他基于变量值实现功能的模块提供更多的可能性

模块:ngx_http_map_module 默认编译进 Nginx,通过 --without-http_map_module 禁用

指令 Syntax: map string $variable { ... } Default: — Context: http Syntax: map_hash_bucket_size size; Default: map_hash_bucket_size 32|64|128; Context: http Syntax: map_hash_max_size size; Default: map_hash_max_size 2048; Context: http

我们主要看一下 map string $variable { ... } 这个指令。所谓类似 switch case 的语法是指,string 的值可以有多个,可以根据 string 值的不同,来给 $variable 赋不同的值。

规则

已有变量:string 需要是已有的变量,可以分为下面这三种情况

字符串

一个或者多个变量

变量与字符串的组合

case 规则:{...} 内的匹配规则需要遵循以下规则,尤其是要注意当使用 hostnames 指令时,与 server name 的匹配规则是一致的,可以看之前的文章 Nginx 的配置指令

字符串严格匹配

使用 hostnames 指令,可以对域名使用前缀 * 泛域名匹配

~ 和 ~* 正则表达式匹配,后者忽略大小写

default 规则

没有匹配到任何规则时,使用 default

确实 default 时,返回空字符串给新变量

其他

使用 include 语法提升可读性

使用 volatile 禁止变量值缓存

大家看到上面这些规则可能都有些晕,废话不多说,直接来看一个实战配置文件就懂了。

实战

这里我们有一个配置文件,在这个文件里面我们定义了两个 map 块,分别配置了两个变量,$name 和 $mobile,$name 中包含 hostnames 指令。

map $http_host $name { hostnames; default 0; ~map\.ziyang\w+\.org.cn 1; *.ziyang.org.cn 2; map.ziyang.com 3; map.ziyang.* 4; } map $http_user_agent $mobile { default 0; "~Opera Mini" 1; } server { listen 10001; default_type text/plain; location /{ return 200 '$name:$mobile\n'; } }

下面看一下实际的请求:

➜ test_nginx curl -H "Host: map.ziyang.org.cn" 127.0.0.1:10001 2:0

为什么会返回 2:0 呢?我们来看一下匹配顺序。

map.ziyang.org.cn 有三个规则可以生效,分别是:

~map.ziyang\w+.org.cn 1;

*.ziyang.org.cn 2;

map.ziyang.* 4;

而泛域名是优先于正则表达式的,* 在前的泛域名优先于在后面的泛域名,因此最终匹配到的就是:

*.ziyang.org.cn 2;

而第二个变量 $mobile 自然走的是 default 规则,不用多说。

这就是 map 模块的作用,大家可以多尝试一下。

下面再来看一个与 map 模块有点类似的 split_clients 模块,这个模块也是通过生成新的变量来完成 AB 测试功能的,它可以按照变量的值,按照百分比的方式,生成新的变量。

实现 AB 测试:split_clients 模块

功能:基于已有变量创建新变量,为其他 AB 测试提供更多的可能性

对已有变量的值执行 MurmurHash2 算法,得到 32 位整形哈希数字,记为 hash

32 位无符号整形的最大数字 2^32-1,记为 max

哈希数字与最大数字相除,hash/max,可以得到百分比 percent

配置指令中指示了各个百分比构成的范围,如 0-1%,1%-5% 等,及范围对应的值

当 percent 落在哪个范围里,新变量的值就对应着其后的参数

模块:ngx_http_split_clients_module,默认编译进 Nginx,通过 --without-http_split_clients_module 禁用

规则

已有变量

字符串

一个或者多个变量

变量与字符串的组合

case 规则:

xx.xx%,支持小数点后 2 位,所有项的百分比相加不能超过 100%

*,由它匹配剩余的百分比(100% 减去以上所有项相加的百分比)

指令 Syntax: split_clients string $variable { ... } Default: — Context: http

split_clients 的指令与 map 是非常相似的,可以看一下前面的介绍,这里不再赘述了。

下面这个配置,来看下有没有啥问题:

split_clients "${http_testcli}" $variant { 0.51% .one; 20.0% .two; 50.5% .three; 40% .four; * ""; }

细心的同学可能已经发现了,所有的百分比相加已经超过了 100%,所以 Nginx 直接会抛出一个错误,禁止执行。

➜ test_nginx ./sbin/nginx -s reload nginx: [emerg] percent total is greater than 100% in /Users/mtdp/myproject/nginx/test_nginx/conf/example/17.map.conf:31

然后将 40% .four; 这一行给屏蔽掉再试试看:

➜ test_nginx curl -H "testcli: split_clients.ziyang.com" --resolve "split_clients.ziyang.com:80:127.0.0.1" ABtestfile.three

正常执行。

geo 模块

geo 模块与前面两个模块也很相似,不同之处在于,这个模块是基于 IP 地址或者子网掩码这样的变量值来生成新的变量的。

功能:根据 IP 地址创建新变量

模块:ngx_http_geo_module,默认编译进 Nginx,通过 --without-http_geo_module 禁用

指令

Syntax: geo [$address] $variable { ... } Default: — Context: http 规则

如果 geo 指令后不输入 $address,那么默认使用 $remote_addr 变量作为 IP 地址

{} 内的指令匹配:优先最长匹配

通过 IP 地址及子网掩码的方式,定义 IP 范围,当 IP 地址在范围内时新变量使用其后的参数值

default 指定了当以上范围都未匹配上时,新变量的默认值

通过 proxy 指令指定可信地址(参考 realip 模块),此时 remote_addr 的值为 X-Forwarded-For 头部值中最后一个 IP 地址

proxy_recursive 允许循环地址搜索

include,优化可读性

delete 删除指定网络

内容版权声明:除非注明,否则皆为本站原创文章。

转载注明出处:https://www.heiqu.com/zyydxf.html