Nginx中常用的模块整理

Nginx 配置文件在线生成: https://nginxconfig.io/

# 第一部分 基础模块

# 一、性能相关配置

worker_processes number | auto；

worker进程的数量；通常应该为当前主机的cpu的物理核心数。多于8个的话建议写8，超过8个性能不会提升，稳定性降低

worker_cpu_affinity auto [cpumask] #将work进程绑定在固定cpu上提高缓存命中率 
# 例：
worker_cpu_affinity 0001 0010 0100 1000;
worker_cpu_affinity 0101 1010;

worker_priority number
# 指定worker进程的nice值，设定worker进程优先级： [-20,20]

worker_rlimit_nofile number
worker # 进程所能够打开的文件数量上限,默认较小，生产中需要调大如65535。系统资源通过配置修改/etc/security/limits.conf 例：root soft nofile 65535，或命令修改ulimit -n，修改后需重启服务或系统生效。

# 二、时间驱动events相关的配置

• 每个worker进程所能够打开的最大并发连接数数量，如10240
• 总最大并发数： worker_processes * worker_connections

worker_connections number

• 指明并发连接请求的处理方法,默认自动选择最优方法不用调整

use method
# 如：use epoll;

• on指由各个worker轮流处理新请求
• Off指每个新请求的到达都会通知(唤醒)所有的worker进程，但只有一个进程可获得连接，造成“惊群”，影响性能，默认on

# 处理新的连接请求的方法
accept_mutex on | off # 互斥；

# 三、http核心模块相关配置ngx_http_core_module

# 3.1web服务模板

server { ... }
# 配置一个虚拟主机
server {
    listen address[:PORT]|PORT;
    server_name SERVER_NAME; # 指令指向不同的主机名
    root /PATH/TO/DOCUMENT_ROOT;
} 

# 3.2套接字相关配置

listen address[:port] [default_server] [ssl] [http2 | spdy] [backlog=number] [rcvbuf=size] [sndbuf=size]

• default_server 设定为默认虚拟主机
• ssl 限制仅能够通过ssl连接提供服务
• backlog=number 超过并发连接数后，新请求进入后援队列的长度
• rcvbuf=size 接收缓冲区大小
• sndbuf=size 发送缓冲区大小

# 3.3 server_name

• 支持*通配任意长度的任意字符

server_name *.magedu.com www.magedu.*

• 支持~起始的字符做正则表达式模式匹配，性能原因慎用

server_name ~^www\d+\.magedu\.com$   #\d 表示 [0-9]

匹配优先级机制从高到低：

• 首先是字符串精确匹配 如： www.magedu.com
• 左侧*通配符 如： *.magedu.com
• 右侧*通配符 如： www.magedu.*
• 正则表达式 如： ~^.*\.magedu\.com$
• default_server

# 3.4 延迟发送选项

tcp_nodelay on | off;
tcp_nopush  on | off;

• 在keep alived模式下的连接是否启用TCP_NODELAY选项。
• tcp_nopush必须在sendfile为on时才有效，当为off时，延迟发送，合并多个请求后再发送
• 默认On时，不延迟发送
• 可用于： http, server, location

# 3.5 sendfile

sendfile on | off;

是否启用sendfile功能，在内核中封装报文直接发送。如用来进行下载等应用磁盘IO重负载应用可设置为off，以平衡磁盘与网络IO处理速度降低系统负载，如图片显示不正常把这个改为off。默认Off

# 3.6 隐藏版本信息

是否在响应报文的Server首部显示nginx版本

server_tokens on | off | build | string

# 3.7 location匹配

location [ = | ~ | ~* | ^~ ] uri { ... }
location @name { ... }

在一个server中location配置段可存在多个，用于实现从uri到文件系统的路径映射； ngnix会根据用户请求的URI来检查定义的所有location，并找出一个最佳匹配，而后应用其配置

