526互联

Rewrite功能配置

发布时间 2023-08-23 23:04:25作者: Lz_蚂蚱

目录

Rewrite是Nginx服务器提供的一个重要基本功能，是Web服务器产品中几乎必备的功能。主要的作用是用来实现URL的重写。

注意：Nginx服务器的Rewrite功能的实现依赖于PCRE的支持，因此在编译安装Nginx服务器之前，需要安装PCRE库。Nginx使用的是ngx_http_rewrite_module模块来解析和处理Rewrite功能的相关配置。

  • Rewrite的相关命令
set指令
if指令
break指令
return指令
rewrite指令
rewrite_log指令
  • Rewrite的应用场景
域名跳转
域名镜像
独立域名
目录自动添加"/"
合并目录
防盗链的实现

"地址重写"与"地址转发"

重写和转发的区别（类似转发与重定向）：

地址重写浏览器地址会发生变化而地址转发则不变
一次地址重写会产生两次请求而一次地址转发只会产生一次请求
地址重写到的页面必须是一个完整的路径而地址转发则不需要
地址重写因为是两次请求所以request范围内属性不能传递给新页面而地址转发因为是一次请求所以可以传递值
地址转发速度快于地址重写

Rewrite规则

set指令

该指令用来设置一个新的变量。

  • 语法：

set $variable value;

  • 默认值：

—

  • 位置：

server、location、if

属性 说明
variable 变量的名称，该变量名称要用 "$" 作为变量的第一个字符，且不能与Nginx服务器预设的全局变量同名。
value 变量的值，可以是字符串、其他变量或者变量的组合等。 
server {
        listen 8081;
        server_name localhost;
        location /test-rewrite {
                set $name mazha;
                set $age 26;
                default_type text/plain;
                return 200 $name===$age;
        }
    }

Rewrite常用全局变量

变量 说明
$args 变量中存放了请求URL中的请求参数。比如http://192.168.200.133:8080?arg1=value1&args2=value2中的"arg1=value1&arg2=value2"，功能和 $query_string一样。示例：
$http_user_agent 变量存储的是用户访问服务的代理信息(如果通过浏览器访问，记录的是浏览器的相关版本信息)，示例：
$host 变量存储的是访问服务器的server_name值。示例：
$document_uri 变量存储的是当前访问地址的URI。比如http://192.168.200.133/server?id=10&name=zhangsan中的"/server"，功能和$uri一样
$document_root 变量存储的是当前请求对应location的root值，如果未设置，默认指向Nginx自带html目录所在位置
$content_length 变量存储的是请求头中的Content-Length的值
$content_type 变量存储的是请求头中的Content-Type的值
$http_cookie 变量存储的是客户端的cookie信息，可以通过add_header Set-Cookie 'cookieName=cookieValue'来添加cookie数据
$limit_rate 变量中存储的是Nginx服务器对网络连接速率的限制，也就是Nginx配置中对limit_rate指令设置的值，默认是0，不限制。
$remote_addr 变量中存储的是客户端的IP地址
$remote_port 变量中存储了客户端与服务端建立连接的端口号
$remote_user 变量中存储了客户端的用户名，需要有认证模块才能获取
$scheme 变量中存储了访问协议
$server_addr 变量中存储了服务端的地址
$server_name 变量中存储了客户端请求到达的服务器的名称
$server_port 变量中存储了客户端请求到达服务器的端口号
$server_protocol 变量中存储了客户端请求协议的版本，比如"HTTP/1.1"
$request_body_file 变量中存储了发给后端服务器的本地文件资源的名称
$request_method 变量中存储了客户端的请求方式，比如"GET"，"POST"等
$request_filename 变量中存储了当前请求的资源文件的路径名
$request_uri 变量中存储了当前请求的URI，并且携带请求参数，比如http://192.168.200.133/server?id=10&name=zhangsan中的"/server?id=10&name=zhangsan"

上述参数还可以在日志文件中使用，这个就要用到log_format指令。

if指令

该指令用来支持条件判断，并根据条件判断结果选择不同的Nginx配置。

⚠注意：if 与 圆括号之间必须有一个空格

  • 语法：

if (condition)

  • 默认值：

—

  • 位置：

server、location

  • condition为判定条件，可以支持以下写法：

1、变量名。如果变量名对应的值为空或者是0，if都判断为false，其他条件为true。

if ($param){
	
}

