Nginx rewrite ——重写跳转

一、Nginx常见模块

• http
  http块是Nginx服务器配置中的重要部分，代理、缓存和日志定义等绝大多数的功能和第三方模块的配置都可以放在这模块中。作用包括：文件引入、MIME-Type定义、日志自定义、是否使用sendfile传输文件、连接超时时间、单连接请求数上限等。

• server
  server块，虚拟主机（虚拟服务器）。作用：使得Nginx服务器可以在同一台服务器上只要运行一组Nginx进程，就可以运行多个网站。

• location
  location块是server块的一个指令。作用：基于Nginx服务器接收到的请求字符串，虚拟主机名称（ip，域名）、url匹配，对特定请求进行处理。

二、常用的Nginx 正则表达式

^	匹配输入字符串的起始位置
$	匹配输入字符串的结束位置
*	匹配前面的字符零次或多次。如“ol*”能匹配“o”及“ol”、“oll”
+	匹配前面的字符一次或多次。如“ol+”能匹配“ol”及“oll”、“olll”，但不能匹配“o”
?	匹配前面的字符零次或一次，例如“do(es)?”能匹配“do”或者“does”，”?”等效于”{0,1}”
.	匹配除“\n”之外的任何单个字符，若要匹配包括“\n”在内的任意字符，请使用诸如“[.\n]”之类的模式
\	将后面接着的字符标记为一个特殊字符或一个原义字符或一个向后引用。如“\n”匹配一个换行符，而“$”则匹配“$”
\d	匹配纯数字
{n}	重复 n 次
{n,}	重复 n 次或更多次
{n,m}	重复 n 到 m 次
[]	定义匹配的字符范围
[c]	匹配单个字符 c
[a-z]	匹配 a-z 小写字母的任意一个
[a-zA-Z0-9]	匹配所有大小写字母或数字
()	表达式的开始和结束位置
I	或运算符

从功能看 rewrite 和 location 似乎有点像，都能实现跳转，主要区别在于 rewrite 是在同一域名内更改获取资源的路径，而location 是对一类路径做控制访问或反向代理，还可以proxy_pass 到其他机器。

三、location概述

3.1 location 分类

精准匹配：location = / {…}
一般匹配：location / {…}
正则匹配：location ~ / {…}

3.2 location 常用的匹配规则

=	进行普通字符精确匹配，也就是完全匹配
^~	表示普通字符匹配。使用前缀匹配。如果匹配成功，则不再匹配其它 location。
~	区分大小写的匹配。
~*	不区分大小写的匹配。
!~	区分大小写的匹配取非。【！：表示取反】
!~*	不区分大小写的匹配取非。
@	定义一个命名的location，使用在内部定向时

3.3 location 优先级

首先精确匹配 =
其次前缀匹配 ^~
其次是按文件中顺序的正则匹配 _或*
然后匹配不带任何修饰的前缀匹配
最后是交给 / 通用匹配

location = / {
    
    
    [ configuration A ]
}
 
location / {
    
    
    [ configuration B ]
}
 
location /documents/ {
    
    
    [ configuration C ]
}
 
location ^~ /images/ {
    
    
    [ configuration D ]
}
 
location ~* \.(gif|jpg|jpeg)$ {
    
    
    [ configuration E ]
}

3.4 location 示例

（1）location = / {
    
    }
=为精确匹配 / ，主机名后面不能带任何字符串，比如访问 / 和 /data，则 / 匹配，/data 不匹配
再比如 location = /abc，则只匹配/abc ，/abc/或 /abcd不匹配。若 location  /abc，则即匹配/abc 、/abcd/ 同时也匹配 /abc/。

（2）location / {
    
    }
因为所有的地址都以 / 开头，所以这条规则将匹配到所有请求 比如访问 / 和 /data, 则 / 匹配， /data 也匹配，
但若后面是正则表达式会和最长字符串优先匹配（最长匹配）

（3）location /documents/ {
    
    }
匹配任何以 /documents/ 开头的地址，匹配符合以后，还要继续往下搜索其它 location
只有其它 location后面的正则表达式没有匹配到时，才会采用这一条

（4）location /documents/abc {
    
    }
匹配任何以 /documents/abc 开头的地址，匹配符合以后，还要继续往下搜索其它 location
只有其它 location后面的正则表达式没有匹配到时，才会采用这一条

（5）location ^~ /images/ {
    
    }
匹配任何以 /images/ 开头的地址，匹配符合以后，停止往下搜索正则，采用这一条

（6）location ~* \.(gif|jpg|jpeg)$ {
    
    }
匹配所有以 gif、jpg或jpeg 结尾的请求
然而，所有请求 /images/ 下的图片会被 location ^~ /images/ 处理，因为 ^~ 的优先级更高，所以到达不了这一条正则

