Nginx 学习总结(4)—— Rewrite 模块

Jochen

这是 Nginx 学习总结的第四篇,上一篇介绍到了 Nginx 学习总结(3) —— Location 模块,这一篇会对Rewrite模块 做一些总结。根据官方文档说明,Rewrite 模块是用于使用 PCRE 正则表达式更改请求 URI,有条件地选择配置,并返回重定向。

表面看,rewritelocation 的功能有点像,都能实现跳转,然而它们的区别在于:rewrite 是在同一域名内更改获取资源的路径,而 location 是对一类路径做控制访问或反向代理,并且可以 proxy_pass 到其他机器。

很多情况下 rewrite 也会写在 location 里,它们的执行顺序是:

  1. 执行 server 块的 rewrite 指令;
  2. 执行 location 匹配;
  3. 执行选定的 location 中的 rewrite 指令。
如果其中某步 URI 被重写,则重新循环执行1-3,直到找到真实存在的文件;循环超过10次,则返回 500 Internal Server Error 错误。

指令

1. break

停止执行 ngx_http_rewrite_module 模块的指令集,但是其他模块指令不受影响。

Context: server, location, if
server {
    listen 80;
    
    # 此处 break 会停止执行 server 块的 return 指令(return 指令属于rewrite模块)
    # 如果把它注释掉 则所有请求进来都返回 ok 字符串
    break;
    return 200 "ok";
    
    location = / {
        root   /usr/share/nginx/html;
        index  index.php index.html index.htm;
    }
}

2. if

依据指定的条件决定是否执行 if 块语句中的内容。

Context: server, location

if 中的几种判断条件:

  • 一个变量名,如果变量 $variable 的值为空字符串或者字符串 "0",则为 false
  • 变量与一个字符串的比较,相等为 = 不相等为 !=
  • 变量与一个正则表达式的模式匹配,操作符可以是:~ 区分大小写的正则匹配; ~* 不区分大小写的正则匹配, !~!~* 前面两者的非;
  • 检测文件是否存在,使用 -f (存在) 和 !-f (不存在);
  • 检测路径是否存在,使用 -d (存在) 和 !-d (不存在) 后面判断可以是字符串也可是变量;
  • 检测文件、路径、或者链接文件是否存在,使用 -e (存在) 和 !-e (不存在) ,后面判断可以是字符串也可是变量;
  • 检测文件是否为可执行文件,使用 -x (可执行) 和 !-x (不可执行),后面判断可以是字符串也可是变量。

可以用作 if 判断的全局变量:

  • $args 这个变量等于请求行中的参数,同 $query_string
  • $content_length 请求头中的 Content-length 字段
  • $content_type 请求头中的 Content-Type 字段
  • $document_root 当前请求在 root 指令中指定的值
  • $host 请求主机头字段,否则为服务器名称
  • $http_user_agent 客户端 agent 信息
  • $http_cooki 客户端 cookie 信息
  • $limit_rate 这个变量可以限制连接速率
  • $request_method 客户端请求的动作,通常为 GETPOST
  • $remote_addr 客户端的 IP 地址
  • $remote_port 客户端的端口
  • $remote_user 已经经过 Auth Basic Module 验证的用户名
  • $request_filename 当前请求的文件路径,由 rootalias 指令与 URI 请求生成
  • $scheme 请求协议,如 http,https
  • $server_protocol 请求客户端协议,通常是 HTTP/1.0HTTP/1.1
  • $server_addr 服务器地址,在完成一次系统调用后可以确定这个值
  • $server_name 服务器名称
  • $server_port 请求到达服务器的端口号
  • $request_uri 包含请求参数的原始 URI,不包含主机名,如 /foo/bar.php?arg=baz
  • $uri 不带请求参数的当前 URI,$uri 不包含主机名,如 /foo/bar.html
  • $document_uri 与 $uri 相同
set $variable "0"; 
if ($variable) {
    # 不会执行,因为 "0" 为 false
    break;            
}

# 变量与一个字符串的比较
if ($request_method = POST) {
    return 405;
}

# 变量与正则表达式的匹配
if ($http_cookie ~* "id=([^;]+)(?:;|$)") {
    set $id $1;
}
if ($http_user_agent ~ MSIE) {
    rewrite ^(.*)$ /msie/$1 break;
}

# 检查文件是否存在,字符串与变量均可
if ( !-f "/data.log" ) {
    break;            
}
if ( !-f $filename ) {
    break;            
}
if 关键字后必须加一个空格符

