重写和转发的区别

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

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

重写Rewrite 转发 foward
浏览器地址 变化 不变
请求数 两次 一次
路径要求 完整的路径 不要求
速度 快于地址重写
request范围内属性 不能传递 可以传递

set指令

  • 官方说明：

  • 用途： 用于设置一个新的变量。

    • variable:变量的名称，该变量名称要用”$“作为变量的第一个字符，且不能与Nginx服务器预设的全局变量同名。

      value:变量的值，可以是字符串、其他变量或者变量的组合等。

    1
    2
    3
    语法	set $variable value;
    默认值	—
    位置	server、location、if

  • 示例：如果请求的 User-Agent 头包含 MSIE，则 $user_agent 变量将被设置为 “msie”，否则它将保持为空字符串。然后，这个变量的值将被包含在返回的响应体中。

    1
    2
    3
    4
    5
    6
    7
    location /test {  
        set $user_agent "";  
        if ($http_user_agent ~ MSIE) {  
            set $user_agent "msie";  
        }  
        return 200 "User Agent: $user_agent";  
    }

if指令

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

  • 官方说明：http://nginx.org/en/docs/http/ngx_http_rewrite_module.html#if

  • 语法

    1
    2
    3
    语法	if (condition)
    默认值	—
    位置	server、location

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

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    # 变量名。如果变量名对应的值为空或者是0，if都判断为false,其他条件为true。
    if ($param){
    	
    }

    #  使用"="和"!="比较变量和字符串是否相等，满足条件为true，不满足为false
    # 此处和Java不太一样的地方是字符串不需要添加引号。
    if ($request_method = POST){
    	return 405;
    }

    # 使用正则表达式对变量进行匹配，匹配成功返回true，否则返回false。
    # 变量与正则表达式之间使用 ~ , ~* ,! ,!* 来连接。
    # "~"代表匹配正则表达式过程中区分大小写，
    # "~*"代表匹配正则表达式过程中不区分大小写
    # "!" 和"!*"刚好和上面取相反值，如果匹配上返回false,匹配不上返回true
    if ($http_user_agent ~ MSIE){
    	#$http_user_agent的值中是否包含MSIE字符串，如果包含返回true
    }

    # 正则表达式中包含 } 或 ; 等字符，整个表达式应该用单引号或双引号括起来。

    # 判断请求的文件是否存在使用"-f"和"!-f",
    # 当使用"-f"时，如果请求的文件存在返回true，不存在返回false。
    # 当使用"!f"时，如果请求文件不存在，但该文件所在目录存在返回true,文件和目录都不存在返回false,如果文件存在返回false
    if (-f $request_filename){
    	#判断请求的文件是否存在
    }
    if (!-f $request_filename){
    	#判断请求的文件是否不存在
    }

    # 判断请求的目录是否存在使用"-d"和"!-d",
    # 当使用"-d"时，如果请求的目录存在，if返回true，如果目录不存在则返回false
    # 当使用"!-d"时，如果请求的目录不存在但该目录的上级目录存在则返回true，该目录和它上级目录都不存在则返回false,如果请求目录存在也返回false.

    # 判断请求的目录或者文件是否存在使用"-e"和"!-e"
    # 当使用"-e",如果请求的目录或者文件存在时，if返回true,否则返回false.
    # 当使用"!-e",如果请求的文件和文件所在路径上的目录都不存在返回true,否则返回false

    # 判断请求的文件是否可执行使用"-x"和"!-x"
    #当使用"-x",如果请求的文件可执行，if返回true,否则返回false
    # 当使用"!-x",如果请求文件不可执行，返回true,否则返回false
    • 变量比较，如：$variable = value。
    • 变量与正则表达式的匹配， 如：$variable ~ pattern。
    • 逻辑操作：!（非）、 -f（文件存在）、 -d（目录存在）、 -e（文件、目录、符号链接存在）、 -x（可执行文件存在）等。
    • 正则表达式中包含 “}” 或 “;” 字符，整个表达式应该用单引号或双引号括起来。

  • 上下文配置 :

    • if 指令在server 和 location 上下文使用。

  • 示例1：针对MSIE浏览器的重定向

    1
    2
    3
    4
    5
    6
    # 当请求的User-Agent头包含MSIE（Internet Explorer的旧版本）时
    # Nginx 会将请求重写为 /msie/ 加上原始请求的路径，并停止处理后续的重写规则（break标志）。

    if ($http_user_agent ~ MSIE) {  
        rewrite ^(.*)$ /msie/$1 break;  
    }

  • 示例2：从Cookie中提取ID

    1
    2
    3
    4
    5
    6
    7
    # 使用正则表达式从Cookie头中提取id的值。
    # 如果Cookie中包含形如id=some_value;或id=some_value的片段，那么变量$id将被设置为some_value。


    if ($http_cookie ~* "id=([^;]+)(?:;|$)") {  
        set $id $1;  
    }

  • 示例3：禁止POST方法

    1
    2
    3
    4
    5
    # 如果请求的方法是 POST，Nginx 将返回405状态码（方法不允许）。
    # 这通常用于确保某个位置或服务器仅支持 GET 或其他 HTTP 方法，而不支持 POST。
    if ($request_method = POST) {  
        return 405;  
    }

  • 示例4：基于$slow变量的带宽限制

    1
    2
    3
    4
    5
    # 如果变量 $slow 为真（需要在其他地方定义或根据其他条件设置），Nginx 将限制发送到客户端的响应速度为每秒10KB。用于防止在慢速连接上发送大量数据，或在某些条件下有意地限制带宽。

    if ($slow) {  
        limit_rate 10k;  
    }

  • 示例5：基于$invalid_referer的访问控制

    1
    2
    3
    4
    5
    6
    # 如果变量 $invalid_referer 为真（表示请求的 Referer 头无效或不存在，或者不符合某些预期的模式），Nginx 将返回 403 状态码（禁止访问）。常用于防止热链接、保护资源或实施其他基于 Referer 的访问控制策略。


    if ($invalid_referer) {  
        return 403;  
    }

