如何在OpenResty的nginx.conf中基于特性标志条件配置location？

问题背景 #

需要通过环境变量ENABLE_UPSTREAMS控制是否启用特定的location配置：

• 启用时，/some-path和/some-path-2转发到对应上游服务
• 禁用时，这些路径完全不暴露（访问时返回404或直接无匹配）

之前尝试的两种配置均报错：

1. 将location嵌套在if块中，触发错误："location" directive is not allowed here
2. 在location内的if中使用proxy_set_header，触发错误："proxy_set_header" directive is not allowed here

错误原因 #

Nginx配置是声明式结构，有严格的指令层级限制：

• location是server块的直接子指令，不能嵌套在if块内部
• proxy_set_header这类配置指令仅允许在http/server/location块中使用，无法在if块内生效
• Nginx的if并非通用条件分支，仅支持部分简单指令（如return、rewrite）

正确实现方案 #

方案一：启动时动态生成配置（推荐，彻底隐藏路径） #

利用环境变量在启动OpenResty前生成对应的location配置文件，通过include加载，特性关闭时不加载任何相关配置。

1. 主nginx.conf配置：

env ENABLE_UPSTREAMS;
env UPSTREAM_HOST1;
env UPSTREAM_HOST2;

http {
    upstream upstream1 {
        server $UPSTREAM_HOST1;
    }

    upstream upstream2 {
        server $UPSTREAM_HOST2;
    }

    server {
        listen 80 default_server;
        listen [::]:80 default_server;

        # 动态加载上游location配置
        include /etc/nginx/conf.d/upstream-locations.conf;
    }
}

2. 启动脚本（结合环境变量生成配置）：

# 根据特性标志决定是否生成location配置
if [ "$ENABLE_UPSTREAMS" = "on" ]; then
    cat > /etc/nginx/conf.d/upstream-locations.conf <<EOF
location /some-path {
    proxy_pass http://upstream1;
    proxy_set_header Host $host;
    proxy_set_header X-Forwarded-For $remote_addr;
}

location /some-path-2 {
    proxy_pass http://upstream2;
    proxy_set_header Host $host;
    proxy_set_header X-Forwarded-For $remote_addr;
}
EOF
else
    # 创建空文件避免include报错
    touch /etc/nginx/conf.d/upstream-locations.conf
fi

# 启动OpenResty
openresty -g "daemon off;"

这种方式下，特性关闭时upstream-locations.conf为空，对应的location完全不存在于配置中，访问时会返回Nginx默认的404，彻底隐藏路径。

方案二：纯配置实现（无需脚本） #

通过map指令结合return控制访问权限，特性关闭时访问对应路径直接返回404，模拟路径不存在的效果。

env ENABLE_UPSTREAMS;
env UPSTREAM_HOST1;
env UPSTREAM_HOST2;

http {
    # 将环境变量映射为布尔变量
    map $ENABLE_UPSTREAMS $enable_upstreams {
        "on" 1;
        default 0;
    }

    # 判断当前请求是否属于需要控制的路径，结合特性标志生成允许访问变量
    map $request_uri $allow_upstream_access {
        ~^/some-path(/.*)?$ $enable_upstreams;
        ~^/some-path-2(/.*)?$ $enable_upstreams;
        default 0;
    }

    upstream upstream1 {
        server $UPSTREAM_HOST1;
    }

    upstream upstream2 {
        server $UPSTREAM_HOST2;
    }

    server {
        listen 80 default_server;
        listen [::]:80 default_server;

        # 不允许访问时直接返回404
        if ($allow_upstream_access = 0) {
            return 404;
        }

        # 配置上游转发规则
        location /some-path {
            proxy_pass http://upstream1;
            proxy_set_header Host $host;
            proxy_set_header X-Forwarded-For $remote_addr;
        }

        location /some-path-2 {
            proxy_pass http://upstream2;
            proxy_set_header Host $host;
            proxy_set_header X-Forwarded-For $remote_addr;
        }
    }
}

注意：此方案中location仍存在于配置中，但访问时会被if拦截返回404，对于要求路径完全“不存在”的场景，方案一更合适。

内容的提问来源于stack exchange，提问作者deroccha