variables - 在 Nginx 定位规则中使用变量

Question

在 Nginx 中，我试图定义一个变量，它允许我为我的所有位置块配置一个子文件夹。我这样做了：

set $folder '/test';

location $folder/ {
   [...]
}

location $folder/something {
   [...]
}

不幸的是，这似乎不起作用。虽然 Nginx 没有抱怨语法，但它在请求时返回 404 /test/。如果我明确写入文件夹，它可以工作。那么如何在位置块中使用变量呢？

Answer 1

你不能。Nginx 并不真正支持配置文件中的变量，它的开发人员嘲笑所有要求添加此功能的人：

“与普通静态配置相比，[变量] 的成本相当高。[A] 宏扩展和“包含”指令应该与 [with] 一起使用，例如 sed + make 或任何其他常见的模板机制。” http://nginx.org/en/docs/faq/variables_in_config.html

您应该编写或下载一个小工具，允许您从占位符配置文件生成配置文件。

更新下面的代码仍然有效，但我已经将它全部打包到一个名为Configurator的小型 PHP 程序/库中，也在Packagist上，它允许从模板和各种形式的配置数据轻松生成 nginx/php-fpm 等配置文件.

例如，我的 nginx 源配置文件如下所示：

location  / {
    try_files $uri /routing.php?$args;
    fastcgi_pass   unix:%phpfpm.socket%/php-fpm-www.sock;
    include       %mysite.root.directory%/conf/fastcgi.conf;
}

然后我有一个定义了变量的配置文件：

phpfpm.socket=/var/run/php-fpm.socket
mysite.root.directory=/home/mysite

然后我使用它生成实际的配置文件。看起来你是一个 Python 人，所以基于 PHP 的示例可能对你没有帮助，但对于其他使用 PHP 的人来说：

<?php

require_once('path.php');

$filesToGenerate = array(
    'conf/nginx.conf' => 'autogen/nginx.conf',
    'conf/mysite.nginx.conf' => 'autogen/mysite.nginx.conf',
    'conf/mysite.php-fpm.conf' => 'autogen/mysite.php-fpm.conf',
    'conf/my.cnf' => 'autogen/my.cnf',
);

$environment = 'amazonec2';

if ($argc >= 2){
    $environmentRequired = $argv[1];

    $allowedVars = array(
        'amazonec2',
        'macports',
    );

    if (in_array($environmentRequired, $allowedVars) == true){
        $environment = $environmentRequired;
    }
}
else{
    echo "Defaulting to [".$environment."] environment";
}

$config = getConfigForEnvironment($environment);

foreach($filesToGenerate as $inputFilename => $outputFilename){
    generateConfigFile(PATH_TO_ROOT.$inputFilename, PATH_TO_ROOT.$outputFilename, $config);
}


function    getConfigForEnvironment($environment){
    $config = parse_ini_file(PATH_TO_ROOT."conf/deployConfig.ini", TRUE);
    $configWithMarkers = array();
    foreach($config[$environment] as $key => $value){
        $configWithMarkers['%'.$key.'%'] = $value;
    }

    return  $configWithMarkers;
}


function    generateConfigFile($inputFilename, $outputFilename, $config){

    $lines = file($inputFilename);

    if($lines === FALSE){
        echo "Failed to read [".$inputFilename."] for reading.";
        exit(-1);
    }

    $fileHandle = fopen($outputFilename, "w");

    if($fileHandle === FALSE){
        echo "Failed to read [".$outputFilename."] for writing.";
        exit(-1);
    }

    $search = array_keys($config);
    $replace = array_values($config);

    foreach($lines as $line){
        $line = str_replace($search, $replace, $line);
        fwrite($fileHandle, $line);
    }

    fclose($fileHandle);
}

?>

然后 deployConfig.ini 看起来像：

[global]

;global variables go here.

[amazonec2]
nginx.log.directory = /var/log/nginx
nginx.root.directory = /usr/share/nginx
nginx.conf.directory = /etc/nginx
nginx.run.directory  = /var/run
nginx.user           = nginx

[macports]
nginx.log.directory = /opt/local/var/log/nginx
nginx.root.directory = /opt/local/share/nginx
nginx.conf.directory = /opt/local/etc/nginx
nginx.run.directory  = /opt/local/var/run
nginx.user           = _www

Answer 2

这已经晚了很多年，但是自从我找到解决方案后，我将在此处发布。通过使用地图，可以执行所要求的操作：

map $http_host $variable_name {
    hostnames;

    default       /ap/;
    example.com   /api/;
    *.example.org /whatever/;
}

server {
    location $variable_name/test {
        proxy_pass $auth_proxy;
    }
}

如果您需要跨多个服务器共享同一个端点，您还可以通过简单地默认值来降低成本：

map "" $variable_name {
    default       /test/;
}

Map 可用于根据字符串的内容初始化变量，并且可以在http范围内使用，允许变量是全局的并且可以跨服务器共享。

Answer 3

你可以做与你提议的相反的事情。

location (/test)/ {
   set $folder $1;
}

location (/test_/something {
   set $folder $1;
}

Answer 4

@danack 的 PHP 生成脚本的修改 python 版本。它生成build/位于父目录中的所有文件和文件夹，替换所有{{placeholder}}匹配项。您需要在运行脚本之前cd进入。build/

文件结构

build/
-- (files/folders you want to generate)
-- build.py

sites-available/...
sites-enabled/...
nginx.conf
...

构建.py

import os, re

# Configurations
target = os.path.join('.', '..')
variables = {
  'placeholder': 'your replacement here'
}


# Loop files
def loop(cb, subdir=''):
  dir = os.path.join('.', subdir);

  for name in os.listdir(dir):
    file = os.path.join(dir, name)
    newsubdir = os.path.join(subdir, name)

    if name == 'build.py': continue
    if os.path.isdir(file): loop(cb, newsubdir)
    else: cb(subdir, name)


# Update file
def replacer(subdir, name):
  dir  = os.path.join(target, subdir)
  file = os.path.join(dir, name)
  oldfile = os.path.join('.', subdir, name)

  with open(oldfile, "r") as fin:
    data = fin.read()

  for key, replacement in variables.iteritems():
    data = re.sub(r"{{\s*" + key + "\s*}}", replacement, data)

  if not os.path.exists(dir):
    os.makedirs(dir)

  with open(file, "w") as fout:
    fout.write(data)


# Start variable replacements.
loop(replacer)