break指令

该指令用于中断当前相同作用域中的其他Nginx配置。与该指令处于同一作用域的Nginx配置中，位于它前面的指令配置生效，位于后面的指令配置无效。

1
2
3
语法	break;
默认值	—
位置	server、location、if
1
2
3
4
5
6
7
location /{
	if ($param){
		set $id $1;
		break;
		limit_rate 10k;
	}
}

return指令

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

1
2
3
4
5
6
7
8
9
10
语法
    return code [text];
    return code URL;
    return URL;
默认值	—
位置	server、location、if

# code:为返回给客户端的HTTP状态代理。可以返回的状态代码为0~999的任意HTTP状态代理
# text:为返回给客户端的响应体内容，支持变量的使用
# URL:为返回给客户端的URL地址

rewrite指令

  • 官方说明：http://nginx.org/en/docs/http/ngx_http_rewrite_module.html#rewrite。

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

    1
    2
    3
    4
    5
    6
    7
    语法	rewrite regex replacement [flag];
    默认值	—
    位置	server、location、if
    # regex：用于匹配URI的正则表达式。
    # replacement:匹配成功后，用于替换URI中被截取内容的字符串。
    # 如果该字符串是以"http://"或者"https://"开头的，则不会继续向下对URI进行其他处理，而是直接返回重写后的URI给客户端。。
    # flag：指定如何处理替换后的URI的标志。

  • 标志（Flags）

    • last：停止处理当前 rewrite 指令集，重新搜索匹配URI的 location 块。
    • break：停止处理当前的 rewrite 指令集。
    • redirect：返回302临时重定向。
    • permanent：返回301永久重定向。

  • 上下文配置

    • rewrite指令可以在 server、location 和 if 上下文中使用。

  • 示例1：URL重写

    1
    2
    3
    4
    # 将 /old-url/ 重写为 /new-url/ 
    location /old-url/ {  
        rewrite ^/old-url/(.*)$ /new-url/$1 last;  
    }

  • 示例2：删除URL中的 .php 扩展名

    1
    2
    3
    4
    5
    6
    7
    #  当请求 /some-page.php 时，重定向到 /some-page ：

    location / {  
        if ($request_filename !-f) {  
            rewrite ^(.+)\.php(.*)$ $1$2 permanent;  
        }  
    }

  • 注意：虽然上面的示例使用了 if 指令，但通常尽可能避免在 nginx 配置中使用 if，因为它可能会导致性能问题。更好的方法可能是使用 try_files 指令或其他方法。

  • 示例3：防止目录列表

    1
    2
    3
    4
    5
    6
    7
    8
    9
    # 如果你不希望用户能够列出目录的内容
    # 你可以使用 rewrite 指令来重定向到一个错误页面或另一个 URI：

    location /some-directory/ {  
        autoindex off;  # 首先关闭目录列表  
        if (!-e $request_filename) {  
            rewrite ^/some-directory/(.*)$ /error-page.html last;  
        }  
    }

