跳转至

Nginx

本文记录 Nginx 的学习笔记。

*注:本文所有操作均在 Ubuntu 系统上进行。

基本概念

Nginx 是一种高性能的 Web 服务器,它不仅能「处理静态资源请求」,还能作为「流量分发中心」协调多种后端服务。它的一个重要特性是虚拟主机功能——即在同一台物理服务器上,通过不同的域名或端口同时提供多个网站或服务。这种机制让一台服务器仿佛拥有多重身份,为不同应用分别提供独立的访问入口。

在实现这些功能的过程中,Nginx 的核心思想并不是单纯地处理请求,而是「代理」。所谓代理,就是用户与真实服务器之间的中间层。它不直接生成内容,而是代表用户或服务器去请求、处理并转发数据。通过这种中间机制,Nginx 能够在客户端与后端之间完成高效的请求转发、缓存、访问控制与负载均衡等任务,使系统性能和安全性都得到显著提升。

换言之,Nginx 既能代表客户端向外部网络发起请求,也能代表服务器接收外部请求并统一调度。根据代理作用的方向不同,代理系统可分为「正向代理」与「反向代理」,这两种模式构成了现代网络架构中最重要的通信模式。

所谓正向代理,是「面向用户」的代理行为。用户并不直接访问目标服务器,而是通过代理服务器间接访问外部资源。典型例子就是 VPN 或公司内部的上网代理。用户只需连接代理服务器,由代理替他/她去访问外部网站,再将结果返回给用户。这种方式不仅能突破访问限制,还能隐藏用户的真实 IP,从而实现一定程度的匿名访问。下图展示了正向代理的工作逻辑:

正向代理工作逻辑

而反向代理则恰好相反,它是「面向服务器」的代理行为。客户端并不知道自己访问的是哪一台具体的后端主机,所有请求都先交给代理服务器(例如 Nginx 或 Apache),由它再根据规则分发到内部真实的业务服务器。这样做的好处非常多:一方面可以实现「负载均衡」,即自动分配请求,避免某一台后端过载;另一方面也能实现「安全防护」,即隐藏内部结构、阻挡恶意访问;同时还能利用「缓存机制」和「连接复用」提升整体性能和响应速度。下图展示了反向代理的工作逻辑:

反向代理工作逻辑

因此,从架构层面看,Nginx 并不仅仅是一台服务器,更是一个网络流量的调度器。它通过灵活的代理机制,将复杂的分布式服务整合在一起,使系统既高效又可靠。

下载安装

下面分别介绍「基于包管理器」和「基于源码编译」两种 Nginx 安装方式,前者更稳定,后者更适合尝鲜新功能,读者可根据使用场景自行选择安装方式。

基于包管理器安装

在 Ubuntu 上,我们可以使用以下命令安装 Nginx:

apt update && apt install nginx

使用命令 whereis nginx 查看安装路径,输出:

nginx: /usr/sbin/nginx /usr/lib/nginx /etc/nginx /usr/share/nginx /usr/share/man/man8/nginx.8.gz

可以看到一共有 5 个位置:

位置 图示 解释
/usr/sbin/nginx /usr/sbin/nginx nginx 二进制文件。初始启动时需要进入该目录并执行 ./nginx
/usr/lib/nginx /usr/lib/nginx nginx 的所有共享对象 (shared objects, so) 模块,即 动态库
/etc/nginx /etc/nginx nginx 的配置文件目录
/usr/share/nginx /usr/share/nginx nginx 的一些静态资源,同时软链接到模块依赖文件
/usr/share/man/man8/nginx.8.gz /usr/share/man/man8/nginx.8.gz nginx 的使用说明文件

基于源码编译安装

进入 Nginx 官网 并找到 Nginx 的下载链接:

找到 Nginx 的下载链接

下载 Nginx 的安装包:

wget https://nginx.org/download/nginx-1.24.0.tar.gz

下载后进行解压:

tar -zxvf nginx-1.24.0.tar.gz
cd /home/nginx-1.24.0/

Ubuntu 安装 Nginx 前可以根据需要额外安装一些第三方库:

1
2
3
4
5
6
7
8
# 正则表达式库
apt install libpcre3 libpcre3-dev  

# gzip格式压缩库
apt install zlib1g-dev

# SSL 协议库
apt install openssl libssl-dev 

设置 Nginx 的安装配置:

