nginx模块之ngx_http_proxy_module和ng

前言

nginx服务也支持代理服务，其代理功能的实现是通过ngx_http_proxy_module此模块来实现的。通常代理服务分为正向代理和反向代理。

正向代理：是指服务器代理请求者的身份访问服务资源，通常应用于代理上网。
反向代理：指的是代理服务器接受连接请求，然后将请求转发给内部网络上的服务器，并将从服务器上得到的结果返回给响应的请求连接的客户端，此时代理服务器对外就表现为一个反向代理服务器

nginx对于这两者都是支持的，其实现均是使用ngx_http_proxy_module模块来实现。那么接着我们就来一起看看nginx与此模块相关的配置指令及示例。

ngx_http_proxy_module模块

- 1、proxy_pass URL;
配置段：location, if in location, limit_except
proxy_pass指令可以说是ngx_http_proxy_module模块的核心指令了，几乎任何与代理相关的配置均与此指令相关。
通常其使用格式类似于：

proxy_pass http://host[:port][/uri];

值得注意的是proxy_pass的路径后面有没有/uri是有区别的，当proxy_pass后面的路径不带uri时，其会将location的uri传递给后端主机；如：

server {
    ...
    server_name HOSTNAME;
    location /blog/ {
        proxy http://10.10.10.10;
    }
    ...
}

上述location的/blog/会传递给10.10.10.10主机，实际代理访问的位置为http://10.10.10.10/blog/。

又如当proxy_pass后面的路径带有/uri时，其会将location的uri替换为proxy_pass的uri，如：

server {
    ...
    server_name www.a.com
    location /blog/ {
        proxy_pass http://10.10.10.10/news/;
    }
    ...
}

此时访问http://www.a.com/blog/实际上就是访问http://10.10.10.10/news/，/blog/被替换成了/news/。

此外还要注意点的是如果在location定义uri时使用了正则表达式匹配的模式，或在if语句或limt_execept中使用proxy_pass指令，则proxy_pass之后必须不能使用uri; 用户请求时传递的uri将直接附加代理到的服务的之后,如：

location ~* \.(jpg|png|gif)$ {
proxy_pass http://10.10.10.10;
}

- 2、proxy_set_header field value;
配置段：http, server, location
此指令用于设置发往后端服务器的请求报文的请求首部的值，如：
将真实的访问用户IP送往后端服务器：

server {
        listen 80;
        server_name www.ilinux.io;
        location /blog/blog.html {
#在代理服务器上将远程客户端的Ip设置为X-Real-IP
                proxy_set_header X-Real-IP  $remote_addr;
                proxy_pass http://10.10.10.11/news/news.html;
        }
}

#在后端服务器，设置access日志的格式，将原本的$remote_addr替换为$http_x_real_ip
log_format  main  '$http_x_real_ip - $remote_user [$time_local] "$request" '
                  '$status $body_bytes_sent "$http_referer" '
                  '"$http_user_agent" "$http_x_forwarded_for"';
#在测试访问几次后，查看后端服务器的access_log文件即可查看到相应的访问客户端IP

- 3、proxy_cache_path path;
配置段：http
用于配置代理缓存的路径及其他参数，其完整使用格式如下：

proxy_cache_path path [levels=levels] [use_temp_path=on|off] keys_zone=name:size [inactive=time] [max_size=size] [manager_files=number] [manager_sleep=time] [manager_threshold=time] [loader_files=number] [loader_sleep=time] [loader_threshold=time] [purger=on|off] [purger_files=number] [purger_sleep=time] [purger_threshold=time];

levels参数定义了cache保留路径的层次结构，最多支持三层级结构。levels的值支持1或2，表示以多少个字符命名层级目录。如levels=1:2:3，表示缓存路径为三级目录结构，其中一级子目录以1个字符命名，二级子目录2个，三级子目录3个。
keys_zone参数用于定义cache zone的名称及分配的内存大小，如：keys_zone=cache1:100m。
max_size参数用于设置缓存zone的最大容量是多少；
inactive参数用于设置这个zone中的缓存文件如果在指定的时间内都没有被访问，则文件会被cache manager进程删除掉。

配置示例：

proxy_cache_path  /usr/local/nginx/proxy_cache_dir/cache1  levels=1:2 keys_zone=cache1:100m inactive=1d max_size=10g;

- 4、proxy_cache zone_name | off;
配置段：http, server, location
用于指定要调用的缓存zone，或者关闭缓存机制。
配置示例：

server {
    ...
    server_name HOSTNAME;
    location /uri/ {
        proxy http://hos[:port];
        proxy_cache cache1;
    }
    ...
}

** - 5、proxy_cache_key string;**
配置段：http, server, location
用于定义缓存的关键字。
配置示例：

proxy_cache_key $scheme$proxy_host$request_uri;

- 6、proxy_cache_valid [code ...] time;
配置段： http, server, location
用于定义对特定响应码的响应内容的缓存时长。
示例：

#对200,302,301状态码缓存1小时
proxy_cache_valid 200 302 301 1h; 
#对其他的内容缓存1分钟
proxy_cache_valid any 1m;

- 7、proxy_cache_use_stale error | timeout | invalid_header | updating | http_500 | http_502 | http_503 | http_504 | http_403 | http_404 | http_429 | off ...;
配置段： http, server, location
用于指定，当后端服务器出现error，timeout，http_500等状况时，即使缓存内容已过去返回给用户。
- 8、proxy_cache_methods GET | HEAD | POST ...;
配置段： http, server, location
当客户端使用指定的请求方法发送请求时，该请求会被缓存下来。GET和HEAD是默认就被指定的缓存方法。
- 9、proxy_hide_header field;
配置段：http, server, location
默认情况下，nginx不会将报文首部“Date”，“Server”等字段从代理服务器传递给客户端。而此指令，可让管理员设置额外的不进行传递的字段。
- 10、proxy_connect_timeout time;
配置段： http, server, location
定义代理服务器的连接超时时长，默认为60s，最长不超过75s；

- 11、proxy_read_timeout time;
配置段： http, server, location、
用于定义nginx会等待多长时间来获得请求的响应。这个时间不是获得整个response的时间，而是两次reading操作的时间。默认为60s。
- 12、proxy_send_timeout time;
配置段：http, server, location
用于定义nginx发送请求给后端服务器的超时时间。这个时间不是获得整个response的时间，而是两次sending操作的时间。默认为60s。

gx_http_headers_module模块

此模块用于在代理服务器响应给客户端的响应报文中添加自定义首部或修改指定首部的值。
- 1、add_header name value [always];
配置段： http, server, location, if in location
用于添加自定首部，如：

server {
        listen 80;
        server_name www.ilinux.io;
        location /blog/blog.html {
                proxy_set_header X-Real-IP  $remote_addr;
#添加自定义首部X-via表示代理服务器IP
                add_header X-Via  $server_addr;
#添加自定义首部X-Accel表示代理服务器的主机名
                add_header X-Accel $server_name;
                proxy_pass http://10.10.10.11/news/news.html;
        }
}

客户端访问情况

- 2、expires [modified] time;
expires epoch | max | off;
配置段：http, server, location, if in location
此指令用于定义客户端本地缓存超时时间或Cache-Control首部的值。
示例：

#表示指定路径上的图片在客户端上缓存3天才失效
location ~* \.(gif|jpg|jpeg|png) {

root  /var/mywww/html/public/

expires 3d;

}

HTTP报文的expires字段

关于ngx_http_proxy_module和ngx_http_headers_module模块的其他可用指令可参考链接：http://nginx.org/