Include 是网关配置模块化的基石,因其是 Nginx 官方唯一推荐的零开销配置复用机制,支持物理隔离路由、限流、TLS 等关注点,并需注意绝对路径、加载顺序及全局指令位置等关键细节。

用 Nginx 做网关时,配置文件容易变得臃肿难维护。核心解法不是堆功能,而是把大配置拆成小块——Include 指令就是实现模块化管理最直接、最轻量的方式。
为什么 Include 是网关配置模块化的基石
Nginx 本身不支持 import 或 require 语义,也没有原生的配置作用域或变量继承机制。Include 不是“锦上添花”,而是官方唯一推荐的配置复用手段。它在读取主配置时同步加载并内联文件内容,零运行时开销,且被所有 Nginx 版本(包括 OpenResty)稳定支持。
对网关场景特别关键的是:它让路由规则、限流策略、SSL 配置、上游分组这些关注点可以物理隔离、独立版本控制、按环境条件性加载。
典型网关配置的模块划分建议
一个生产级 Nginx 网关配置,建议按职责拆为以下几类 include 文件(放在 /etc/nginx/conf.d/ 或自定义的 /etc/nginx/gateway/ 下):
- upstreams.conf:定义所有 upstream 块(服务集群、健康检查、负载策略),与 location 解耦
- routes/*.conf:每个微服务或业务域一个文件,如 auth-api.conf、order-service.conf,只写 location + proxy_pass
- security.conf:统一的防刷、IP 黑白名单、请求头过滤、CORS 策略
- tls/*.conf:按域名或环境存放证书路径、TLS 版本、HSTS 配置,便于轮换
- snippets/*.conf:可复用的配置片段,如限流 key 定义(limit_req_zone)、通用 error_page、日志格式
Include 使用的关键细节和避坑点
看似简单,但线上出问题多源于 include 路径或加载顺序误用:
- 路径必须是绝对路径,或相对于 nginx.conf 中 prefix 的相对路径;推荐统一用绝对路径,避免因启动目录不同导致加载失败
- include 支持通配符(如 include /etc/nginx/gateway/routes/*.conf;),但匹配顺序依赖文件系统排序(字母序),不要依赖隐式顺序来控制执行优先级
- 被 include 的文件不能有语法错误,否则整个 nginx -t 会失败;建议对 routes/ 下的每个 .conf 单独做语法校验(nginx -t -c /dev/stdin )
- map、upstream、limit_req_zone 等指令必须出现在 http 块顶层,不能嵌套在 server 或 location 内 —— 这类全局配置务必放在独立的 snippets 或 upstreams 文件中,并确保它们在 http 块开头被 include
配合自动化提升模块化价值
模块化只有配合流程才真正提效:
- CI 流程中,每次提交 routes/*.conf 就自动触发 nginx -t 校验 + 配置 diff 预览,防止误改影响全站
- 使用 confd、consul-template 或自研脚本,根据服务注册中心状态动态生成 upstreams.conf,实现服务发现与 Nginx 配置联动
- 通过 Ansible 或 NixOps 管理不同环境的 include 目录结构(如 staging 只 include tls/staging.conf,prod include tls/prod.conf),避免硬编码环境差异

















