前言

大家好，我是老马。很高兴遇到你。

我们为 java 开发者实现了 java 版本的 nginx

https://github.com/houbb/nginx4j

如果你想知道 servlet 如何处理的，可以参考我的另一个项目：

手写从零实现简易版 tomcat minicat

手写 nginx 系列

如果你对 nginx 原理感兴趣，可以阅读：

从零手写实现 nginx-01-为什么不能有 java 版本的 nginx?

从零手写实现 nginx-02-nginx 的核心能力

从零手写实现 nginx-03-nginx 基于 Netty 实现

从零手写实现 nginx-04-基于 netty http 出入参优化处理

从零手写实现 nginx-05-MIME类型（Multipurpose Internet Mail Extensions，多用途互联网邮件扩展类型）

从零手写实现 nginx-06-文件夹自动索引

从零手写实现 nginx-07-大文件下载

从零手写实现 nginx-08-范围查询

从零手写实现 nginx-09-文件压缩

从零手写实现 nginx-10-sendfile 零拷贝

从零手写实现 nginx-11-file+range 合并

从零手写实现 nginx-12-keep-alive 连接复用

从零手写实现 nginx-13-nginx.conf 配置文件介绍

从零手写实现 nginx-14-nginx.conf 和 hocon 格式有关系吗？

从零手写实现 nginx-15-nginx.conf 如何通过 java 解析处理？

从零手写实现 nginx-16-nginx 支持配置多个 server

从零手写实现 nginx-17-nginx 默认配置优化

从零手写实现 nginx-18-nginx 请求头+响应头操作

从零手写实现 nginx-19-nginx cors

从零手写实现 nginx-20-nginx 占位符 placeholder

从零手写实现 nginx-21-nginx modules 模块信息概览

从零手写实现 nginx-22-nginx modules 分模块加载优化

从零手写实现 nginx-23-nginx cookie 的操作处理

从零手写实现 nginx-24-nginx IF 指令

前言

大家好，我是老马。

这一节我们来系统的看一下 nginx 有哪些模块，为我们后续的设计实现打下基础。

模块概览

Nginx 的配置文件通常由几个不同的模块组成，这些模块定义了服务器的不同方面。以下是一些主要的配置模块：

1. main（主配置） - 这是配置文件的核心部分，包括了全局设置和默认行为。

2. events（事件） - 这个模块定义了Nginx如何处理连接和事件。例如，它设置了工作进程的数量和连接的超时时间。

3. http（HTTP模块） - 这个模块定义了HTTP服务器的配置，包括日志格式、MIME类型、文件扩展名和文件类型映射等。

4. mail（邮件模块） - 如果Nginx配置为邮件代理，这个模块定义了邮件处理的配置。

5. stream（流模块） - 这个模块定义了TCP和UDP服务器的配置，用于处理非HTTP协议的流量。

6. server（服务器） - 这个模块定义了虚拟服务器的配置，包括监听的端口、服务器名称、处理请求的规则等。

7. location（位置） - 这个模块定义了请求的匹配规则和相应的处理指令，可以嵌套在server模块中。

8. upstream（上游） - 这个模块定义了后端服务器的列表，用于负载均衡和反向代理。

9. include（包含） - 这个指令用于包含其他配置文件，使得配置更加模块化和易于管理。

10. log_format（日志格式） - 定义自定义的日志格式。

11. ssl（SSL模块） - 如果配置了SSL，这个模块定义了SSL相关的设置，如证书和密钥文件。

12. if（条件判断） - 这个指令允许在配置文件中进行条件判断，根据条件来启用或禁用某些配置。

这些模块通过不同的指令和参数组合，允许管理员精细地控制Nginx服务器的行为。

配置文件通常以nginx.conf为文件名，并且可以在不同的目录级别上进行分割，以便于管理和维护。

模块

1. Main (全局) 模块

全局模块配置 Nginx 的全局设置，例如工作进程数量、日志路径等。

通常，这些配置位于 Nginx 配置文件的顶部。

worker_processes auto;
error_log /var/log/nginx/error.log;
pid /run/nginx.pid;

指令

Nginx Main（全局）模块配置指令及其示例：

配置示例

以下是一个包含多个 Main 模块指令的 Nginx 配置示例：

