Nginx伺服器常見配置清單備忘錄

CodeSheep發表於2021-09-26
Nginx伺服器

寫在前面

Nginx是高效能輕量級WEB伺服器的優秀代表，由於其提供HTTP代理和反向代理、負載均衡、快取等一系列重要特性，從而廣泛應用於當今的Web後端服務之中，而且各大網際網路公司也都在重度使用，所以作為一個開發者，學會Nginx的使用和配置很有必要。

在本文中，我們將會從一份示例配置清單開始，來簡單梳理一下Nginx伺服器的各種常見配置指令的作用和用法。

話不多說，上菜！

本文在GitHub開源倉庫「程式設計之路」 https://github.com/rd2coding/Road2Coding 中已經收錄，裡面有我整理的6大程式設計方向(崗位)的自學路線+知識點大梳理、面試考點、我的簡歷、幾本硬核pdf筆記，以及我的程式設計師人生，歡迎鑑賞。

Nginx配置檔案的整體結構

這裡直接畫一幅圖就一目瞭然了，幾個大的配置模組看得就很清楚。

從圖中可以看出主要包含以下幾大部分內容：

1. 全域性塊

該部分配置主要影響Nginx全域性，通常包括下面幾個部分：

  • 配置執行Nginx伺服器使用者（組）
  • worker程式數
  • Nginx程式PID存放路徑
  • 錯誤日誌的存放路徑
  • 配置檔案的引入
  • ...

2. events塊

該部分配置主要影響Nginx伺服器與使用者的網路連線，主要包括：

  • 設定網路連線的序列化
  • 是否允許同時接收多個網路連線
  • 事件驅動模型的選擇
  • 最大連線數的配置
  • ...

3. http塊

  • 定義MIMI-Type
  • 自定義服務日誌
  • 是否允許sendfile方式傳輸檔案
  • 連線超時時間
  • 單連線請求數上限
  • ...

4. server塊

  • 配置網路埠監聽
  • 訪問日誌和錯誤頁
  • 基於名稱的虛擬主機配置
  • 基於IP的虛擬主機配置
  • location塊配置
  • ...

5. location塊

  • location配置
  • 請求根目錄配置
  • 更改location的URI
  • 網站預設首頁配置
  • ...

一份配置清單例析

這裡給出了一份簡要的Nginx配置清單舉例：

配置程式碼如下：

user  nobody  nobody;
worker_processes  3;
error_log  logs/error.log;
pid  logs/nginx.pid;

events {
    use epoll;
    worker_connections  1024;
}


http {
    include       mime.types;
    default_type  application/octet-stream;

    log_format  main  '$remote_addr - $remote_user [$time_local] "$request" '
                      '$status $body_bytes_sent "$http_referer" '
                      '"$http_user_agent" "$http_x_forwarded_for"';
    access_log  logs/access.log  main;
    sendfile  on;
    keepalive_timeout  65;

    server {
        listen       8088;
        server_name  codesheep;
        access_log  /codesheep/webserver/server1/log/access.log;
        error_page  404  /404.html;

        location /server1/location1 {
            root   /codesheep/webserver;
            index  index.server2-location1.htm;
        }

        location /server1/location2 {
        root   /codesheep/webserver;
            index  index.server2-location2.htm;
        }

    }

    server {
        listen       8089;
        server_name  192.168.31.177;
        access_log  /codesheep/webserver/server2/log/access.log;
        error_page  404  /404.html;
        
        location /server2/location1 {
            root   /codesheep/webserver;
            index  index.server2-location1.htm;
        }

        location /srv2/loc2 {
            alias   /codesheep/webserver/server2/location2/;
            index  index.server2-location2.htm;
        }
        
        location = /404.html {
            root /codesheep/webserver/;
            index 404.html;
        }
        
    }

}

接下來就對照這份示例配置清單來詳細剖析一下配置檔案中幾個主要指令的含義及用法。

Nginx使用者(組)配置

配置項格式：user user [group];

  • user：指定可以執行Nginx的使用者
  • group：指定可以執行Nginx的使用者組（可選項）

如果user指令不配置或者配置為 user nobody nobody ，則預設所有使用者都可以啟動Nginx程式。

worker程式數配置

這是Nginx伺服器實現併發處理的關鍵配置，配置項格式為：

worker_processes number數;

  • number：Nginx程式最多可以產生的worker process數
  • 如果設定為auto，則Nginx將進行自動檢測

按照上文中的配置清單的實驗，我們給worker_processes配置的數目是：3，啟動Nginx伺服器後，我們可以後臺看一下主機上的Nginx程式情況：

ps -aux | grep nginx

很明顯，理解 worker_processes 這個指令的含義就很容易了

error日誌路徑配置

配置項格式：error_log file [可選日誌級別];

  • file：指定日誌輸出到某個檔案file
  • 常見的可選日誌級別包括：info、debug、warn、error...等

Nginx程式PID存放路徑配置

由於Nginx程式是作為系統守護程式在後臺執行，所以該選項用於自定義配置PID檔案的儲存路徑。