（7）location /images/abc {
    
    }
最长字符匹配到 /images/abc，优先级最低，继续往下搜索其它 location，会发现 ^~ 和 ~ 存在

（8）location ~ /images/abc {
    
    }
匹配以/images/abc 开头的，优先级次之，只有去掉 location ^~ /images/ 才会采用这一条

（9）location /images/abc/1.html {
    
    }
匹配/images/abc/1.html 文件，如果和正则location ~ /images/abc/1.html 相比，正则优先级更高

优先级总结：
(location = 完整路径) > (location ^~ 路径) > (location _,* 正则顺序) > (location 部分起始路径) > (location /)

location 匹配 ：

首先看 优先级：精确>前缀>正则>一般>通用
优先级相同：正则看上下顺序，上面的优先；一般匹配看长度，最长匹配的优先 精确、前缀、正则、一般都没有匹配到。
最后再看通用匹配

扫描二维码关注公众号，回复： 14318782 查看本文章

实际网站使用中，至少有三个匹配规则定义：

#第一个必选规则
直接匹配网站根，通过域名访问网站首页比较频繁，使用这个会加速处理，比如说官网。
可以是一个静态首页，也可以直接转发给后端应用服务器
location = / {
    
    
    root   html;
	index  index.html index.htm;
}

#第二个必选规则是处理静态文件请求，这是nginx作为http服务器的强项
有两种配置模式，目录匹配或后缀匹配,任选其一或搭配使用
location ^~ /static/ {
    
    
    root /webroot/static/;
}

location ~* \.(html|gif|jpg|jpeg|png|css|js|ico)$ {
    
    
    root /webroot/res/;
}

#第三个规则就是通用规则，比如用来转发带.php、.jsp后缀的动态请求到后端应用服务器
非静态文件请求就默认是动态请求
location / {
    
    
    proxy_pass http://tomcat_server;
}

四、rewrite概述

4.1 rewrite简介

rewrite功能： 使用nginx提供的全局变量或自己设置的变量，结合正则表达式和标记位实现URL重写以及重定向。
比如： 更换域名后需要保持旧的域名能跳转到新的域名上、某网页发生改变需要跳转到新的页面、网站防盗链等等需求。

rewrite只能放在server{},location{},if{}中，并且默认只能对域名后边的除去传递的参数外的字符串起作用， 例如
http://www.kgc.com/abc/bbs/index.php?a=1&b=2 只对/abc/bbs/index.php重写。

rewrite 只能在
server {
    
    }
location {
    
    }
if {
    
    }
中，并且默认只能对域名后边的除去传递的参数外的字符串起作用
例如：
http://www.zzh.com/abc/bbs/index.html?a=1&b=2 只针对/abc/bbs/index.html重写

4.2 Rewrite 跳转场景

Rewrite 跳转场景主要包括以下几种：

• 可以调整用户浏览的 URL，看起来更规范，合乎开发及产品人员的需求

• 为了让搜索引擎搜录网站内容及用户体验更好，企业会将动态 URL 地址伪装成静态地址提供服务。

• 网址换新域名后，让旧的访问跳转到新的域名上。例如，访问京东的 360buy.com会跳转到 jd.com

• 根据特殊变量、目录、客户端的信息进行 URL 调整等。

4.3 rewrite跳转实现

1.Nginx： 通过ngx_http_rewrite_module 模块支持URL重写、支持if条件判断，但不支持else。 跳转： 从一个 location跳转到另一个location，循环最多可以执行10次，超过后nginx将返回500错误。
2.PCRE支持： perl兼容正则表达式的语法规则匹配。另外该模块需要 PCRE 支持，应在编译 Nginx 时指定 PCRE 支持，默认已经安装。
3.重写模块 set 指令： 创建新的变量并设其值。

1.使用rewrite进行匹配跳转
2. 使用if匹配全局变量后跳转
3. 使用location匹配在跳转
 rewrite放在server{
    
    }、if{
    
    }、location{
    
    }段中
 location只对域名后边的除去传递参数外的字符串起作用。

4.4 rewrite 执行顺序

(1) 执行 server 块里面的 rewrite 指令。
(2) 执行 location 匹配。
(3) 执行选定的 location中的 rewrite 指令。

4.5 语法格式：

rewrite 《regex》 《replacement》 [flag];
regex ：表示正则匹配规则。
replacement ：表示跳转后的内容。 flag ：表示 rewrite 支持的 flag 标记。

###flag标记说明###

last ：本条规则匹配完成后，继续向下匹配新的。location URL规则，一般用在 server 和 if 中。
break ：本条规则匹配完成即终止，不再匹配后面的任何规则，一般使用在 location 中。
redirect ：返回302临时重定向，浏览器地址会显示跳转后的URL地址。    
permanent ：返回301永久重定向，浏览器地址栏会显示跳转后的URL地址。