3. return

停止处理并将指定的 code 码返回给客户端。 从 0.8.42 版本开始, return 语句可以指定重定向 URL (状态码可以为如下几种 301,302,303,307),也可以为其他状态码指定响应的文本内容,并且重定向的 URL 和响应的文本可以包含变量。

Context: server, location, if
# return code [text];
location = /ok {
    return 200 "ok"; # 返回 ok 给客户端
}

# return code URL; 
location = /redirect {
    return 302 http://www.baidu.com; # 临时重定向
}

# return URL;
location = /redirect {
    return http://www.baidu.com; # 临时重定向
}

4. rewrite

使用指定的正则表达式匹配请求 URL,如果匹配成功,则根据规则更改 URL。rewrite 指令按照它们在配置文件中出现的先后顺序执行。可以使用 flag 标志来终止指令的进一步处理。如果替换字符串以 http://https://$scheme 开头,则停止处理后续内容,并直接重定向返回给客户端。语法:rewrite regex replacement [flag];

Context: server, location, if
# 第一种情况,带 http://
location / {
    rewrite /test1/(.*) http://www.$1.com;
    return 200 "ok";
}
# 在浏览器中访问,被临时重定向到 www.baidu.com
# 后面的 return 指令将没有机会执行了


# 第二种情况,不带 http://
location / {
    rewrite /test1/(.*) www.$1.com;
    return 200 "ok";
}
# 在浏览器中访问,返回了 ok

rewrite 的四个 flag

  • last 停止处理当前的 ngx_http_rewrite_module 的指令集,并开始搜索与更改后的 URL 相匹配的 location;
  • break 停止处理当前的 ngx_http_rewrite_module 指令集;
  • redirect 返回 302 临时重定向;
  • permanent 返回 301 永久重定向。
location / {
    # 顺序执行如下两条 rewrite 指令 
    # rewrite 后面没有任何 flag 时就顺序执行 
    # 当 location 中没有 rewrite 模块指令可被执行时,就重写发起新一轮 location 匹配
    rewrite ^/test1 /test2;
    rewrite ^/test2 /test3;  # 此处发起新一轮location匹配,重写后的 url 为 /test3
}

location = /test2 {
    return 200 "/test2";
}  
location = /test3 {
    return 200 "/test3";
}

# 发送如下请求
# curl 127.0.0.1:8080/test1
# /test3
location / {
    rewrite ^/test1 /test2;
    rewrite ^/test2 /test3 last;  # 此处发起新一轮 location 匹配,重写后的 url 为 /test3
    rewrite ^/test3 /test4;
}

location = /test2 {
    return 200 "/test2";
}  
location = /test3 {
    return 200 "/test3";
}
location = /test4 {
    return 200 "/test4";
}

# 发送如下请求
# curl 127.0.0.1:8080/test1
# /test3 
location / {
    rewrite ^/test1 /test2;
    rewrite ^/test2 /more/index.html break;  # 终止执行后续 rewrite 模块指令,重写后的 url 为 /more/index.html
    rewrite /more/index.html /test4;
    proxy_pass https://www.baidu.com; # 因为 proxy_pass 不是 rewrite 模块的指令,所以它不会被 break 终止
}

# 发送如下请求
# curl 127.0.0.1:8080/test1 
# 代理到 百度产品大全页面: https://www.baidu.com/more/index.html;

5. rewrite_log

开启或者关闭 rewrite 模块指令的执行日志,如果开启,则记录下 notice 级别的日志到 error_log 中,默认为关闭 off

Context: http, server, location, if

6. set

设置指定变量的值。变量的值可以包含文本,变量或者是它们的组合形式。

Context: server, location, if
location / {
    set $var1 "host is ";
    set $var2 $host;
    set $var3 " uri is $request_uri";
    return 200 "response ok $var1$var2$var3";
}

# 发送如下请求
# curl 127.0.0.1:8080/test
# response ok host is 127.0.0.1 uri is /test

参考文章:

  1. 搞懂 nginx 的 rewrite 模块
  2. nginx 配置 location 总结及 rewrite 规则写法
  3. Module ngx_http_rewrite_module
阅读 2.9k

PHP 学习总结
研读官网文档和网络优秀个人文章,对 PHP 编程相关作出学习总结。

Stay hungry, stay foolish.

846 声望
82 粉丝
0 条评论

Stay hungry, stay foolish.

846 声望
82 粉丝
文章目录
宣传栏