rewrite_log指令

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

1
2
3
语法	rewrite_log on|off;
默认值	rewrite_log off;
位置	http、server、location、if

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

Rewrite的案例

域名跳转

如果我们想访问京东网站，大家都知道我们可以输入www.jd.com,但是同样的我们也可以输入www.360buy.com同样也都能访问到京东网站。这个其实是因为京东刚开始的时候域名就是www.360buy.com，后面由于各种原因把自己的域名换成了www.jd.com, 虽然说域名变量，但是对于以前只记住了www.360buy.com的用户来说，我们如何把这部分用户也迁移到我们新域名的访问上来，针对于这个问题，我们就可以使用Nginx中Rewrite的域名跳转来解决。

  • 准备两个域名 www.360buy.com | www.jd.com

    1
    2
    3
    vim /etc/hosts
    192.168.200.133 www.360buy.com
    192.168.200.133 www.jd.com

  • 在/usr/local/nginx/html/hm目录下创建一个访问页面

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
      <html>
      	<title></title>
      	<body>
      		<h1>欢迎来到我们的网站</h1>
      	</body>
      </html>

    - 通过Rewrite完成将www.360buy.com的请求跳转到www.jd.com

      ```sh
      server {
      	listen 80;
      	server_name www.360buy.com;
      	rewrite ^/ http://www.jd.com permanent;
      }
      
      server {
      	listen 80;
      	server_name www.jd.com;
      	location /{
      		root /usr/local/nginx/html/hm;
      		index index.html;
      	}
      }

域名跳转2

问题描述:如何在域名跳转的过程中携带请求的URI？

  • 修改配置信息

    1
    2
    3
    4
    5
    server {
    	listen 80;
    	server_name www.itheima.com;
    	rewrite ^(.*) http://www.hm.com$1 permanent;
    }

问题描述:我们除了上述说的www.jd.com 、www.360buy.com其实还有我们也可以通过www.jingdong.com来访问，那么如何通过Rewrite来实现多个域名的跳转?

1
2
3
# 添加域名
vim /etc/hosts
192.168.200.133 www.jingdong.com

  • 修改配置信息

    1
    2
    3
    4
    5
    server{
    	listen 80;
    	server_name www.360buy.com www.jingdong.com;
    	rewrite ^(.*) http://www.jd.com$1 permanent;
    }

域名镜像

上述案例中，将www.360buy.com 和 www.jingdong.com都能跳转到www.jd.com，那么www.jd.com我们就可以把它起名叫主域名，其他两个就是我们所说的镜像域名，当然如果我们不想把整个网站做镜像，只想为其中某一个子目录下的资源做镜像，我们可以在location块中配置rewrite功能，比如:

1
2
3
4
5
6
7
8
9
10
11

server {
	listen 80;
	server_name rewrite.myweb.com;
	location ^~ /source1{
		rewrite ^/resource1(.*) http://rewrite.myweb.com/web$1 last;
	}
	location ^~ /source2{
		rewrite ^/resource2(.*) http://rewrite.myweb.com/web$1 last;
	}
}

独立域名

一个完整的项目包含多个模块，比如购物网站有商品商品搜索模块、商品详情模块已经购物车模块等，那么我们如何为每一个模块设置独立的域名。

  • 需求：

    1
    2
    3
    http://search.hm.com  访问商品搜索模块
    http://item.hm.com	  访问商品详情模块
    http://cart.hm.com	  访问商品购物车模块
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    server{
    	listen 80;
    	server_name search.hm.com;
    	rewrite ^(.*) http://www.hm.com/bbs$1 last;
    }
    server{
    	listen 81;
    	server_name item.hm.com;
    	rewrite ^(.*) http://www.hm.com/item$1 last;
    }
    server{
    	listen 82;
    	server_name cart.hm.com;
    	rewrite ^(.*) http://www.hm.com/cart$1 last;
    }

目录自动添加”/“

合并目录

搜索引擎优化(SEO)是一种利用搜索引擎的搜索规则来提供目的网站的有关搜索引擎内排名的方式。我们在创建自己的站点时，可以通过很多中方式来有效的提供搜索引擎优化的程度。其中有一项就包含URL的目录层级一般不要超过三层，否则的话不利于搜索引擎的搜索也给客户端的输入带来了负担，但是将所有的文件放在一个目录下又会导致文件资源管理混乱并且访问文件的速度也会随着文件增多而慢下来，这两个问题是相互矛盾的，那么使用rewrite如何解决上述问题?

  • 举例，网站中有一个资源文件的访问路径时 /server/11/22/33/44/20.html,也就是说20.html存在于第5级目录下

  • 如果想要访问该资源文件，客户端的URL地址就要写成 http://www.web.name/server/11/22/33/44/20.html

    1
    2
    3
    4
    5
    6
    7
    server {
    	listen 80;
    	server_name www.web.name;
    	location /server{
    		root html;
    	}
    }

  • 但是这个是非常不利于SEO搜索引擎优化的，同时客户端也不好记.使用rewrite我们可以进行如下配置:

    1
    2
    3
    4
    5
    6
    7
    server {
    	listen 80;
    	server_name www.web.name;
    	location /server{
    		rewrite ^/server-([0-9]+)-([0-9]+)-([0-9]+)-([0-9]+)\.html$ /server/$1/$2/$3/$4/$5.html last;
    	}
    }

  • 客户端只需要输入http://www.web.name/server-11-22-33-44-20.html就可以访问到20.html页面了。这里也充分利用了rewrite指令支持正则表达式的特性。

防盗链

防盗链之前我们已经介绍过了相关的知识，在rewrite中的防盗链和之前将的原理其实都是一样的，只不过通过rewrite可以将防盗链的功能进行完善下，当出现防盗链的情况，我们可以使用rewrite将请求转发到自定义的一张图片和页面，给用户比较好的提示信息。下面我们就通过根据文件类型实现防盗链的一个配置实例:

1
2
3
4
5
6
7
8
9
10
server{
	listen 80;
	server_name www.web.com;
	locatin ~* ^.+\.(gif|jpg|png|swf|flv|rar|zip)${
		valid_referers none blocked server_names *.web.com;
		if ($invalid_referer){
			rewrite ^/ http://www.web.com/images/forbidden.png;
		}
	}
}

根据目录实现防盗链配置：

1
2
3
4
5
6
7
8
9
10
11
server{
	listen 80;
	server_name www.web.com;
	location /file/{
		root /server/file/;
		valid_referers none blocked server_names *.web.com;
		if ($invalid_referer){
			rewrite ^/ http://www.web.com/images/forbidden.png;
		}
	}
}

总结

  • 当使用 rewrite 指令时，确保了解正则表达式的语法和 nginx 的配置方式。
  • 过度使用 rewrite 可能会导致性能下降，特别是在处理大量请求时。因此，尽量保持配置简单和高效。
  • 在生产环境中更改配置之前，最好在测试环境中验证更改。