ngx_http_proxy_module模块

Posted 2020-10-28

1、proxy_pass URL;Context:location, if in location, limit_except

注意：proxy_pass后面路径不带uri时，会将location的uri传递（附加）给后端主机

server {
    ...
    server_name HOSTNAME;
    location /uri/ {
        proxy_pass http://host[:port]; 最后没有/
    }
    ...
}

上面示例：http://HOSTNAME/uri --> http://host/uri，如果上面示例中有 /，即：http://host[:port]/意味着：http://HOSTNAME/uri --> http://host/ 即置换proxy_pass后面的路径是一个uri时，其会将location的uri替换为proxy_pass的uri

server {
    ...
    server_name HOSTNAME;
    location /uri/ {
        proxy_pass http://host/new_uri/;
    }
    ...
}

    访问结果：http://HOSTNAME/uri/ --> http://host/new_uri/

2、proxy_set_header field value；(Context: http, server, location)设定发往后端主机的请求报文的请求首部的值

    proxy_set_header X-Real-IP(变量，可以随意定义) $remote_addr;

    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

请求报文的标准格式如下：

    X-Forwarded-For: client1, proxy1, proxy2

    注意：需要在后端服务器配置文件中的日志模板添加该变量

    LogFormat "%{X-Real-IP}i %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\" " combined

    LogFormat "%{X-Forwarded-For}i %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\" " combined

3、proxy_cache_path;(Context:http)定义可用于proxy功能的缓存；

    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];

4、proxy_cache zone | off;Context:http,server, location

    默认off,指明调用的缓存，或关闭缓存机制；

5、proxy_cache_key string;

    缓存中用于“键”的内容 默认值： proxy_cache_key $scheme$proxy_host$request_uri;

6、proxy_cache_valid [code ...] time;

    定义对特定响应码的响应内容的缓存时长定义在http{...}中

    示例:

        proxy_cache_valid 200 302 10m;

        proxy_cache_valid 404 1m;

    示例：

        在http配置定义缓存信息

            proxy_cache_path /var/cache/nginx/proxy_cache levels=1:1:1 keys_zone=proxycache:20m inactive=120s max_size=1g;

        调用缓存功能，需要定义在相应的配置段，如server{...}；

            proxy_cache proxycache;

            proxy_cache_key $request_uri;

            proxy_cache_valid 200 302 301 1h;

            proxy_cache_valid any 1m;

7、proxy_cache_use_stale;

    proxy_cache_use_stale error | timeout | invalid_header | updating | http_500 | http_502 | http_503 | http_504 | http_403 | http_404 | off ...

    在被代理的后端服务器出现哪种情况下，可以真接使用过期的缓存响应客户端

8、proxy_cache_methods GET | HEAD | POST ...;

    对哪些客户端请求方法对应的响应进行缓存，GET和HEAD方法总是被缓存

9、proxy_hide_header field;

    默认nginx在响应报文不传递后端服务器的首部字段Date, Server, X-Pad, X-Accel-等，用于隐藏后端服务器特定的响应首部

10、proxy_connect_timeout time;

    定义与后端服务器建立连接的超时时长，如超时会出现502错误，默认为60s，一般不建议超出75s，

11、proxy_send_timeout time;

    将请求发送给后端服务器的超时时长；默认为60s

12、proxy_read_timeout time;

    等待后端服务器发送响应报文的超时时长，默认为60s