Nginx 如何自定義變數？

来源:https://www.cnblogs.com/iziyang/archive/2020/06/21/13171568.html
-Advertisement-
Play Games

之前的兩篇文章 Nginx 變數介紹以及利用 Nginx 變數做防盜鏈 講的是 Nginx 有哪些變數以及一個常見的應用。那麼如此靈活的 Nginx 怎麼能不支持自定義變數呢，今天的文章就來說一下自定義變數的幾個模塊以及 Nginx 的 keepalive 特性。 通過映射新變數提供更多的可能性：m ...


之前的兩篇文章 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" 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


結果如下：

```shell
➜  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 開發庫（https://dev.maxmind.com/geoip/legacy/downloadable/ ）
  • 編譯 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 配置文件，大家可以自取。


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • Task.Result跟 Task.GetAwaiter.GetResult()相同嗎？怎麼選？
    前幾天在用線程池執行一些任務時運到一種情形，就是回調方法中使用到了非同步方法，但是回調方法貌似不支持async await的寫法。這時候我應該如何處理呢？是使用Task.Result來獲取返回結果，還是使用GetAwaiter.GetResult()呢？本文就來探討下吧。 作者：依樂祝 原文地址：ht ...
  • C/S C# WPF銳浪報表教程
    前言：銳浪報表是一種中國式報表的報表開發工具。博主使用銳浪報表有一段時間了，積累了一些經驗希望能幫助你快速掌握並使用 第一章：集成項目 首先我們先去銳浪報表官網下載並安裝銳浪報表。 創建WPF應用程式。（C/S端使用銳浪報表基本都一樣） 添加銳浪報表的引用，在資源管理器目錄中找到引用並右鍵，點擊添加 ...
  • 《痞子衡嵌入式半月刊》 第 10 期
    這裡分享嵌入式領域有用有趣的項目/工具以及一些熱點新聞，農曆年分二十四節氣，希望在每個交節之日準時發佈一期。 ...
  • 007.OpenShift管理應用部署
    一 REPLICATION CONTROLLERS 1.1 RC概述 RC確保pod指定數量的副本一直運行。如果pod被殺死或被管理員顯式刪除，複製控制器將自動部署相應的pod。類似地，如果運行的pod數量超過所需的數量，它會根據需要刪除pod，以匹配指定的副本計數。 RC的定義主要包括: 所需的副 ...
  • CentOS安裝oh-my-zsh並配置語法高亮和命令自動補全
    安裝zsh 和 oh-my-zsh安裝zshyum install zsh安裝gityum install git切換預設shellchsh -s /bin/zshclone from GitHubgit clone git://github.com/robbyrussell/oh-my-zsh.g... ...
  • 寓教於樂！一款游戲讓你成為 Vim 高手！
    我們都知道，Vim 是 Linux 下一種非常重要的文本編輯器，我們可以用它來看代碼、改代碼，很多高手直接將 Vim 打造成一款強大的 IDE 用來寫代碼。 但是，對於新手而言，Vim 相對於其它編輯器而言，更難入門。Vim 是無圖形界面的編輯器，一切操作全靠指令，而且指令又非常多非常雜，學習起來非 ...
  • Docker Dockerfile 指令詳解與實戰案例
    Dockerfile介紹及常用指令，包括FROM，RUN，還提及了 COPY，ADD，EXPOSE，WORKDIR等，其實 Dockerfile 功能很強大，它提供了十多個指令。 ...
  • 006.OpenShift持久性存儲
    一 持久存儲 1.1 持久存儲概述 預設情況下，運行容器使用容器內的臨時存儲。Pods由一個或多個容器組成，這些容器一起部署，共用相同的存儲和其他資源，可以在任何時候創建、啟動、停止或銷毀。使用臨時存儲意味著，當容器停止時，寫入容器內的文件系統的數據將丟失。 當容器在停止時也需要持久的保存數據時，O ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類