server {...
    server_name www.magedu.com;
    location /images/ {
        root /data/imgs/;
        }
}
http://www.magedu.com/images/logo.jpg
--> /data/imgs/images/logo.jpg 

• =：对URI做精确匹配；
• ^~：对URI的最左边部分做匹配检查，不区分字符大小写
• ~：对URI做正则表达式模式匹配，区分字符大小写
• ~*：对URI做正则表达式模式匹配，不区分字符大小写 不带符号：匹配起始于此uri的所有的uri 匹配优先级从高到低：
• =, ^~, ～/～*, 不带符号

路径别名alias path

示例：

# http://www.magedu.com/bbs/index.php

location /bbs/ {
    alias /web/forum/;
} # --> /web/forum/index.html
location /bbs/ {
    root /web/forum/;
}     # --> /web/forum/bbs/index.html    

注意：

location中使用root指令和alias指令的意义不同

• root，相当于追加在root目录后面
• alias，相当于对location中的url进行替换

# 3.8 错误页面显示

error_page code ... [=[response]] uri;

模块：

ngx_http_core_module

• 定义错误页， 以指定的响应状态码进行响应
• 可用位置： http, server, location, if in location

error_page 404 /404.html
error_page 404 =200 /404.html  #防止404页面被劫持

# 3.9 长连接相关配置

keepalive_timeout timeout [header_timeout];

• 设定保持连接超时时长， 0表示禁止长连接， 默认为75s

keepalive_requests number;

• 在一次长连接上所允许请求的资源的最大数量，默认为100

keepalive_disable none | browser ...

• 对哪种浏览器禁用长连接

send_timeout time;

• 向客户端发送响应报文的超时时长，此处是指两次写操作之间的间隔时长，而非 整个响应过程的传输时长

# 3.10 请求报文缓存

client_body_buffer_size size;

用于接收每个客户端请求报文的body部分的缓冲区大小；默认为16k；超出此大小时，其将被暂存到磁盘上的由client_body_temp_path指令所定义的位置

client_body_temp_path path [level1 [level2 [level3]]];

设定用于存储客户端请求报文的body部分的临时存储路径及子目录结构和数量 目录名为16进制的数字；

client_body_temp_path /var/tmp/client_body 1 2 2

• 1级目录占1位16进制，即2^4=16个目录 0-f`
• 2级目录占2位16进制，即2^8=256个目录 00-ff
• 3级目录占2位16进制， 即2^8=256个目录 00--ff

# 3.11 对客户端进行限制相关配置

limit_rate rate;

限制响应给客户端的传输速率，单位是bytes/second 默认0表示无限制

limit_except method ... { ... }

仅用于location限制客户端使用除了指定的请求方法之外的其它方法 method:GET, HEAD, POST, PUT, DELETE，MKCOL, COPY, MOVE, OPTIONS, PROPFIND, PROPPATCH, LOCK, UNLOCK, PATCH

# 例：
limit_except GET {
    allow 192.168.1.0/24;
    deny all;
} 

除了GET和HEAD 之外其它方法仅允许192.168.1.0/24网段主机使用

# 四、访问控制模块ngx_http_access_module

实现基于ip的访问控制功能

allow address | CIDR | unix: | all;
deny address | CIDR | unix: | all;
http, server, location, limit_except

自上而下检查，一旦匹配，将生效，条件严格的置前

#示例：

location / {
    deny 192.168.1.1;
    allow 192.168.1.0/24;
    allow 10.1.1.0/16;
    allow 2001:0db8::/32;
    deny all;
}

# 五、用户认证模块ngx_http_auth_basic_module

实现基于用户的访问控制，使用basic机制进行用户认证

auth_basic string | off;
auth_basic_user_file file;
location /admin/ {
    auth_basic "Admin Area";
    auth_basic_user_file /etc/nginx/.ngxpasswd;
}

用户口令：

六、状态查看模块ngx_http_stub_status_module

用于输出nginx的基本状态信息

2. return

比较操作符：

示例1：