nginx服务(七)_ngx_http_rewrite_module的配置使用

Nginx服务器利用ngx_http_rewrite_module 模块解析和处理rewrite请求，此功能依靠PCRE(perl compatibleregularex pression)，因此编译之前要安装PCRE库，rewrite是nginx服务器的重要功能之一，用于实现URL的重写，URL的重写是非常有用的功能，比如它可以在我们改变网站结构之后，不需要客户端修改原来的书签，也无需其他网站修改我们的链接，就可以设置为访问，另外还可以在一定程度上提高网站的安全性。

文档: https://nginx.org/en/docs/http/ngx_http_rewrite_module.html

---

       rewrite指令
       if指令
       set指令
       break指令
       return指令
       rewrite_log指令

---

rewrite指令：

通过正则表达式的匹配来改变URI，可以同时存在一个或多个指令，按照顺序依次对URI进行匹配，rewrite主要是针对用户请求的URL或者是URI做具体处理，以下是URL和URI的具体介绍：

URI(universal resource identifier)：通用资源标识符，标识一个资源的路径，可以不带协议。
URL(uniform resource location):统一资源定位符，是用于在Internet中描述资源的字符串，是URI的子集，
主要包括传输协议(scheme)、主机(IP、端口号或者域名)和资源具体地址(目录和文件名)等三部分
一般格式为:scheme://主机名[:端口号][/资源路径],如：http://www.a.com:8080/path/file/index.html就是一个URL路径，URL必须带访问协议。

注: 每个URL都是一个URI，但是URI不都是URL。

---

rewrite regex replacement [flag]将用户请求的URI基于regex所描述的模式进行检查，匹配到时将其替换为replacement指定的新的URI；

[flag]：
       last：重写完成后停止对当前URI在当前location中后续的其它重写操作，而后对新的URI启动新一轮重写检查；提前重启新一轮循环； （循环再循环，不满足就退出循环）
       break：重写完成后停止对当前URI在当前location中后续的其它重写操作，而后直接跳转至重写规则配置块之后的其它配置（包括alias）；（结束循环；满足，就直接退出，做后面的其他事）
       redirect：以302响应码(临时重定向)重写完成后以临时重定向方式直接返回重写后生成的新URI给客户端，由客户端重新发起请求，不能以http://或https://开头；
       permanent:以301响应码(永久重定向)重写完成后以永久重定向方式直接返回重写后生成的新URI给客户端，由客户端重新发起请求；

注意：
1、如果在同一级配置块中存在多个rewrite规则，那么会自下而下逐个检查，被某条件规则替换完成后，会重新一轮的替换检查，因此，隐含有循环机制，但不超过10次；如果超过，提示500响应码，[flag]所表示的标志位用于控制此循环机制；

2、如果replacement是以http://或https://开头，则替换结果会直接以301：永久重定向返回给客户端；

例： 单向临时重定向

location / {
	root /data/nginx/html/pc;
	index index.html;
	rewrite / http://www.Internet.com redirect;
}

例：单向永久重定向

location / {
	root /data/nginx/html/pc;
	index index.html;
	rewrite / http://www.Internet.com permanent;
}

break测试：当客户端访问break的时候，测试通过rewrite将URL重写为test1，然后再通过rewrite将test1
重写为test2测试两条write规则最终哪一条生效，并且测试重写后的URL会不会到其他location重新匹配。

location /break {
	#return 666 "break";
	root /data/nginx;
	index index.html;
	rewrite ^/break/(.*) /test1/$1 break; #break匹配成功后不再向下匹配，也不会跳转到其他的location，即直接结束匹配并给客户端返回结果数据。
	rewrite ^/test1/(.*) /test2/$1 break;  #break不会匹配后面的rewrite规则也不匹配其他
	location
}
location = /test1 {
	return 999 "new test1";
	#index index.html;
	#root /data/nginx;
}
location = /test2 {
	return 666 "new test2";
	#root /opt/nginx;
	#index index.html;
}

创建资源路径：
# mkdir /data/nginx/break
# mkdir /data/nginx/test1
# mkdir /data/nginx/test2
# cat /data/nginx/break/index.html
break
# cat /data/nginx/test1/index.html
test1
# cat /data/nginx/test2/index.html
test2
# /apps/nginx/sbin/nginx -t
# /apps/nginx/sbin/nginx -s reload

break访问测试：
[root@s3 ~]# curl -L http://www.magedu.net/break/index.html
test1

#最终的结果不会超出break的location而且不会继续匹配当前location后续的write规则，而且直接返回数据给客户端。
break适用于不改变客户端访问方式，但是要将访问的目的URL做单次重写的场景，比如有V1/V2两个版本的网站前端
页面并存，旧版本的网站数据已经保存到了statics不能丢失，但是要将访问新版本的资源重写到新的静态资源路径到
新的目录static：

location /statics {
root /data/nginx;
index index.html;
rewrite ^/statics/(.*) /static/$1 break;
}

last：对某个location的URL匹配成功后会停止当前location的后续rewrite规则，并结束当前location，然后
将匹配生成的新URL跳转至其他location继续匹配，直到没有location可匹配后将最后一次location的数据返回给
客户端。

location /test1 {
#return 999 "new test1";
index index.html;
root /data/nginx;
rewrite ^/test1/(.*) /test2/$1 last;
}
location /test2 {
return 666 "new test2";
#root /opt/nginx;
#index index.html;
}
location /last {
root /data/nginx;
index index.html;
rewrite ^/last/(.*) /test1/$1 last;
#rewrite ^/test1/(.*) /test2/$1 last; #如果第一条rewrite规则匹配成功则不执行本条，否则执
行本条rewrite规则。
}

