Nginx-rewrite模块详解

news2024/7/7 14:58:44

文章目录

前言
一、ngx_http_rewrite_module模块
二、指令详解
- 1.break
- - 案例
- 2. if指令
- - 案例
- 3. return指令
- - 案例：
  - return 的优先级
- 4. rewrite指令
- - 案例
- 5. set指令
总结

前言

nginx一些场景，我们需要使用rewrite模块。例如域名改了，为了利用网站seo进行伪静态处理。通过判断来实现一些逻辑处理等。这里我们介绍下ngx_http_rewrite_module模块

一、ngx_http_rewrite_module模块

ngx_http_rewrite_module模块官网传送门
ngx_http_rewrite_module模块用于使用PCRE正则表达式更改请求URI、返回重定向和有条件选择配置。

二、指令详解

1.break

用法示例：

Syntax:	break;
Default:	—
Context:	server, location, if

停止处理当前的ngx_http_rewrite_module指令集。
注意: 如果break指令在location块中后续指令还会继续执行,只是不执行 ngx_http_rewrite_module 模块的指令,其它指令还会执行。

案例

配置

[root@private test]# cat rewritedemo.conf 
location /rewrite/break {
  set $name dog;
  echo $name;
  break;
  set $myport $server_port;  # set指令属于rewrite模块，break模块后不在执行； 
  echo $myport;
  echo $name;
}

执行结果如下：

[root@private test]# curl http://nginx.test.io:8081/rewrite/break
dog

dog

可以看出，

2. if指令

用法：

Syntax:	if (condition) { ... }
Default:	—
Context:	server, location

条件condition为真，则执行大括号内的指令；
Nginx的if语法仅能使用if做单次判断，不支持使用if else或者if elif这样的多重判断

将变量和正则表达式做匹配 大小写敏感：~ 或者 !~ 大小写不敏感： ~*或者 !~*
将变量和字符串做匹配，使用=或者 !=

案例

# 将变量和正则表达式做匹配
 if ($request_uri ~* ^/api/goods/delete) {
     set $del_flag 1;
 }

# 将变量和字符串做匹配
 if ( $del_flag = 1) {
   set $flag "del";
 }

# 判断传参
if ($args ~ userId=admin) {
  return 403 "该用户不允许修改";
}
# 判断客户端 
if ($http_user_agent ~ MSIE) {
  return 301 http://www.example.com/ie;
}

3. return指令

用法

Syntax:	return code [text];
return code URL;
return URL;
Default:	—
Context:	server, location, if

停止处理并将指定代码返回给客户端。非标准代码444关闭连接而不发送响应头。

案例：

# 自定义code，自定义返回文字
location / {
default_type application/json;
return 999 realip:$clientRealIp\r\nremoteaddr:$http_x_forwarded_for\r\naddr:$remote_addr;
# return 301 302 重定向
}

return 的优先级

下面的案例中，我们在location最后，return 401。当我们访问nginx的时候，结果应该是返回多少呢？

server {
        server_name nginx.test.io;
        listen 8081;
        access_log off;
        default_type text/plain;


	location ~ /api/$ {
	  return 200 'first regular expressions match!\n';
	}

	location ~* /api/(\w+)$ {
	  return 200 'longest regular expressions match!\n';
	}			         

        location ^~ /api/ {
	  return 200 'stop regular expression match!\n';
	}

        location /api/test {
	  return 200 'logest prefix string match !\n';
	}

       location /api {
       	  return 200 'prefix string match!\n';
       }

       location = /api {
       	  return 200 'exact match!\n';
       }
       include test/rewritedemo.conf;   
       return 401;
}

在Nginx-HTTP请求的11个阶段文章中，我们了解到，nginx处理阶段中有出现了两次rewrite模块，NGX_HTTP_SERVER_REWRITE_PHASE和NGX_HTTP_REWRITE_PHASE，NGX_HTTP_SERVER_REWRITE_PHASE要在前，所以，上面案例中return 401; 在server块中要先一步执行返回，我们可以验证下。

[root@pri test]# curl http://nginx.test.io:8081/api/
<html>
<head><title>401 Authorization Required</title></head>
<body>
<center><h1>401 Authorization Required</h1></center>
<hr><center>nginx</center>
</body>
</html>
[root@pri test]# curl http://nginx.test.io:8081
<html>
<head><title>401 Authorization Required</title></head>
<body>
<center><h1>401 Authorization Required</h1></center>
<hr><center>nginx</center>
</body>
</html>
[root@pri test]# curl http://nginx.test.io:8081/
<html>
<head><title>401 Authorization Required</title></head>
<body>
<center><h1>401 Authorization Required</h1></center>
<hr><center>nginx</center>
</body>
</html>

4. rewrite指令

用法

Syntax:	rewrite regex replacement [flag];
Default:	—
Context:	server, location, if

将regex指定的url替换成replacement这个新的url (可以使用正则表达式以及变量提取)
当replacement以http://或者https://或者$schema开头，则直接返回302重定向
替换后的url根据flag指定的方式进行处理。
– last: 用replacement这个URL进行新的location匹配（stops processing the current set of ngx_http_rewrite_module directives and starts a search for a new location matching the changed URI;）
– break: break指令停止当前脚本指令的执行，等价于独立的break指令。（stops processing the current set of ngx_http_rewrite_module directives as with the break directive;）
– redirect: 返回302重定向
– permanent: 返回301重定向

案例

#  假设你有一个动态的新闻页面地址，例如：http://example.com/news.php?id=123，你想将其伪静态为：http://example.com/news/123.html。
#  你需要在Nginx配置文件中的server块中添加以下规则：
    location ~ ^/news/([0-9]+)\.html$ {
        rewrite ^/news/([0-9]+)\.html$ /news.php?id=$1 last;
    }