4.6 Rewrite 实例

4.6.1 基于域名的跳转

现在公司旧域名www.kgc.com有业务需求变更，需要使用新域名www.benet.com代替，但是旧域名不能废除，需要跳转到新域名上，而且后面的参数保持不变。

vim /usr/local/nginx/conf/nginx.conf
server {
    
    
	listen       80;
	server_name  www.kgc.com;		#域名修改	
	charset utf-8;
	access_log  /var/log/nginx/www.kgc.com-access.log;		#日志修改
	location / {
    
    
	#添加域名重定向
        if ($host = 'www.kgc.com'){
    
    	
        #$host为rewrite全局变量，代表请求主机头字段或主机名
			rewrite ^/(.*)$ http://www.benet.com/$1 permanent;	
		#$1为正则匹配的内容，即“域名/”之后的字符串
        }
        root   html;
        index  index.html index.htm;
    }
}

echo “192.168.10.19 www.kgc.com www.benet.com” >> /etc/hosts systemctl
restart nginx 浏览器输入模拟访问 http://www.kgc.com/test/1.html(虽然这个请求内容是不存在的)会跳转到www.benet.com/test/1.html，查看元素可以看到返回301，实现了永久重定向跳转，而且域名后的参数也正常跳转。

4.6.2 基于客户端 IP 访问跳转

今天公司业务新版本上线，要求所有 IP 访问任何内容都显示一个固定维护页面，只有公司 IP ：192.168.10.19访问正常。

vim /usr/local/nginx/conf/nginx.conf
server {
    
    
	listen       80;
	server_name  www.kgc.com;		#域名修改	
	charset utf-8;
	access_log  /var/log/nginx/kgc.access.log;		#日志修改

	#设置是否合法的IP标记
    set $rewrite true;					#设置变量$rewrite，变量值为boole值true
    #判断是否为合法IP【remote_addr:表示客户机的ip地址】
	if ($remote_addr = "192.168.10.19"){
    
    		#当客户端IP为192.168.10.19时，将变量值设为false，不进行重写
        set $rewrite false;
    }
	#除了合法IP，其它都是非法IP，进行重写跳转维护页面
    if ($rewrite = true){
    
    						#当变量值为true时，进行重写
        rewrite (.+) /weihu.html;    #将域名后边的路径重写成/weihu.html维护，例如www.kgc.com/weihu.html【匹配一个任意的字符一次或多次  .表示任意；+表示一次或多次】
    }
    location = /weihu.html {
    
    
        root /var/www/html;	 #网页返回/var/www/html/weihu.html的内容
    }
	
	location / {
    
    
        root   html;
        index  index.html index.htm;
    }
}

mkdir -p /var/www/html/
echo "<h1>We are maintaining now!</h1>" > /var/www/html/weihu.html
systemctl restart nginx
只有 IP 为 192.168.10.19 能正常访问，其它地址都是维护页面

如果rewrite (.+) /weihu.html; 改成rewrite (.+) /weihu.html permanent;的话，如果是非 192.168.10.19 的主机访问会使浏览器修改请求访问的URL成 http://www.kgc.com/weihu.html 再请求访问，这样就会进入一直在 rewrite 的死循环，访问请求会一直被重写成
http://www.kgc.com/weihu.html 再请求访问。

4.6.3 基于旧域名跳转到新域名后面加目录

现在访问的是 http://bbs.kgc.com/post/，现在需要将这个域名下面的访问都跳转到http://www.kgc.com/bbs/post/
vim /usr/local/nginx/conf/nginx.conf
server {
    
    
	listen       80;
	server_name  bbs.kgc.com;		#域名修改	
	charset utf-8;
	access_log  /var/log/nginx/www.kgc.com-access.log;
	#添加
	location /post {
    
    
    rewrite (.+) http://www.kgc.com/bbs$1 permanent;	#这里的$1为位置变量，代表/post
    }
	
	location / {
    
    
        root   html;
        index  index.html index.htm;
    }
}

mkdir -p /usr/local/nginx/html/bbs/post
echo "this is 1.html"  >> /usr/local/nginx/html/bbs/post/1.html
echo "192.168.10.19 bbs.kgc.com"  >> /etc/hosts
systemctl restart nginx
使用浏览器访问 http://bbs.kgc.com/post/1.html 跳转到 http://www.kgc.com/bbs/post/1.html

4.6.4 基于参数匹配的跳转