配置項格式：pid file;

  • file：指定其存放路徑+檔名稱
  • 如果不指定預設置於路徑 logs/nginx.pid

事件驅動模型配置

配置項格式：use model;

  • model模型可選擇項包括：select、poll、kqueue、epoll、rtsig等......

最大連線數配置

配置項格式：worker_connections number數;

  • number預設值為512，表示允許每一個worker程式可以同時開啟的最大連線數。

配置檔案的引入

該配置主要用於引入其他或者第三方的Nginx配置檔案到當前的主配置檔案中

配置項格式：include conf_file;

網路連線的序列化配置

配置項格式：accept_mutex on;

  • 該配置預設為on狀態，表示會對多個Nginx工作程式接收連線進行序列化，防止多個worker程式對連線的爭搶。

說到該指令，首先得闡述一下什麼是所謂的“驚群問題”。就Nginx的場景來解釋的話大致的意思就是：當一個新網路連線來到時，多個worker程式會被同時喚醒，但僅僅只有一個程式可以真正獲得連線並處理之。如果每次喚醒的程式數目過多的話，其實是會影響一部分效能的。

所以在這裡，如果accept_mutex on，那麼多個worker將是以序列方式來處理，其中有一個worker會被喚醒；反之若accept_mutex off，那麼所有的worker都會被喚醒，不過只有一個worker能獲取新連線，其它的worker會重新進入休眠狀態。

這個值的開關與否其實是要和具體場景掛鉤的，一定程度上會影響系統的吞吐量。Nginx預設開啟了accept_mutex，也算是一種保守的做法。

多網路連線 接收配置

配置項格式：multi_accept off;

  • 該配置預設為off，意指每個worker程式一次只能接收一個新到達的網路連線。如果想讓每個Nginx的worker process都能同時接收多個網路連線，則需要開啟此配置。

MIME-Type定義

MIME-Type指的是網路資源的媒體型別，也即前端請求的資源型別。

配置項格式：

include mime.types;

default_type type型別;
  • include配置用於將mime.types檔案包含進來

可以用cat mime.types 來檢視mime.types的檔案內容，我們發現其就是一個types結構，裡面包含了各種瀏覽器能夠識別的MIME型別以及對應型別的檔案字尾名，如下所示：

訪問日誌配置

配置項格式：

access_log path [format];
  • path：自定義訪問日誌的路徑+名稱
  • format：自定義服務日誌的格式（可選項）。

連線超時配置

配置項格式：keepalive_timeout timeout [header_timeout];

  • timeout 表示server端對連線的保持時間
  • header_timeout表示在應答報文頭部的 Keep-Alive 域設定超時時間，可選項。

sendfile配置

配置項格式：

sendfile on;
  • sendfile配置用於開啟或關閉使用sendfile()系統呼叫來傳輸檔案，預設off
  • 注：在很多Web Server中，都引入了 sendfile的機制，來實現高效能檔案傳輸。

網路地址監聽配置

配置項格式：

  • 第一種：配置監聽的IP地址：listen IP[:PORT];
  • 第二種：配置監聽的埠：listen PORT;

實際舉例：

listen 192.168.31.177:8080; # 監聽特定IP和埠上的連線
listen 192.168.31.177;      # 監聽特定IP上所有埠的連線
listen 8080;                # 監聽特定埠上的所有IP的連線

基於名稱或IP的虛擬主機配置

配置項格式：server_name name1 name2 ...

  • name可以有多個並列名稱，而且此處的name支援正規表示式書寫

實際舉例：

server_name ~^www\.codesheep\d+\.com$;

至於基於IP的虛擬主機配置就更簡單了：

配置項格式：server_name IP地址

location配置

配置項格式為：location [ = | ~ | ~* | ^~ ] /uri/ {...}

  • 這裡的uri可包含正規表示式的模糊匹配。

uri前面的方括號中的內容是可選項，幾種常見的情形如下：

  • “=”：用於標準uri，進行字串的精確匹配
  • “~”：用於正則uri，表示區分大小寫的匹配
  • “~*”：用於正則uri，表示不區分大小寫的匹配
  • “^~”：用於標準uri，^進行字首匹配，~表示區分大小寫

根目錄配置

配置項格式：root path;

  • path：表示Nginx接收到請求以後查詢資源的根目錄路徑

當然，也還可以通過alias指令來更改location接收到的URI請求路徑，指令為：

alias path;  # path為修改後的根路徑

預設首頁配置

配置項格式：index index_file ......

  • index_file可以包含多個用空格隔開的檔名，首先找到哪個頁面，就使用哪個進行響應。

後記

本文在GitHub開源倉庫「程式設計之路」 https://github.com/rd2coding/Road2Coding 中已經收錄，裡面有我整理的6大程式設計方向(崗位)的自學路線+知識點大梳理、面試考點、我的簡歷、幾本硬核pdf筆記，以及我的程式設計師人生，歡迎鑑賞。

下篇見！

相關文章