worker_processes auto;                             # 自动配置工作进程数量
error_log /var/log/nginx/error.log warn;           # 错误日志路径和级别
pid /run/nginx.pid;                                # PID 文件路径
worker_rlimit_nofile 8192;                         # 最大文件描述符数量
worker_priority -10;                               # 工作进程优先级
daemon on;                                         # 以守护进程方式运行
master_process on;                                 # 启用主进程模式
user www-data;                                     # 进程用户和组
worker_cpu_affinity auto;                          # 自动绑定工作进程到 CPU 核心
worker_shutdown_timeout 10s;                       # 工作进程关闭超时时间
timer_resolution 100ms;                            # 事件定时器分辨率
include /etc/nginx/conf.d/*.conf;                  # 包含其他配置文件
load_module modules/ngx_http_geoip_module.so;      # 动态加载模块
env PATH;                                          # 设置环境变量
env MY_VARIABLE=value;                             # 设置自定义环境变量

通过合理配置这些全局指令，可以优化 Nginx 的性能和稳定性，并确保其在各种操作系统和硬件环境下的高效运行。

2. Events 模块

Events 模块配置与连接处理相关的参数，例如每个工作进程允许的最大连接数。

events {
    worker_connections 1024;
    multi_accept on;
    use epoll;
}

Nginx 的 Events 模块用于配置处理事件的相关参数，例如每个工作进程允许的最大连接数、使用的事件模型等。以下是 Nginx Events 模块的常见配置指令及其示例：

配置示例

以下是一个包含多个 Events 模块指令的 Nginx 配置示例：

events {
    worker_connections 1024;  # 每个工作进程允许的最大连接数
    multi_accept on;          # 同时接受多个新连接
    use epoll;                # 使用 epoll 事件驱动模型（适用于 Linux）
}

指令详细说明

1. worker_connections

   • 说明：设置每个工作进程允许的最大连接数。这是一个关键参数，决定了 Nginx 的并发处理能力。
   • 示例：worker_connections 1024;

2. multi_accept

   • 说明：当设置为 on 时，每个工作进程将尝试同时接受所有的新连接。当负载较重时，这可以提高连接的接受速度。
   • 示例：multi_accept on;

3. use

   • 说明：指定 Nginx 使用的事件驱动模型。常见的选项包括 select、poll、kqueue、epoll、/dev/poll、eventport 等。选择适合操作系统和负载的事件模型可以显著提高性能。
   • 示例：use epoll;（epoll 是 Linux 上性能优异的事件驱动模型）

通过合理配置 Events 模块指令，可以优化 Nginx 的事件处理性能，提升服务器在高并发环境下的响应能力。

events 模块可以配置多个吗？

在 Nginx 中，Events 模块本身只能配置一个。

这是因为 Events 模块主要用于配置与事件处理相关的参数，例如工作进程允许的最大连接数、事件驱动模型等。

这些配置对于整个 Nginx 实例是全局性质的，因此只需要一个 Events 模块来定义这些参数即可。

在 Nginx 的配置文件中，Events 模块通常位于 nginx.conf 文件的顶层，如下所示：

events {
    worker_connections 1024;
    multi_accept on;
    use epoll;
}

上述配置示例中，events 块内的指令只能配置一次，且其中的指令影响所有工作进程和连接处理。

如果需要更多的事件处理配置，通常情况下并不会在同一个配置文件中重复定义 events 块，而是依赖于全局配置的一致性。

因此，答案是：在 Nginx 中，Events 模块本身只能配置一个，用于定义全局的事件处理参数。

3. HTTP 模块

HTTP 模块是最常用的模块，包含 HTTP 服务器和反向代理相关的配置。

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 /var/log/nginx/access.log main;

    sendfile on;
    keepalive_timeout 65;

    # Include server blocks
    include /etc/nginx/conf.d/*.conf;
}

nginx http 模块可以配置多个吗？

在 Nginx 配置文件中，每个文件只能包含一个 http 块，用于定义 HTTP 服务器的全局配置。

这个 http 块包含了所有的 server 块，每个 server 块代表一个虚拟主机或者一个 HTTP 服务配置单元。

Nginx HTTP 模块配置指令及其示例：

以下是一些常见的 Nginx HTTP 模块配置指令及其说明：

以下是一个示例 Nginx 配置文件，包含了上述提到的一些常见的 HTTP 模块配置指令：

# 定义全局的 MIME 类型和默认类型
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 /var/log/nginx/access.log main;

    # 配置错误日志
    error_log /var/log/nginx/error.log warn;

    # 第一个虚拟主机配置
    server {
        listen       80;
        server_name  example.com www.example.com;

        root /var/www/example.com;
        index index.html index.htm;

        # 配置请求处理规则
        location / {
            try_files $uri $uri/ =404;
        }

        # 配置反向代理
        location /api/ {
            proxy_pass http://backend_server;
            proxy_set_header Host $host;
            proxy_set_header X-Real-IP $remote_addr;
        }

        # 启用 Gzip 压缩
        gzip on;
        gzip_types text/plain application/xml;
    }

    # 第二个虚拟主机配置
    server {
        listen       80;
        server_name  anotherdomain.com;

        root /var/www/anotherdomain.com;
        index index.html index.htm;

        # 配置请求处理规则
        location / {
            try_files $uri $uri/ =404;
        }

        # 配置 SSL
        ssl_certificate /etc/nginx/ssl/anotherdomain.com.crt;
        ssl_certificate_key /etc/nginx/ssl/anotherdomain.com.key;
        ssl_protocols TLSv1.2 TLSv1.3;
        ssl_ciphers HIGH:!aNULL:!MD5;

        # 添加自定义 HTTP 头字段
        add_header X-Frame-Options "SAMEORIGIN";
    }

    # 全局配置
    client_max_body_size 10M;
    keepalive_timeout 65;

    # 配置 HTTP 缓存
    proxy_cache_path /data/nginx/cache levels=1:2 keys_zone=my_cache:10m inactive=60m;
}

在这个示例配置文件中：

• http 块包含了全局的配置，如包含其他配置文件、默认 MIME 类型、日志格式和路径等。
• 两个 server 块分别定义了两个虚拟主机的配置，包括监听的端口、域名、根目录、索引文件、请求处理规则（使用 location 块）、反向代理配置、Gzip 压缩、SSL 配置等。
• 全局配置部分包括了一些通用的配置指令，如客户端请求体大小限制 (client_max_body_size)、Keep-Alive 连接超时时间 (keepalive_timeout)，以及 HTTP 缓存配置 (proxy_cache_path)。

这个示例展示了如何通过组合使用不同的 Nginx HTTP 模块配置指令，来实现一个具有多个虚拟主机、反向代理、SSL 加密、HTTP 头字段添加、Gzip 压缩和缓存控制的完整的 HTTP 服务器配置。

4. Server 模块

Server 模块配置单个虚拟主机的参数。

它通常包含在 HTTP 模块内。

server {
    listen 80;
    server_name example.com www.example.com;

    root /var/www/html;
    index index.html index.htm;

    location / {
        try_files $uri $uri/ =404;
    }

    error_page 404 /404.html;
    location = /404.html {
        internal;
    }
}

nginx server 模块常见的指令表格

以下是一些常见的 Nginx server 模块配置指令及其说明：

这些指令允许管理员在每个 server 块中配置特定虚拟主机的行为，从基本的请求处理到高级的代理、安全和性能调优配置。

通过合理配置这些指令，可以实现丰富的功能和灵活的服务器行为定制。

nginx server 模块常见的配置例子

以下是一个简单的 Nginx server 模块的配置例子，展示了如何配置一个基本的静态文件服务器：

server {
    listen 80;  # 监听端口

    server_name example.com www.example.com;  # 设置虚拟主机的域名

    root /var/www/example.com;  # 设置根目录

    index index.html index.htm;  # 设置默认的索引文件

    access_log /var/log/nginx/example.access.log;  # 配置访问日志
    error_log /var/log/nginx/example.error.log;    # 配置错误日志

    location / {
        try_files $uri $uri/ =404;  # 配置请求处理规则
    }

    location /images/ {
        # 反向代理到另一个服务器的示例
        proxy_pass http://backend_server;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
    }

    # 启用 Gzip 压缩
    gzip on;
    gzip_types text/plain application/xml;

    # 添加自定义 HTTP 响应头
    add_header X-Frame-Options "SAMEORIGIN";

    # 设置 SSL 配置示例
    ssl_certificate /etc/nginx/ssl/example.com.crt;
    ssl_certificate_key /etc/nginx/ssl/example.com.key;
    ssl_protocols TLSv1.2 TLSv1.3;
    ssl_ciphers HIGH:!aNULL:!MD5;
}

在这个例子中：

• listen 指令指定了 Nginx 监听的端口。
• server_name 指令设置了虚拟主机的域名。
• root 指令定义了服务器的根目录，客户端请求将在这个根目录下查找文件。
• index 指令设置了默认的索引文件，如果请求的路径是一个目录，则尝试显示指定的索引文件。
• access_log 和 error_log 指令配置了访问日志和错误日志的路径。
• location / 块定义了基本的请求处理规则，使用 try_files 指令尝试查找请求的文件。
• location /images/ 块演示了如何配置反向代理，将以 /images/ 开头的请求转发到 http://backend_server。
• gzip 指令启用了 Gzip 压缩，并配置了需要压缩的 MIME 类型。
• add_header 指令添加了自定义的 HTTP 响应头字段。
• ssl_certificate 和 ssl_certificate_key 指令配置了 SSL 证书和私钥的路径，启用了 HTTPS 访问。
• ssl_protocols 和 ssl_ciphers 指令配置了 SSL 支持的协议版本和加密算法。

这个配置示例展示了一个基本的 Nginx HTTP 服务器配置，包括静态文件服务、反向代理、Gzip 压缩、自定义响应头、SSL 配置等功能。

根据实际需求，可以进一步调整和扩展这些配置来满足特定的应用场景和安全要求。

5. Location 模块

Location 模块用于定义请求路径和处理方法。

location /images/ {
    root /data;
}

location / {
    proxy_pass http://backend;
    proxy_set_header Host $host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
}

nginx location 常见的指令表格

在 Nginx 的 location 块中，常见的配置指令用于定义请求的处理规则和行为。以下是一些常见的 Nginx location 块配置指令及其说明：

这些指令允许管理员在 location 块中配置特定请求路径的处理规则，包括路径重写、缓存控制、反向代理、FastCGI、uWSGI、SCGI 等 CGI 协议支持，以及各种请求速率和连接速率的限制。配置文件中可以根据具体需求组合和使用这些指令，以实现复杂的请求路由和后端服务集成。

nginx location 常见的配置例子

以下是一些常见的 Nginx location 块配置示例，展示了不同情况下如何配置具体的请求处理规则：

静态文件服务

server {
    listen 80;
    server_name example.com;

    root /var/www/example.com;
    index index.html index.htm;

    location / {
        try_files $uri $uri/ =404;
    }

    location /images/ {
        alias /var/www/images/;
    }
}

• 说明：
  • / 路径下的请求使用 try_files 指令尝试查找文件，如果找不到则返回 404。
  • /images/ 路径下的请求使用 alias 指令将请求路径映射到服务器文件系统中的另一个位置。

反向代理

server {
    listen 80;
    server_name api.example.com;

    location / {
        proxy_pass http://backend_server;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
    }
}

• 说明：
  • 所有 / 路径下的请求将被反向代理到名为 backend_server 的后端服务器。
  • 使用 proxy_set_header 指令设置发送给后端服务器的 HTTP 头字段。

FastCGI 服务

server {
    listen 80;
    server_name php.example.com;

    root /var/www/php.example.com;
    index index.php;

    location ~ \.php$ {
        include fastcgi_params;
        fastcgi_pass unix:/var/run/php-fpm.sock;
        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
    }
}

• 说明：
  • 所有以 .php 结尾的请求将使用 fastcgi_pass 指令转发到 PHP FastCGI 进程。
  • fastcgi_param 指令设置传递给 FastCGI 服务器的参数，例如 SCRIPT_FILENAME。

缓存控制

server {
    listen 80;
    server_name static.example.com;

    root /var/www/static.example.com;
    index index.html;

    location / {
        expires 1d;
    }
}

• 说明：
  • 所有请求在 / 路径下，响应的过期时间设置为 1 天，使用 expires 指令。

HTTPS 配置

server {
    listen 443 ssl;
    server_name secure.example.com;

    ssl_certificate /etc/nginx/ssl/secure.example.com.crt;
    ssl_certificate_key /etc/nginx/ssl/secure.example.com.key;

    location / {
        # HTTPS 配置的具体内容
    }
}

• 说明：
  • 使用 ssl_certificate 和 ssl_certificate_key 指令配置 SSL 证书和私钥路径。
  • 此处 location / 块内可以配置与 HTTPS 相关的其他指令，如 SSL 协议版本、加密算法等。

这些示例展示了在不同场景下如何配置 Nginx 的 location 块，以实现静态文件服务、反向代理、FastCGI、缓存控制和 HTTPS 安全设置等功能。

根据具体需求，可以进一步调整和扩展这些配置来满足特定的应用场景和安全要求。

6. Upstream 模块

Upstream 模块配置负载均衡和反向代理的后端服务器组。

upstream backend {
    server backend1.example.com;
    server backend2.example.com;
}

nginx Upstream 模块指令表格

在 Nginx 中，Upstream 模块用于定义一组后端服务器，常用于负载均衡和反向代理配置。

以下是一些常见的 Nginx Upstream 模块配置指令及其说明：

这些指令允许管理员配置上游服务器组的各种参数，包括负载均衡策略、健康检查、备份服务器、连接保持等。

通过合理配置 Upstream 模块，可以实现高可用性、负载均衡和性能优化的反向代理服务。

nginx Upstream 模块配置例子

以下是一个简单的 Nginx Upstream 模块的配置例子，演示了如何定义一组后端服务器并进行负载均衡配置：

http {
    upstream backend_servers {
        server backend1.example.com weight=3;
        server backend2.example.com:8080 max_fails=3 fail_timeout=30s;
        server 192.168.1.100:8080 backup;
        server unix:/var/run/backend3.sock;
        keepalive 32;
    }

    server {
        listen 80;
        server_name example.com;

        location / {
            proxy_pass http://backend_servers;
            proxy_set_header Host $host;
            proxy_set_header X-Real-IP $remote_addr;
        }
    }
}

• 说明：
  • upstream backend_servers { ... } 定义了一个名为 backend_servers 的上游服务器组。
  • server 指令用于定义每个后端服务器的配置：
    • backend1.example.com 权重为 3，表示比其他服务器被选中的概率更高。
    • backend2.example.com:8080 设置了最大失败次数为 3 次，每次失败后等待 30 秒后再次尝试。
    • 192.168.1.100:8080 设为备份服务器，在所有非备份服务器失败时才会使用。
    • unix:/var/run/backend3.sock 使用 UNIX 域套接字连接。
  • keepalive 32; 设置与上游服务器的 keepalive 连接数。

在上述配置中，Nginx 将通过 proxy_pass 指令将所有来自 example.com 的请求代理到 backend_servers 组中的后端服务器。

通过合理配置权重、失败处理和备份服务器，可以实现高可用性和负载均衡，确保应用在各种条件下的稳定运行。

7. Stream 模块

Stream 模块用于配置 TCP/UDP 代理服务。

stream {
    upstream backend {
        server backend1.example.com:12345;
        server backend2.example.com:12345;
    }

    server {
        listen 12345;
        proxy_pass backend;
    }
}

nginx stream 模块的指令表格

Nginx 的 Stream 模块用于处理 TCP 和 UDP 流量，例如用于代理和负载均衡非 HTTP 流量。

以下是一些常见的 Nginx Stream 模块配置指令及其说明：

这些指令允许管理员配置 Nginx Stream 模块用于处理 TCP 或 UDP 流量的各种行为，包括代理、超时控制、SSL 预读取、访问控制、限速等。

通过合理配置这些指令，可以实现非 HTTP 流量的反向代理、负载均衡和安全控制。

nginx stream 模块的常见配置例子

以下是一个简单的 Nginx Stream 模块的配置例子，演示了如何配置 TCP 和 UDP 代理服务器：

TCP 代理

stream {
    upstream backend_servers {
        server backend1.example.com:12345;
        server backend2.example.com:12345;
    }

    server {
        listen 12345;
        proxy_pass backend_servers;
        proxy_timeout 3s;
    }
}

• 说明：
  • stream { ... } 定义了一个 TCP 代理服务器。
  • upstream backend_servers { ... } 定义了一个名为 backend_servers 的上游服务器组。
  • server { ... } 定义了一个 TCP 服务器块，监听端口 12345。
  • proxy_pass backend_servers; 使用 proxy_pass 指令将所有来自客户端的 TCP 请求代理到 backend_servers 组中的后端服务器。
  • proxy_timeout 3s; 配置与后端服务器的超时时间为 3 秒。

UDP 代理

stream {
    server {
        listen 12345 udp;
        proxy_pass backend_server;
        proxy_timeout 3s;
        proxy_responses 1;
    }
}

• 说明：
  • stream { ... } 定义了一个 UDP 代理服务器。
  • server { ... } 定义了一个 UDP 服务器块，监听 UDP 端口 12345。
  • proxy_pass backend_server; 使用 proxy_pass 指令将所有来自客户端的 UDP 请求代理到 backend_server。
  • proxy_timeout 3s; 配置与后端服务器的超时时间为 3 秒。
  • proxy_responses 1; 配置 UDP 代理的最大响应次数为 1。

这些示例展示了如何配置 Nginx Stream 模块来处理 TCP 和 UDP 流量的代理功能。

通过合理配置 upstream 和 server 块，可以实现 TCP 和 UDP 请求的负载均衡、超时控制和安全性。

小结

看的出来，nginx 的模块非常强大。

我们实现的时候，还是要分清主次，依次处理。

我是老马，期待与你的下次重逢。

开源地址

为了便于大家学习，已经将 nginx 开源

https://github.com/houbb/nginx4j

热门相关：腹黑老公，请离婚！   大师救命   末日终战   痴情王爷：凌贝贝的米虫生活   官仙