现在访问http://www.kgc.com/100-(100|200)-100.html 跳转到http://www.kgc.com页面。
vim /usr/local/nginx/conf/nginx.conf
server {
    
    
	listen       80;
	server_name  www.kgc.com;		#域名修改	
	charset utf-8;
	access_log  /var/log/nginx/www.kgc.com-access.log;
	
	if ($request_uri ~ ^/100-(100|200)-(\d+).html$) {
    
    
【request：表示请求；~:表示区分大小写 ^:表示以什么开头； 100或200；\d：表示数字；+表示一个或多个；以HTML结尾】
        rewrite (.+) http://www.kgc.com permanent;
    }

	location / {
    
    
        root   html;
        index  index.html index.htm;
    }
}

$request_uri：包含请求参数的原始URI，不包含主机名，如：http://www.kgc.com/abc/bbs/index.html?a=1&b=2中的 /abc/bbs/index.php?a=1&b=2

$uri：这个变量指当前的请求URI，不包括任何参数，如:/abc/bbs/index.html
$document_uri：与$uri相同，这个变量指当前的请求URI，不包括任何传递参数，如:/abc/bbs/index.html

systemctl restart nginx 使用浏览器访问 http://www.kgc.com/100-200-100.html 或
http://www.kgc.com/100-100-100.html 跳转到http://www.kgc.com页面。

4.6.5 基于目录下所有 php 结尾的文件跳转

要求访问 http://www.kgc.com/upload/123.php 跳转到首页。
vim /usr/local/nginx/conf/nginx.conf
server {
    
    
	listen       80;
	server_name  www.kgc.com;		#域名修改	
	charset utf-8;
	access_log  /var/log/nginx/www.kgc.com-access.log;
	
	location ~* /upload/.*\.php$ {
    
       #【 upload	表示目录；.：表示任意；*：表示零个或多个；\：表示标记；只要以php结尾就行】
        rewrite (.+) http://www.kgc.com permanent;
    }

	location / {
    
    
        root   html;
        index  index.html index.htm;
    }
}

systemctl restart nginx 浏览器访问 http://www.kgc.com/upload/123.php
跳转到http://www.kgc.com页面。

4.6.6 基于最普通一条 url 请求的跳转

要求访问一个具体的页面如 http://www.kgc.com/abc/123.html 跳转到首页
vim /usr/local/nginx/conf/nginx.conf
server {
    
    
	listen       80;
	server_name  www.kgc.com;		#域名修改	
	charset utf-8;
	access_log  /var/log/nginx/www.kgc.com-access.log;
	
    location ~* ^/abc/123.html {
    
      
        rewrite (.+) http://www.kgc.com permanent;
    }

	location / {
    
    
        root   html;
        index  index.html index.htm;
    }
}

systemctl restart nginx 浏览器访问 http://www.kgc.com/abc/123.html
跳转到http://www.kgc.com页面。

五、Nginx配置中的log_format用法梳理（设置详细的日志格式）

nginx服务器日志相关指令主要有两条： 一条是log_format，用来设置日志格式；另外一条是access_log，用来指定日志文件的存放路径、格式和缓存大小，可以参加ngx_http_log_module。一般在nginx的配置文件中日记配置(/usr/local/nginx/conf/nginx.conf)。

在日志格式样式中，变量$remote_addr和$http_x_forwarded_for用于记录IP地址；
$remote_user用于记录远程客户端用户名称；
$time_local用于记录访问时间与时区；
$request用于记录请求URL与HTTP协议；
$status用于记录请求状态，例如成功时状态为200，页面找不到时状态为404；
$body_bytes_sent用于记录发送客户端的文件主体内容大小；
$http_referer用于记录是从哪个页面链接访问过来的；
$http_user_agent用于记录客户浏览器的相关信息。

想要记录更详细的信息需要自定义设置log_format，具体可设置的参数格式及说明如下：

参数                      说明                                         示例
$remote_addr             客户端地址                                    211.28.65.253
$remote_user             客户端用户名称                                --
$time_local              访问时间和时区                                18/Jul/2012:17:00:01 +0800
$request                 请求的URI和HTTP协议                           "GET /article-10000.html HTTP/1.1"
$http_host               请求地址，即浏览器中你输入的地址（IP或域名）     www.wang.com 192.168.100.100
$status                  HTTP请求状态                                  200
$upstream_status         upstream状态                                  200
$body_bytes_sent         发送给客户端文件内容大小                        1547
$http_referer            url跳转来源                                   https://www.baidu.com/
$http_user_agent         用户终端浏览器等信息                           "Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 5.1; Trident/4.0; SV1; GTB7.0; .NET4.0C;
$ssl_protocol            SSL协议版本                                   TLSv1
$ssl_cipher              交换数据中的算法                               RC4-SHA
$upstream_addr           后台upstream的地址，即真正提供服务的主机地址     10.10.10.100:80
$request_time            整个请求的总时间                               0.205
$upstream_response_time  请求过程中，upstream响应时间                    0.002

本章总结

• Nginx Rewrite 概述
• Nginx Rewrite基本操作
• location用法

喜欢小编的可以点个小星星哦！！！