Nginx 的 rewrite 指令可以用来修改 URI的请求。通过 rewrite,你可以重定向 URL 请求、修改 URL 参数、或者根据特定条件进行URL跳转 等操作。Nginx 重写规则用于更改客户端请求的全部或部分URL。更改URL的主要目的是通知客户端他们正在查找的资源已经更改了位置。Nginx 中的return和rewrite指令是用来重写URL的。
url重写可以使用rewrite、return、if、break、set几个指令来完成
重写语法
rewrite指令可以出现在server、location和if块里。
语法:
rewrite regex replacement [flag]
regex:用来匹配客户端请求url地址
replacement:如果请求地址匹配regex表达式,则会被重写成replacement地址
flag:决定是否需要对重写指令进行更多的处理。取值有4个
-
last:停止处理当前重写指令,Nginx 将会停止当前 server 块内的 rewrite 指令处理,并根据重写后的 URI 重新匹配 location。last 标志通常用于结束当前的 rewrite 处理,并将控制权交给下一个 location。默认值是last。
-
break:使用 break 标志表示停止执行当前 server 块内的 rewrite 指令,并立即将处理流程返回到 Nginx 的核心模块,跳过后续的 rewrite 或其他指令。break 可以用于防止无限循环重定向或在特定条件下提前结束重写处理。
-
redirect:返回一个临时重定向302,一般内部重定向,不是以http://或https://协议开头
-
permanent:permanent是永久的意思,使用 permanent 标志会发送 301 永久重定向响应给客户端,告诉客户端请求的资源永久移动到了新的位置。客户端会缓存这个重定向,下次访问时会直接跳转到新的地址。
例子
location / {rewrite ^/(.*)$ https://www.baidu.com/s?wd=$1 permanent;
}
请求的路径会作为关键词跳转到百度进行搜索,浏览器会返回301重定向。
正则中^和$表示匹配路径的开始和结束。 (.*)表示匹配所有,后面跳转使用的
$1表示正则匹配的第一个group。也就是 (.*)内容,多个组使用 \ $1、$2这种依次按顺序取值
location /redirect {rewrite ^/redirect(.*)$ /redirect?id=$1;
}
上面的访问/redirect/1 会重定向到 /redirect?id=1。没有指定flag,默认为last。重写后的url会继续进行location匹配还是进入当前location,这样造成了无限循环重定向。所以这里应该指定flag为break。
location /aa {rewrite ^/aa/(.*)$ /bb/$1 redirect;rewrite ^.*$ /cc redirect;}
上面的/aa请求会被重定向到/bb请求。302临时重定向,客户端url地址会变。
条件重写
rewrite重写可以结合if命令进行条件判断
if语法
if (condition) { ... }
可以使用在server和location块。
condition判断可以使用nginx中内置的变量。
可以使用 = 或 !=号来进行等值判断。
可以使用~
进行正则匹配,~
大小写敏感,~*
大小写不敏感。也可以使用!~
进行取反。
if处理对值进行匹配还可以进行文件或目录的判断
-f或 !-f来判断文件存不存在
-d或 !-d来判断文件目录是否存在
-e或!-e来判断文件或目录是否存在
常用的内置变量:
$scheme:请求的协议,如 http 或 https
$remote_addr:客户端的 IP 地址
$args:请求中的参数部分
$request_method:HTTP 请求方法,如 GET、POST 等
$http_user_agent:客户端的 User-Agent 字段
$request_uri:包含请求参数的原始 URI
$request_filename:当前请求的文件路径。
$http_referer:客户端的 Referer 头字段
$status:响应的状态码
更多变量可以查看nginx官网:Alphabetical index of variables (nginx.org)
例子:
判断是否是ie浏览器
if ($http_user_agent ~ MSIE) {rewrite ^(.*)$ /msie/$1 break;
}
禁止GET请求
if ($request_method = GET) {return 403;
}
禁止某个IP访问
if ($remote_addr = 192.168.1.111) {return 403;
}
判断请求host进行跳转
if ($http_host = test.com) {rewrite (.*) https://www.test.com$1;
}
判断请求文件存在
if (!-e $request_filename) {rewrite ^(.*)$ /index.php?s=$1 last;break;}
另外在if中还可以使用set命令来设置变量
set $variable value;
如:
if ($args ~ "^id=(.*)&lang=(.*)") {set $id $1;set $lang $2;rewrite ^/page.php$ /page/$lang/$id? permanent;
}
从请求参数$args中提取参数值,然后rewrite到后续的页面。
set命令不仅可以在if块中使用,也可以在server和location块中来定义变量。
return语句
return语句已经多次使用,语法如下
return code [text];
return code URL;
return URL;
这里不在多说了。
rewrite支持记录重定向日志记录
rewrite_log on;
error_log /var/log/nginx/error.log notice;
配置rewrite_log on开启rewrite log。rewrite log会以notice类型记录在error日志中。