last访问测试：
[root@s3 ~]# curl -L http://www.magedu.net/last/index.html
new test2 #会匹配多个location，直到最终全部匹配完成，返回最后一个location的匹配结果给客户端。

last适用于要不改变客户端访问方式但是需做多次目的URL重写的场景，场景不是很多。

例: 自动跳转https:
不影响用户请求的情况下将http请求全部自动跳转至https，也可以实现部分location跳转。

server {
	listen 443 ssl;
	listen 80;
	ssl_certificate /apps/nginx/certs/www.test.net.crt;
	ssl_certificate_key /apps/nginx/certs/www.test.net.key;
	ssl_session_cache shared:sslcache:20m;
	ssl_session_timeout 10m;
	server_name www.test.net;
location / {
	root /data/nginx/html/pc;
	index index.html;
	if ($scheme = http ){		 #未加条件判断，会导致死循环
	rewrite / https://www.test.net permanent;
		}
	}
}

---

---

if指令：

用于条件匹配判断，并根据条件判断结果选择不同的Nginx配置，可以配置在server或location块中进行配置，Nginx的if语法仅能使用if做单次判断，不支持使用if else或者if elif这样的多重判断，用法如下：

if （条件匹配） {
	action；
}

使用正则表达式对变量进行匹配，匹配成功时if指令认为条件为true，否则认为false，变量与表达式之间使用以下符号链接

     =： #比较变量和字符串是否相等，相等时if指令认为该条件为true，反之为false。

     !=: #比较变量和字符串是否不相等，不相等时if指令认为条件为true，反之为false。

     ~： #表示在匹配过程中区分大小写字符，（可以通过正则表达式匹配），满足匹配条件为真，不满足为假。

     !~：#为区分大小写字符且匹配结果不匹配，不满足为真，满足为假。

     ~*: #表示在匹配过程中不区分大小写字符，（可以通过正则表达式匹配），满足匹配条件为真，不满足为假。

     !~*: #为不区分大小字符且匹配结果不匹配，满足为假，不满足为真。

     -f 和 ! -f: #判断请求的文件是否存在和是否不存在

     -d 和 ! -d: #判断请求的目录是否存在和是否不存在。

     -x 和 ! -x: #判断文件是否可执行和是否不可执行。

     -e 和 ! -e: #判断请求的文件或目录是否存在和是否不存在(包括文件，目录，软链接)。

    

例1: 判断访问网址的协议是否为http，如果是则echo访问的协议

location /main {
	index index.html;
	default_type text/html;
	if ( $scheme = http ){
		echo "if-----> $scheme";
	}

例2: 判断访问网址的协议是否为https，如果是则echo访问的协议

	if ( $scheme = https ){
		echo "if ----> $scheme";
	}

例3: 判断访问网址的文件及URL的path部分是否存在

	if (-f $request_filename) {
		echo "file is exist";
	}

例4: 判断访问网址的文件及URL的path部分不存在

	if (!-f $request_filename) {
		echo "file is not exist";
	return 409;
	}
}

注： 如果$变量的值为空字符串或是以0开头的任意字符串，则if指令认为该条件为false，其他条件为true。

---

set指令：

指定key并给其定义一个变量，变量可以调用Nginx内置变量赋值给key，另外set定义格式为set $key $value，及无论是key还是value都要加$符号。

location /main {
	root /data/nginx/html/pc;
	index index.html;
	default_type text/html;
	set $name magedu;
	echo $name;
	set $my_port $server_port;
	echo $my_port;
}

---

break指令：

用于中断当前相同作用域(location)中的其他Nginx配置，与该指令处于同一作用域的Nginx配置中，位于它前面的配置生效，位于后面的指令配置就不再生效了，Nginx服务器在根据配置处理请求的过程中遇到该指令的时候，回到上一层作用域继续向下读取配置，该指令可以在server块和location块以及if块中使用，使用语法如下：

location /main {
	root /data/nginx/html/pc;
	index index.html;
	default_type text/html;
	set $name admin;
	echo $name;
	break;
	set $my_port $server_port;
	echo $my_port;
}

---

return指令：

从nginx版本0.8.2开始支持，return用于完成对请求的处理，并直接向客户端返回响应状态码，比如其可以指定重定向URL(对于特殊重定向状态码，301/302等) 或者是指定提示文本内容(对于特殊状态403/500等)，处于此指令后的所有配置都将不被执行，return可以在server、if和location块进行配置，用法如下：

return code; #返回给客户端指定的HTTP状态码
return code (text); #返回给客户端的状态码及响应体内容，可以调用变量
return code URL； #返回给客户端的URL地址

例：
location /main {
	root /data/nginx/html/pc;
	default_type text/html;
	index index.html;
		if ( $scheme = http ){
		#return 666;
		#return 666 "not allow http";
		#return 301 http://www.baidu.com;
		return 500 "service error";
		echo "if-----> $scheme"; #return后面的将不再执行
		}
		if ( $scheme = https ){
		echo "if ----> $scheme";
		}
}

---

rewrite_log指令：

设置是否开启记录ngx_http_rewrite_module模块日志记录到 error_log日志文件当中，可以配置在 http、 server、 location或 if当中，需要日志级别为 notice。

例:

location /main {
	index index.html;
	default_type text/html;
	set $name magedu;
	echo $name;
	rewrite_log on;
	break;
	set $my_port $server_port;
	echo $my_port;
}

#重启nginx，访问并验证error_log：
[root@s2 ~]# tail -f /apps/nginx/logs/error.log
2019/02/27 15:10:02 [warn] 5815#0: *3 using uninitialized "my_port" variable, client:192.168.0.1, server: www.test.net, request: "GET /main HTTP/1.1", host:"www.test.net"

---