浅析Nginx配置文件中的变量的编写使用

set $a "hello world"; 

set $a hello;  
set $b "$a, $a"; 

server {  
  listen 8080;  
 
  location /test {  
    set $foo hello;  
    echo "foo: $foo";  
  }  
} 

$ curl 'http://localhost:8080/test'  
foo: hello 

geo $dollar {  
  default "$";  
}  
 
server {  
  listen 8080;  
 
  location /test {  
    echo "This is a dollar sign: $dollar";  
  }  
} 

$ curl 'http://localhost:8080/test'  
This is a dollar sign: $ 

server {  
  listen 8080;  
 
  location /test {  
    set $first "hello ";  
    echo "${first}world";  
  }  
} 

$ curl 'http://localhost:8080/test  
hello world 

 server {  
  listen 8080;  
  
  location /bad {  
    echo $foo;  
  }  
 } 

[emerg] unknown "foo" variable

server {  
  listen 8080;  
 
  location /foo {  
    echo "foo = [$foo]";  
  }  
 
  location /bar {  
    set $foo 32;  
    echo "foo = [$foo]";  
  }  
} 

$ curl 'http://localhost:8080/foo'  
foo = []  
$ curl 'http://localhost:8080/bar'  
foo = [32]  
$ curl 'http://localhost:8080/foo'  
foo = [] 

server {  
  listen 8080;  
  location /foo {  
    set $a hello;  
    echo_exec /bar;  
  }  
  location /bar {  
    echo "a = [$a]";  
  }  
} 

$ curl localhost:8080/foo  
a = [hello] 

server {  
  listen 8080;  
  location /foo {  
    set $a hello;  
    rewrite ^ /bar;  
  }  
  location /bar {  
    echo "a = [$a]";  
  }  
}

location /test {  
  echo "uri = $uri";  
  echo "request_uri = $request_uri";  
} 

$ curl 'http://localhost:8080/test'  
uri = /test  
request_uri = /test  
$ curl 'http://localhost:8080/test"htmlcode">

location /test {  
  echo "name: $arg_name";  
  echo "class: $arg_class";  
} 


 

然后在命令行上使用各种参数组合去请求这个 /test 接口：


$ curl 'http://localhost:8080/test'  
name:  
class:  
$ curl 'http://localhost:8080/test"htmlcode">

$ curl 'http://localhost:8080/test"htmlcode">

location /test {  
  set_unescape_uri $name $arg_name;  
  set_unescape_uri $class $arg_class;  
  echo "name: $name";  
  echo "class: $class";  
} 



现在我们再看一下效果：


$ curl 'http://localhost:8080/test"htmlcode">

 location /bad {  
  set $uri /blah;  
  echo $uri;  
 } 



这个有问题的配置会让 Nginx 在启动的时候报出一条令人匪夷所思的错误：


[emerg] the duplicate "uri" variable in ... 



如果你尝试改写另外一些只读的内建变量，比如 $arg_XXX 变量，在某些 Nginx 的版本中甚至可能导致进程崩溃。

也有一些内建变量是支持改写的，其中一个例子是 $args. 这个变量在读取时返回当前请求的 URL 参数串（即请求 URL 中问号后面的部分，如果有的话 ），而在赋值时可以直接修改参数串。我们来看一个例子：


location /test {  
  set $orig_args $args;  
  set $args "a=3&b=4";  
  echo "original args: $orig_args";  
  echo "args: $args";  
} 



这里我们把原始的 URL 参数串先保存在 $orig_args 变量中，然后通过改写 $args 变量来修改当前的 URL 参数串，最后我们用 echo 指令分别输出 $orig_args 和 $args 变量的值。接下来我们这样来测试这个 /test 接口：


$ curl 'http://localhost:8080/test'  
original args:  
args: a=3&b=4 
$ curl 'http://localhost:8080/test"htmlcode">

location /test {  
  set $orig_a $arg_a;  
  set $args "a=5";  
  echo "original a: $orig_a";  
  echo "a: $arg_a";  
} 



这里我们先把内建变量 $arg_a 的值，即原始请求的 URL 参数 a 的值，保存在用户变量 $orig_a 中，然后通过对内建变量 $args 进行赋值，把当前请求的参数串改写为 a=5 ，最后再用 echo 指令分别输出 $orig_a 和 $arg_a 变量的值。因为对内建变量 $args 的修改会直接导致当前请求的 URL 参数串发生变化，因此内建变量 $arg_XXX 自然也会随之变化。测试的结果证实了这一点：


$ curl 'http://localhost:8080/test"htmlcode">

server {  
  listen 8080;  
  location /test {  
    set $args "foo=1&bar=2";  
    proxy_pass http://127.0.0.1:8081/args;  
  }  
}  
server {  
  listen 8081;  
  location /args {  
    echo "args: $args";  
  }  
}


  

这里我们在 http 配置块中定义了两个虚拟主机。第一个虚拟主机监听 8080 端口，其 /test 接口自己通过改写 $args 变量，将当前请求的 URL 参数串无条件地修改为 foo=1&bar=2. 然后 /test 接口再通过 ngx_proxy 模块的 proxy_pass 指令配置了一个反向代理，指向本机的 8081 端口上的 HTTP 服务 /args. 默认情况下，ngx_proxy 模块在转发 HTTP 请求到远方 HTTP 服务的时候，会自动把当前请求的 URL 参数串也转发到远方。而本机的 8081 端口上的 HTTP 服务正是由我们定义的第二个虚拟主机来提供的。我们在第二个虚拟主机的 location /args 中利用 echo 指令输出当前请求的 URL 参数串，以检查 /test 接口通过 ngx_proxy 模块实际转发过来的 URL 请求参数串。我们来实际访问一下第一个虚拟主机的 /test 接口：


$ curl 'http://localhost:8080/test?blah=7'  
args: foo=1&bar=2 



我们看到，虽然请求自己提供了 URL 参数串 blah=7，但在 location /test 中，参数串被强行改写成了 foo=1&bar=2. 接着经由 proxy_pass 指令将我们被改写掉的参数串转发给了第二个虚拟主机上配置的 /args 接口，然后再把 /args 接口的 URL 参数串输出。事实证明，我们对 $args 变量的赋值操作，也成功影响到了 ngx_proxy 模块的行为。

在读取变量时执行的这段特殊代码，在 Nginx 中被称为“取处理程序”（get handler）；而改写变量时执行的这段特殊代码，则被称为“存处理程序”（set handler）。不同的 Nginx 模块一般会为它们的变量准备不同的“存取处理程序”，从而让这些变量的行为充满魔法。其实这种技巧在计算世界并不鲜见。比如在面向对象编程中，类的设计者一般不会把类的成员变量直接暴露给类的用户，而是另行提供两个方法（method），分别用于该成员变量的读操作和写操作，这两个方法常常被称为“存取器”（accessor）。

        
        

            
上一篇：为Node.js程序配置使用Nginx服务器的简明教程
            
下一篇：Nginx中的用户认证配置及阻止用户使用代理访问的方法