1
2
3
4
5
6
7
./configure \
    # 安装的路径(根据自己的偏好修改)
    --prefix=/usr/local/nginx-1.24.0 \
    # 安装 ssl 模块
    --with-http_ssl_module \
    # 安装查看 nginx 的客户端状态模块
    --with-http_stub_status_module

编译并安装:

make && make install

进入安装目录并启动 Nginx:

cd /usr/local/nginx-1.24.0/sbin/
./nginx

常用命令

nginx -?,-h

我们用 nginx -hnginx -? 来查看当前 Nginx 的版本和全部的指令简介:

nginx version: nginx/1.18.0 (Ubuntu)
Usage: nginx [-?hvVtTq] [-s signal] [-c filename] [-p prefix] [-g directives]

Options:
  -?,-h         : this help
  -v            : show version and exit
  -V            : show version and configure options then exit
  -t            : test configuration and exit
  -T            : test configuration, dump it and exit
  -q            : suppress non-error messages during configuration testing
  -s signal     : send signal to a master process: stop, quit, reopen, reload
  -p prefix     : set prefix path (default: /usr/share/nginx/)
  -c filename   : set configuration file (default: /etc/nginx/nginx.conf)
  -g directives : set global directives out of configuration file

nginx -v

我们用 nginx -v 来查看当前 Nginx 的版本信息,往往用来检测 Nginx 是否安装成功:

nginx version: nginx/1.18.0 (Ubuntu)

nginx -V

我们用 nginx -V 来查看当前 Nginx 版本信息,同时显示配置信息,往往用来查看配置文件的存放路径:

1
2
3
4
nginx version: nginx/1.18.0 (Ubuntu)
built with OpenSSL 3.0.2 15 Mar 2022
TLS SNI support enabled
configure arguments: --with-cc-opt='-g -O2 -ffile-prefix-map=/build/nginx-zctdR4/nginx-1.18.0=. -flto=auto -ffat-lto-objects -flto=auto -ffat-lto-objects -fstack-protector-strong -Wformat -Werror=format-security -fPIC -Wdate-time -D_FORTIFY_SOURCE=2' --with-ld-opt='-Wl,-Bsymbolic-functions -flto=auto -ffat-lto-objects -flto=auto -Wl,-z,relro -Wl,-z,now -fPIC' --prefix=/usr/share/nginx --conf-path=/etc/nginx/nginx.conf --http-log-path=/var/log/nginx/access.log --error-log-path=/var/log/nginx/error.log --lock-path=/var/lock/nginx.lock --pid-path=/run/nginx.pid --modules-path=/usr/lib/nginx/modules --http-client-body-temp-path=/var/lib/nginx/body --http-fastcgi-temp-path=/var/lib/nginx/fastcgi --http-proxy-temp-path=/var/lib/nginx/proxy --http-scgi-temp-path=/var/lib/nginx/scgi --http-uwsgi-temp-path=/var/lib/nginx/uwsgi --with-compat --with-debug --with-pcre-jit --with-http_ssl_module --with-http_stub_status_module --with-http_realip_module --with-http_auth_request_module --with-http_v2_module --with-http_dav_module --with-http_slice_module --with-threads --add-dynamic-module=/build/nginx-zctdR4/nginx-1.18.0/debian/modules/http-geoip2 --with-http_addition_module --with-http_gunzip_module --with-http_gzip_static_module --with-http_sub_module

按照上面的内容分行介绍:

# 版本信息
nginx version: nginx/1.18.0 (Ubuntu)    # 运行在 Ubuntu 系统上的 nginx 且版本为 1.18.0

# 编译选项
built with OpenSSL 3.0.2 15 Mar 2022    # 使用了 OpenSSL 3.0.2 进行构建,构建日期为 2022 年 3 月 15 日
TLS SNI support enabled                 # 启用了 TLS SNI 支持,这是支持多个域名共享一个 IP 地址的技术

# 配置参数
configure arguments: 