2、使用 "=" 和 "!=" 比较变量和字符串是否相等，满足条件为true，不满足为false。

⚠注意：此处和Java不太一样的地方是字符串不需要添加引号，并且等号和不等号前后到需要加空格。

if ($request_method = POST){
	return 405;
}

3、使用正则表达式对变量进行匹配，匹配成功返回true，否则返回false。变量与正则表达式之间使用"~"、"~*"、"!~"、"!~*"来连接。

~ ：代表匹配正则表达式过程中区分大小写

~* ：代表匹配正则表达式过程中不区分大小写

!~和!~* ：刚好和上面取相反值，如果匹配上返回false，匹配不上返回true

⚠注意：正则表达式字符串一般不需要加引号，但是如果字符串中包含"}"或者是";"等字符时，就需要把引号加上。

if ($http_user_agent ~ MSIE){
	#$http_user_agent的值中是否包含MSIE字符串，如果包含返回true
}

4、判断请求的文件是否存在，使用"-f"和"!-f"

当使用 -f 时，如果请求的文件存在返回true，不存在返回false。

当使用 !-f 时，如果请求文件不存在，但该文件所在目录存在返回true，文件和目录都不存在返回true，如果文件存在返回false

if (-f $request_filename){
	#判断请求的文件是否存在
}
if (!-f $request_filename){
	#判断请求的文件是否不存在
}

5、判断请求的目录是否存在，使用"-d"和"!-d",

当使用 -d 时，如果请求的目录存在，返回true，如果目录不存在则返回false

当使用 !-d 时，如果请求的目录不存在但该目录的上级目录存在则返回true，该目录和它上级目录都不存在则返回true，如果请求目录存在也返回false

6、判断请求的目录或者文件是否存在，使用"-e"和"!-e"

当使用 -e ，如果请求的目录或者文件存在时，返回true，否则返回false

当使用 !-e ，如果请求的文件和文件所在路径上的目录都不存在返回true，否则返回false

7、判断请求的文件是否可执行，使用"-x"和"!-x"

当使用 -x ，如果请求的文件可执行，返回true，否则返回false

当使用 !-x ，如果请求文件不可执行，返回true，否则返回false

break指令

该指令用于中断当前相同作用域中的其他Nginx配置。与该指令处于同一作用域的Nginx配置中，位于它前面的指令配置生效，位于后面的指令配置无效。并且break还有另外一个功能就是终止当前的匹配并把当前的URI在本location进行重定向访问处理。

  • 语法：

break;

  • 默认值：

—

  • 位置：

server、location、if

location /testbreak{
	default_type text/plain;
	set $username TOM;
	if ($args){
		Set $username JERRY;
        break;
		set $username ROSE;
	}
	add_header username $username;
	return 200 $username;
}
  • 参数不存在

  • 参数存在

  • 参数存在请求错误原因

查看nginx错误日志：

为什么请求参数存在却返回404目录或文件找不到的错误呢？原因是break还有另外一个功能就是终止当前的匹配并把当前的URI在本location进行重定向访问处理，我们没有配置请求的路径root，则默认从安装目录下html目录查找，查找的（重定向）路径：nginx安装目录/html/testbreak，也就是日志中提示的路径/usr/local/nginx/html/testbreak，我们在html目录下创建 testbreak目录，并且创建一个index.html文件来返回提示信息，再次测试查看结果：

<h2>request success</h2>

return指令

该指令用于完成对请求的处理，直接向客户端返回响应状态码。在return后的所有Nginx配置都是无效的。

  • 语法：

return code [text];

return code URL;

return URL;

  • 默认值：

—

  • 位置：

server、location、if

属性 说明
code 为返回给客户端的HTTP状态代理。可以返回的状态代码为 0~999 的任意HTTP状态代理
text 为返回给客户端的响应体内容，支持变量的使用
URL 为返回给客户端的URL地址 
location /testreturn {

	return 200 success;
}

location /testreturn {

	return https://www.baidu.com; // 302重定向到百度
}

location /testreturn {
	return 302 https://www.baidu.com;
}

location /testreturn {
	return 302 www.baidu.com; //不允许这么写
}

rewrite指令

该指令通过正则表达式的使用来改变URI。可以同时存在一个或者多个指令，按照顺序依次对URL进行匹配和处理。

  • 语法：

rewrite regex replacement [flag];

  • 默认值：

—

  • 位置：

server、location、if

