ngx_http_rewrite_module
- nginx中ngx_http_rewrite_module模块提供URI重写功能 ，通过正则表达式匹配目标URI，再重写URI请求。
- 这个模块包含break、if、return、rewrite、set指令。
break指令
- 可用在server、location、if块中。
- 用于停止处理当前ngx_http_rewrite_module指令集。
return指令
- 用于停止处理并立即返回到客户端，非标准状态码444会导致连接关闭。
- 从0.8.42版本开始，可以返回重定向(状态码为：301,302,303,307,308)，重定向的URI可以是当前服务中的URI，完整的URL根据请求协议$scheme生成。可以返回响应内容，响应内容和重定向的URL中可以包含变量。
- 可以用在server，location，if块中。
- 在0.7.51以前的版本只能返回以下指定的状态码：204，400，402，406，408，410，411，413，416，500，504。
- 1.1.16和1.0.13以前的版本中307不当作重定向处理。
- 1.13.0以前的版本中308不当作重定向处理。
- return用法
- return code [text]; 返回状态码和响应内容。
- return code URL; 返回重定向，code只能为301,302,303,307,308。
- return URL; 返回重定向，状态码默认为302。
- 案例
- 配置文件server { listen 86; server_name 192.168.1.166; location /home { return 200 "home page"; } location /index { return 301 /home; } location /baidu { return https://www.baidu.com; }}
- 测试
- 请求：GET http://192.168.1.166:86/home，响应：200 home page
- 请求：GET http://192.168.1.166:86/index，响应：301 http://192.168.1.166:86/home
- 请求：GET http://192.168.1.166:86/baidu，响应：302 https://www.baidu.com
rewrite指令
- 语法：rewrite regex replacement [flag]; ，rewrite指令按它在配置文件中出现的先后顺序执行。
- 正则表达式匹配成功URI后按replacement设置的文本替换原URI，如果replacement替换文本以http://或https://或$scheme开头则会停止处理并返回给客户端重定向。
- 可以用在server, location, if块中。
- 可以使用flag来终止指令进一步执行。flag可以为：
- last，停止处理当前指令集，搜索新的location，使用新的uri直接响应，响应状态码由新的uri确定，而不是返回重定向。
- break，停止处理当前指令集，但不会搜索新的location。
- redirect，如果replacement不以http:// https:// $scheme开头返回临时重定向，状态码为302。
- permanent，返回永久重定向，状态码为301。
- 案例
- rewrite配合last，rewrite正则表达式匹配成功后会继续搜索location，搜索到以后使用新的uri直接响应，而并不会向客户端返回重定向的响应。
- 配置文件server { rewrite_log on;# 配置后日志中可查看重写前后的uri error_log /usr/local/nginx/logs/error.log notice; listen 86; server_name 192.168.1.166; location ~ ^/music/(\d+)\.mp3$ { return 200 "/music/$1.mp3"; } location ~ ^/video/(\d+)\.mp4$ { return 200 "/video/$1.mp4"; }# server块内的rewrite rewrite ^/download/mp3/(\d+)\.mp3$ /music/$1.mp3 last; rewrite ^/download/mp4/(\d+)\.mp4$ /video/$1.mp4 last;}
- 测试
- 请求：GET http://192.168.1.166:86/download/mp3/001.mp3，响应：200 /music/001.mp3，这里状态码是200而不是3打头的重定向，效果类似于代理。
- 请求：GET http://192.168.1.166:86/download/mp4/001.mp4，响应：200 /video/001.mp4，这里状态码是200而不是3打头的重定向。
- rewrite配合break，匹配成功后不会从location中搜索而是尝试从文件系统中读取
- 配置文件server { rewrite_log on; error_log /usr/local/nginx/logs/error.log notice; listen 86; server_name 192.168.1.166; location ~ ^/music/(\d+)\.mp3$ { return 200 "/music/$1.mp3"; } location ~ ^/video/(\d+)\.mp4$ { return 200 "/video/$1.mp4"; } location /download/ { rewrite ^/download/mp3/(\d+)\.mp3$ /music/$1.mp3 break; rewrite ^/download/mp4/(\d+)\.mp4$ /video/$1.mp4 break; }}
- 测试
- 请求：GET http://192.168.1.166:86/download/mp3/001.mp3，响应：404 Not Found。
- 处理过程：/download/mp3/001.mp3重写为/music/001.mp3,但不会匹配别的location而是尝试从文件目录/usr/local/nginx/html/music/001.mp3中读取，站点根目录下没有这个文件所以返回404。
- nginx日志：^/download/mp3/(\d+)\.mp3$" matches "/download/mp3/001.mp3，rewritten data: "/music/001.mp3，open() "/usr/local/nginx/html/music/001.mp3" failed (2: No such file or directory)。
- rewrite不带flag
- 配置文件server { rewrite_log on; error_log /usr/local/nginx/logs/error.log notice; listen 86; server_name 192.168.1.166; location /test1 { rewrite ^/test1/(.+)$ /test2/$1 last; } location /test2 { rewrite ^/test2/(.+)$ /test3/$1; return 200 "/test2/$1"; } location /test3 { return 200 "/test3"; }}
- 测试
- 请求：http://192.168.1.166:86/test1/order，响应：200 /test2/order。
- 处理过程：/test1/order在/test1块中被重写为/test2/order,进入/test2块中后被重写为/test3/order但因为rewrite ^/test2/(.+)$ /test3/$1;后没有break所以执行了块内下一句return 200 "/test2/$1";，$1匹配的是order因此返回/test2/order。
- 修改/test2块内的配置，重定向以后break从而停止当前块内的处理，配置文件： location /test2 { rewrite ^/test2/(.+)$ /test3/$1 break; return 200 "/test2/$1"; }
- 准备测试文件，echo "1.html" > /usr/local/nginx/html/test3/1.html
- 重新测试
- 请求：GET http://192.168.1.166:86/test1/1.html，响应：200 1.html
- 处理过程：/test2块中重写为/test3/1.html，break以后不会搜索别的location因此没有进入/test3块内，而是从文件目录中读取1.html返回。
- rewrite配合redirect
- 配置文件server { rewrite_log on; error_log /usr/local/nginx/logs/error.log notice; listen 86; server_name 192.168.1.166; location ~ ^/music/(\d+)\.mp3$ { return 200 "/music/$1.mp3"; } rewrite ^/download/mp3/(\d+)\.mp3$ /music/$1.mp3 redirect;}
- 测试
- 请求：GET http://192.168.1.166:86/download/mp3/001.mp3，响应：302 http://192.168.1.166:86/music/001.mp3。
- redirect与last的区别：last会使用新的uri直接响应，而redirect会向客户端返回重定向，如下图：
- rewrite配合permanent
- 配置文件server { rewrite_log on; error_log /usr/local/nginx/logs/error.log notice; listen 86; server_name 192.168.1.166; location ~ ^/music/(\d+)\.mp3$ { return 200 "/music/$1.mp3"; } rewrite ^/download/mp3/(\d+)\.mp3$ /music/$1.mp3 permanent;}
- 测试
- 请求：GET http://192.168.1.166:86/download/mp3/001.mp3，响应：301 http://192.168.1.166:86/music/001.mp3
- permanent与redirect区别：返回状态码不同，permanent返回301永久重定向，redirect返回临时重定向302