12 深入浅出 Rewrite 语法-慕课专栏

12 深入浅出 Rewrite 语法

更新时间：2020-01-02 16:56:46

人生的旅途，前途很远，也很暗。然而不要怕，不怕的人的面前才有路。—— 鲁迅

前言

几乎所有的网站都会进行个性化配置满足自己的业务需要，而URL重写几乎是每个网站都必做的事情，Nginx提供了一把瑞士军刀–Rewrite模块来实现这个功能。
Rewrite是由Nginx的ngx_http_rewrite_module模块实现的功能。这个模块实现了一个脚本引擎，提供了一个脚本编程的功能。我们可以通过一些简单的编程来实现特殊化需求。

`Rewrite`模块指令

我们先看一下Rewrite模块的概览，它包含了下图中的几个指令：
图片描述

`Rewrite`日志

在学习Rewrite模块的时候，最好的方法是打开Rewrite日志开关，从日志中看整个流程。

rewrite_log 指令就是控制是否打开日志开关的，打开之后就把会每次rewrite的步骤记录到error_log日志中。

`return`命令

和其他的编程语言类似，return就是直接返回，停止后续的处理直接返回。
图片描述

我们看一个例子：
图片描述
重启Nginx之后，访问/book/接口，如下：

`rewrite`指令

其实本节中我重点想要讲解的是rewrite指令，这个指令在平时的工作中经常的用到，但是很多人对该指令的理解都是片面的。
先看一下rewrite的语法格式：

rewrite regex replacement [flag];

图片描述
rewrite 指令是使用指定的正则表达式（上一节我们介绍过的哦~）regex来匹配当前请求的URI，如果匹配成功，则使用replacement更改URI。
rewrite指令按照它们在配置文件中出现的顺序执行(下面我们总结了rewrite的执行顺序)，可以使用flag参数来控制指令的进一步处理。如果替换字符串replacement以http://，https://或$scheme开头，则停止处理后续内容，并直接重定向返回给客户端。

我们先从整体上看一下rewrite的执行顺序，过程如下：

按照rewrite指令在server中出现的顺序逐个执行，确定最终的URI。
循环执行下面的步骤：（上一步确定了URI）
- 根据URI找到匹配的location
- 按rewrite指令在location中出现的顺序逐个执行
- 如果上一步中对URI进行了重写，那么重复执行第2步骤，最多重复执行10次。

上面的最终指的是在server级别的rewrite全部按照要求执行之后得到的URI，Nginx会使用这个URI查找Location。
可能大家会觉得上面的步骤很生硬，请不要着急，我会在下面一一展开讲解。

rewrite指令最让人难理解原因是flag参数，特别是break和last这两个参数。

last: 停止处理当前的ngx_http_rewrite_module的指令集，并开始搜索与更改后的URI相匹配的location。（这里的last是持续，继续的意思，而不是最后）
break: 停止处理当前的ngx_http_rewrite_module指令集

上面是Nginx官网上的解释，其实这里面有一个比较难以理解的地方，什么是当前的ngx_http_rewrite_module的指令集?大家如果知道了这个概念，其实这两个参数的区别就挺好理解的了。
在文章的开始我们说过，ngx_http_rewrite_module模块实现了一个脚本引擎，脚本引擎执行的过程需要上下文，所有在同一个server级别的ngx_http_rewrite_module模块的指令共享同一个上下文。所有在同一个location级别的ngx_http_rewrite_module模块的指令共享同一个上下文。所以上面的当前指的就是同一个上下文。ngx_http_rewrite_module模块的指令集就是本文开头说的那几个。

来几个例子看一下，配置文件如下：
图片描述
目录结构如下:

重启nginx之后，我们请求如下接口：
图片描述
可以看到，返回的值是hello second, 为什么会这样的？

我们看上面的rewrite_log日志，发生了两次rewrite, 最终匹配到了 location /second，虽然在location /second中被重写为了 /third/2.txt，但是由于rewrite后面没有break指令，所以会继续执行下面的return指令，最终返回hello second。