属性 说明
regex 用来匹配URI的正则表达式
replacement 匹配成功后，用于替换URI中被截取内容的字符串。如果该字符串是以"http://"或者"https://"开头的，则不会继续向下对URI进行其他处理，而是直接返回重写后的URI给客户端。 
server {
        listen 8081;
        server_name 127.0.0.1;
        location /rewrite {
                # 以/rewrite开头，后面是/url及任意个字符匹配成功后，请求后面百度的网址
                rewrite ^/rewrite/url\w*$ https://www.baidu.com;
                # 以/rewrite开头，后面是/test及任意个字符匹配成功后，转到/test的location块中
                rewrite ^/rewrite/(test)\w*$ /$1;
                rewrite ^/rewrite/(demo)\w*$ /$1;
        }
        location /test{
                default_type text/plain;
                return 200 test_success;
        }
        location /demo{
                default_type text/plain;
                return 200 demo_success;
        }
}

情况1：地址栏输入192.168.56.108:8081/rewrite/urlaaa，跳转到百度主页。控制台请求302重定向到百度。

情况2：地址栏输入http://192.168.56.108:8081/rewrite/test，页面打印/test的location块的内容。

情况3：地址栏输入http://192.168.56.108:8081/rewrite/demo，页面打印/demo的location块的内容。

属性 说明
flag 用来设置rewrite对URI的处理行为

可选值有如下：

  • last

终止继续在本location块中处理接收到的URI，并将此处重写的URI作为一个新的URI，使用各location块进行处理。该标志将重写后的URI重新在server块中执行，为重写后的URI提供了转入到其他location块的机会。

server {
	location rewrite {
		rewrite ^/rewrite/(test)\w*$ /$1 last;
		rewrite ^/rewrite/(demo)\w*$ /$1 last;
	}
	location /test{
		default_type text/plain;
		return 200 test_success;
	}
	location /demo{
		default_type text/plain;
		return 200 demo_success;
	}
}

访问 http://192.168.200.133:8081/rewrite/testabc，能正确访问

  • break

将此处重写的URI作为一个新的URI，在本块中继续进行处理。该标志将重写后的地址在当前的location块中执行，不会将新的URI转向其他的location块。

location rewrite {
    #/test   /usr/local/nginx/html/test/index.html
	rewrite ^/rewrite/(test)\w*$ /$1 break;
	rewrite ^/rewrite/(demo)\w*$ /$1 break;
}
location /test{
	default_type text/plain;
	return 200 test_success;
}
location /demo{
	default_type text/plain;
	return 200 demo_success;
}

访问 http://192.168.200.133:8081/rewrite/demoabc，页面报404错误。是因为在当前location块中执行不转向其他location，nginx默认是从安装目录下html目录找index.html，找不到所以报404错误。根据错误日志也可以看到请求错误的路径。

  • redirect

将重写后的URI返回给客户端，状态码为302，指明是临时重定向URI，主要用在replacement变量不是以"http://"或者"https://"开头的情况。

location rewrite {
	rewrite ^/rewrite/(test)\w*$ /$1 redirect;
	rewrite ^/rewrite/(demo)\w*$ /$1 redirect;
}
location /test{
	default_type text/plain;
	return 200 test_success;
}
location /demo{
	default_type text/plain;
	return 200 demo_success;
}

访问http://192.168.200.133:8081/rewrite/testabc请求会被临时重定向，状态码302，浏览器地址也会发生改变。

  • permanent

将重写后的URI返回给客户端，状态码为301，指明是永久重定向URI，主要用在replacement变量不是以"http://"或者"https://"开头的情况。

location rewrite {
	rewrite ^/rewrite/(test)\w*$ /$1 permanent;
	rewrite ^/rewrite/(demo)\w*$ /$1 permanent;
}
location /test{
	default_type text/plain;
	return 200 test_success;
}
location /demo{
	default_type text/plain;
	return 200 demo_success;
}

访问http://192.168.200.133:8081/rewrite/testabc请求会被永久重定向，浏览器地址也会发生改变

rewrite_log指令

该指令配置是否开启URL重写日志的输出功能。

  • 语法：

rewrite_log on | off;

  • 默认值：

rewrite_log off;

  • 位置：

http、server、location、if

开启后，URL重写的相关日志将以notice级别输出到error_log指令配置的日志文件汇总。

rewrite_log on;
error_log  logs/error.log notice; # 配置error_log日志级别，不配日志不展示