Nginx 如何自定義變量？

時間  2020-06-22
標籤 nginx 如何 自定義 變量 欄目 Nginx 简体版
原文   原文鏈接

以前的兩篇文章 Nginx 變量介紹以及利用 Nginx 變量作防盜鏈 講的是 Nginx 有哪些變量以及一個常見的應用。那麼如此靈活的 Nginx 怎麼能不支持自定義變量呢，今天的文章就來講一下自定義變量的幾個模塊以及 Nginx 的 keepalive 特性。nginx

經過映射新變量提供更多的可能性：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 賦不一樣的值。git

規則

  • 已有變量：string 須要是已有的變量，能夠分爲下面這三種狀況
    • 字符串
    • 一個或者多個變量
    • 變量與字符串的組合
  • case 規則：{...} 內的匹配規則須要遵循如下規則，尤爲是要注意當使用 hostnames 指令時，與 server name 的匹配規則是一致的，能夠看以前的文章 Nginx 的配置指令
    • 字符串嚴格匹配
    • 使用 hostnames 指令，能夠對域名使用前綴 * 泛域名匹配
    • ~ 和 ~* 正則表達式匹配，後者忽略大小寫
  • default 規則
    • 沒有匹配到任何規則時，使用 default
    • 確實 default 時，返回空字符串給新變量
  • 其餘
    • 使用 include 語法提高可讀性
    • 使用 volatile 禁止變量值緩存

你們看到上面這些規則可能都有些暈，廢話很少說，直接來看一個實戰配置文件就懂了。github

實戰

這裏咱們有一個配置文件，在這個文件裏面咱們定義了兩個 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 呢？咱們來看一下匹配順序。shell

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" http://split_clients.ziyang.com
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 刪除指定網絡

    geo $country {
    default ZZ;
    #include conf/geo.conf;
    #proxy 172.18.144.211; 
    127.0.0.0/24 US;
    127.0.0.1/32 RU;
    10.1.0.0/16 RU;
    192.168.1.0/24 UK;
}複製代碼

問題：如下命令執行時，變量 country 的值各爲多少？（proxy 實際上爲客戶端地址，這裏設置爲本機的局域網地址便可，我這裏是 172.18.144.211）

curl -H 'X-Forwarded-For: 10.1.0.0,127.0.0.2' geo.ziyang.com
curl -H 'X-Forwarded-For: 10.1.0.0,127.0.0.1' geo.ziyang.com
curl -H 'X-Forwarded-For: 10.1.0.0,127.0.0.1,1.2.3.4' geo.ziyang.com複製代碼

結果以下：

➜  test_nginx curl -H 'X-Forwarded-For: 10.1.0.0,127.0.0.2' geo.ziyang.com
US
➜  test_nginx curl -H 'X-Forwarded-For: 10.1.0.0,127.0.0.1' geo.ziyang.com
RU
➜  test_nginx curl -H 'X-Forwarded-For: 10.1.0.0,127.0.0.1,1.2.3.4' geo.ziyang.com
ZZ複製代碼

這裏能夠看出來，匹配規則其實是遵循最長匹配的規則的。

geoip 模塊

geoip 模塊能夠根據 IP 地址生成對應的地址變量，用法與前面的也都相似，Nginx 是基於 MaxMind 數據庫來生成對應的地址的。

  • 功能：根據 IP 地址建立新變量
  • 模塊：ngx_http_geoip_module，默認未編譯進 Nginx，經過 --with-http_geoip_module 禁用

使用這個模塊是須要安裝 MaxMind 庫的，安裝步驟以下：

  • 安裝 MaxMind 裏 geoip 的 C 開發庫（dev.maxmind.com/geoip/legac… ）
  • 編譯 Nginx 時帶上 --with-http_geoip_module 參數
  • 下載 MaxMind 中的二進制地址庫，這個地址庫是須要在指令中指定對應的地址的
  • 使用 geoip_country 或者 geoip_city 指令配置好 nginx.conf
  • 運行或者升級 Nginx

geoip_country 指令提供的變量

指令

Syntax: geoip_country file; # 指定國家類的地址文件
Default: —
Context: http

Syntax: geoip_proxy address | CIDR;
Default: —
Context: http複製代碼

變量

  • $geoip_country_code：兩個字母的國家代碼，好比 CN 或者 US
  • $geoip_country_code3：三個字母的國家代碼，好比 CHN 或者 USA
  • $geoip_country_name：國家名稱，例如 「China」, 「United States」

geoip_city 指令提供的變量

指令

Syntax: geoip_city file;
Default: —
Context: http複製代碼

變量

  • $geoip_latitude：緯度
  • $geoip_longitude：經度
  • $geoip_city_continent_code：位於全球哪一個洲，例如 EU 或 AS
  • 與 $geoip_country 指令生成的變量重疊
    • $geoip_country_code：兩個字母的國家代碼，好比 CN 或者 US
    • $geoip_country_code3：三個字母的國家代碼，好比 CHN 或者 USA
    • $geoip_country_name：國家名稱，例如 「China」, 「United States」
  • $geoip_region：洲或者省的編碼，例如 02
  • $geoip_region_name：洲或者省的名稱，例如 Zhejiang 或者 Saint Petersburg
  • $geoip_city：城市名
  • $geoip_postal_code：郵編號
  • $geoip_area_code：僅美國使用的郵編號，例如 408
  • $geoip_dma_code：僅美國使用的 DMA 編號，例如 807

keepalive 模塊

前面說的都是 Nginx 的變量相關的內容，其實 Nginx 還有一個很具備特點的模塊，那就是 keepalive 模塊，因爲內容不是不少，因此我就直接寫到這篇文章裏面了，單寫一篇顯得內容不夠哈。

這裏指的是 HTTP 的 keepalive，TCP 也有 keepalive，後面會說。

並且是對客戶端的 keepalive，不是對上游服務器的。

  • 功能：多個 HTTP 請求經過複用 TCP 鏈接，能夠實現如下功能：

    • 減小握手次數
    • 經過減小併發鏈接數減小了服務器資源消耗
    • 下降 TCP 擁塞控制的影響，保證滑動窗口維持在一個最優的大小

  • Connection 頭部

    • close：表示請求處理完就關閉鏈接
    • keepalive：表示複用鏈接處理下一條請求

  • Keepalive 頭部：timeout=n，單位是秒，表示鏈接至少保持 n 秒

指令

對客戶端行爲控制的指令：

Syntax: keepalive_disable none | browser ...;
Default: keepalive_disable msie6; 
Context: http, server, location

Syntax: keepalive_requests number;
Default: keepalive_requests 100; 
Context: http, server, location

Syntax: keepalive_timeout timeout [header_timeout];
Default: keepalive_timeout 75s; 
Context: http, server, location複製代碼
  • keepalive_disable 設置爲 none 表示對全部瀏覽器啓用 keepalive，msie6 表示在老版本 MSIE 上禁用 keepalive
  • keepalive_requests 設置容許保持 keepalive 的請求的數量
  • keepalive_timeout 表示超時時間

好了，關於 Nginx 的模塊介紹就已經所有介紹完了，有興趣的同窗能夠去翻我前面的系列文章。固然還有一部分重要的內容尚未介紹，那就是關於 Nginx 的反向代理和負載均衡部分，這塊我們單獨抽出來講，彆着急，立刻乾貨就出來。

本文首發於個人我的博客：iziyang.github.io，全部配置文件我已經放在了 Nginx 配置文件，你們能夠自取。

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程