# 编译器选项
--with-cc-opt='
    -g                        # 在编译过程中生成调试信息
    -O2                       # 启用优化等级 2,以提高编译后代码的执行效率

    # 指定了一个文件路径映射,用于在编译时将文件路径中的指定前缀替换成另一个前缀
    -ffile-prefix-map=/build/nginx-zctdR4/nginx-1.18.0=. 

    -flto=auto                       # 启用链接时优化 (Link Time Optimization),以在链接阶段进一步优化代码
    -ffat-lto-objects                # 生成链接时优化的对象文件
    -fstack-protector-strong         # 启用强栈保护机制,以保护程序免受栈溢出攻击
    -Wformat -Werror=format-security # 开启对格式化字符串的检查,并将格式化字符串的安全性问题视为错误
    -fPIC                            # 生成位置无关代码,通常用于动态链接库的编译
    -Wdate-time                      # 生成有关日期时间的警告
    -D_FORTIFY_SOURCE=2              # 启用堆栈和字符串长度检查,用于提高程序的安全性
'

# 链接器选项
--with-ld-opt='
    -Wl,-Bsymbolic-functions         # 通过 --export-dynamic 在 ELF 输出中创建动态符号表
    -flto=auto                       # 启用链接时优化
    -ffat-lto-objects                # 生成链接时优化的对象文件
    -Wl,-z,relro                     # 在可执行文件中启用 RELRO (Relocation Read-Only),以增加对 GOT (Global Offset Table) 的保护
    -Wl,-z,now                       # 立即解析动态链接库,以减少动态链接的时间延迟
    -fPIC                            # 同样是为了生成位置无关代码,以支持动态链接
'

--prefix=/usr/share/nginx                          # Nginx 的安装路径
--conf-path=/etc/nginx/nginx.conf                  # 主配置文件的路径
--http-log-path=/var/log/nginx/access.log          # 访问日志的路径
--error-log-path=/var/log/nginx/error.log          # 错误日志的路径
--lock-path=/var/lock/nginx.lock                   # 锁文件的路径
--pid-path=/run/nginx.pid                          # 进程 ID 文件的路径
--modules-path=/usr/lib/nginx/modules              # Nginx 模块的路径

# 不同类型临时文件的存储路径
--http-client-body-temp-path=/var/lib/nginx/body 
--http-fastcgi-temp-path=/var/lib/nginx/fastcgi 
--http-proxy-temp-path=/var/lib/nginx/proxy 
--http-scgi-temp-path=/var/lib/nginx/scgi 
--http-uwsgi-temp-path=/var/lib/nginx/uwsgi 

--with-compat 
--with-debug                      # 启用了调试模式
--with-pcre-jit                   # 启用了 PCRE JIT 编译优化
--with-http_ssl_module            # 启用了 SSL 模块,用于支持 HTTPS
--with-http_stub_status_module    # 启用了状态模块,可以通过访问某个 URL 获取 Nginx 的状态信息
--with-http_realip_module         # 启用了 RealIP 模块,用于获取客户端真实 IP 地址
--with-http_auth_request_module   # 启用了 Auth Request 模块,用于在访问某个页面之前执行认证请求
--with-http_v2_module             # 启用了 HTTP/2 模块
--with-http_dav_module            # 启用了 WebDAV 模块
--with-http_slice_module          # 启用了 Slice 模块,用于分片传输
--with-threads                    # 启用了多线程支持

# 添加了 GeoIP2 模块,用于根据 IP 地址获取地理位置信息
--add-dynamic-module=/build/nginx-zctdR4/nginx-1.18.0/debian/modules/http-geoip2 

# 启用了额外的 HTTP 模块
--with-http_addition_module      # 用于添加内容
--with-http_gunzip_module        # 用于解压缩内容
--with-http_gzip_static_module   # 用于静态压缩内容
--with-http_sub_module           # 用于替换响应内容

nginx -t

我们用 nginx -t 来测试配置文件是否格式正确。

1)成功时,输出成功信息:

nginx: the configuration file /etc/nginx/nginx.conf syntax is ok
nginx: configuration file /etc/nginx/nginx.conf test is successful

2)失败时,输出报错内容:

nginx: [emerg] directive "include" is not terminated by ";" in /etc/nginx/nginx.conf:6
nginx: configuration file /etc/nginx/nginx.conf test failed

nginx -T

我们用 nginx -T 来测试配置文件是否格式正确,同时将所有的配置信息输出到屏幕上。我们可以对输出信息转存用来备份配置。

1
2
3
4
5
nginx: the configuration file /etc/nginx/nginx.conf syntax is ok
nginx: configuration file /etc/nginx/nginx.conf test is successful

# 所有配置信息
...

nginx -q

我们用 nginx -q 来测试配置,与 -t-T 不同的是,该命令不会显示非错误信息从而简化输出。

nginx: [emerg] bind() to 0.0.0.0:80 failed (98: Unknown error)
nginx: [emerg] bind() to [::]:80 failed (98: Unknown error)
nginx: [emerg] bind() to 0.0.0.0:80 failed (98: Unknown error)
nginx: [emerg] bind() to [::]:80 failed (98: Unknown error)
nginx: [emerg] bind() to 0.0.0.0:80 failed (98: Unknown error)
nginx: [emerg] bind() to [::]:80 failed (98: Unknown error)
nginx: [emerg] bind() to 0.0.0.0:80 failed (98: Unknown error)
nginx: [emerg] bind() to [::]:80 failed (98: Unknown error)
nginx: [emerg] bind() to 0.0.0.0:80 failed (98: Unknown error)
nginx: [emerg] bind() to [::]:80 failed (98: Unknown error)
nginx: [emerg] still could not bind()

nginx -s <signal>

我们用 nginx -s <signal> 相关指令来对控制 Nginx 的 master 进程。例如:

  • nginx -s stop:停止 Nginx 服务器,使其不再处理新的请求,并且关闭已有的连接;
  • nginx -s quit:优雅地关闭 Nginx 服务器。与 stop 信号不同,quit 信号会等待当前请求处理完毕后再关闭服务器,这样可以确保不丢失任何已接收但未处理完的请求;
  • nginx -s reopen:重新打开 Nginx 的日志文件。重新打开日志文件可以在不重启 Nginx 的情况下切换日志文件,这在日志轮换时非常有用;
  • nginx -s reload:重新加载 Nginx 的配置文件,而无需停止服务器。这使得在不停止服务的情况下更新配置成为可能,可以避免中断用户的访问;
  • nginx -p <prefix>:配置 Nginx 的工作路径;
  • nginx -c <filename>:指定 Nginx 的配置文件路径;
  • nginx -g <directives>:指定全局指令而不会写入配置文件中。

常见配置

所有的配置修改后,都需要使用 nginx -s reload 命令重启 Nginx。

静态网站配置

访问 http://www.example.com 时,访问静态网站:

1
2
3
4
5
6
7
8
9
server {
    listen       80;               # 监听的端口
    server_name  www.example.com;  # 监听的域名

    # 静态网站路径
    location / {
        root /home/web/www;        # 网站根目录
    }
}

访问 http://example.com 时,通过重定向的方式也访问静态网站:

1
2
3
4
5
6
7
8
9
server {
    listen       80;               # 监听的端口
    server_name  example.com;      # 监听的域名

    # 重定向到 www.example.com
    location / {
        proxy_pass  https://www.example.com  
    }
}

带端口的网站配置

1
2
3
4
5
6
7
8
server {
    listen 80;
    server_name example.com www.example.com;

    location / {
        proxy_pass http://localhost:5000/;  # 转发到 5000 端口对应的进程上
    }
}

启用 HTTPs 服务

如果需要向外提供 HTTPs 服务,首先需要准备一个 SSL 证书,将证书的 pem 文件和 key 文件上传到服务器后,对 Nginx 进行以下配置:

server {
    listen 443 ssl;
    server_name example.com;  # 自定义

    ssl_certificate      /etc/nginx/ssl/example.com.pem;  # 自定义
    ssl_certificate_key  /etc/nginx/ssl/example.com.key;  # 自定义

    ssl_session_cache    shared:SSL:1m;
    ssl_session_timeout  5m;
    ssl_ciphers  HIGH:!aNULL:!MD5;
    ssl_prefer_server_ciphers  on;

    location / {
        root /home/web/example;  # 自定义
    }
}

HTTP 自动跳转 HTTPs

添加一个 server 块专门监听 http 协议默认的 80 端口:

1
2
3
4
5
server {
    listen 80;
    server_name example.com;
    return 301 https://$host$request_uri;
}

配置最大请求体

当客户端的请求超过一定大小时,通过 Nginx 代理的服务会拒绝该请求,并响应 "413 Request Entity Too Large"。这是因为 Nginx 默认只给 1 MB 的请求大小。

我们可以通过 client_max_body_size 参数来配置客户端的最大请求体积。该参数作用域为 httpserverlocation

示例配置:

1
2
3
4
location / {
    client_max_body_size 20m;  # 约束最大请求体积为 20 MB
    proxy_pass http://localhost:1314;
}