从零手写实现 nginx-26-rewrite url 重写

前言

大家好，我是老马。很高兴遇到你。

我们为 java 开发者实现了 java 版本的 nginx

https://github.com/houbb/nginx4j

如果你想知道 servlet 如何处理的，可以参考我的另一个项目：

手写从零实现简易版 tomcat minicat

手写 nginx 系列

如果你对 nginx 原理感兴趣，可以阅读：

从零手写实现 nginx-01-为什么不能有 java 版本的 nginx?

从零手写实现 nginx-02-nginx 的核心能力

从零手写实现 nginx-03-nginx 基于 Netty 实现

从零手写实现 nginx-04-基于 netty http 出入参优化处理

从零手写实现 nginx-05-MIME类型（Multipurpose Internet Mail Extensions，多用途互联网邮件扩展类型）

从零手写实现 nginx-06-文件夹自动索引

从零手写实现 nginx-07-大文件下载

从零手写实现 nginx-08-范围查询

从零手写实现 nginx-09-文件压缩

从零手写实现 nginx-10-sendfile 零拷贝

从零手写实现 nginx-11-file+range 合并

从零手写实现 nginx-12-keep-alive 连接复用

从零手写实现 nginx-13-nginx.conf 配置文件介绍

从零手写实现 nginx-14-nginx.conf 和 hocon 格式有关系吗？

从零手写实现 nginx-15-nginx.conf 如何通过 java 解析处理？

从零手写实现 nginx-16-nginx 支持配置多个 server

从零手写实现 nginx-17-nginx 默认配置优化

从零手写实现 nginx-18-nginx 请求头+响应头操作

从零手写实现 nginx-19-nginx cors

从零手写实现 nginx-20-nginx 占位符 placeholder

从零手写实现 nginx-21-nginx modules 模块信息概览

从零手写实现 nginx-22-nginx modules 分模块加载优化

从零手写实现 nginx-23-nginx cookie 的操作处理

从零手写实现 nginx-24-nginx IF 指令

从零手写实现 nginx-25-nginx map 指令

从零手写实现 nginx-26-nginx rewrite 指令

nginx 的 rewirte 指令

是什么？

Nginx 的 rewrite 指令用于对 URL 进行重写（Rewrite），即将用户请求的 URL 按照指定的规则修改成新的 URL，然后再进行后续处理或跳转。

它通常用于实现 URL 重定向、SEO 优化、URL 简化等功能。

基本语法

rewrite 指令的基本语法如下：

rewrite regex replacement [flag];

• regex: 正则表达式，用于匹配请求的 URL。
• replacement: 重写后的新 URL，可以包含捕获组（从 regex 中捕获的部分）。
• flag: 可选参数，表示重写后的行为。

常见的 flag

• last: 停止当前所在的 rewrite 指令所在的位置，并重新搜索新的 location。相当于 Apache 的 L 标志。

• break: 停止处理当前的 rewrite 指令，但继续处理剩下的指令，不会重新搜索 location。

• redirect: 返回 302 临时重定向。

• permanent: 返回 301 永久重定向。

为什么需要？

Nginx 需要 rewrite 指令的原因主要是为了提供灵活和强大的 URL 重写和重定向功能，这在许多场景下都是非常必要的。以下是一些常见的原因和场景：

1. 用户友好的 URL

通过 rewrite 指令，可以将复杂的、包含参数的 URL 重写为简洁且易读的 URL，使用户更容易记忆和分享。

示例： 将 /product.php?id=123 重写为 /product/123。

rewrite ^/product/(\d+)$ /product.php?id=$1 last;

2. SEO 优化

搜索引擎更喜欢简洁、含义明确的 URL。通过 rewrite 指令，可以优化 URL 结构，提高搜索引擎的排名。

示例： 将 /old-page 重定向到 /new-page，避免因 URL 更改导致的搜索引擎排名下降。

rewrite ^/old-page$ /new-page permanent;

3. 兼容旧链接

在网站改版或重构时，通过 rewrite 指令，可以保证旧链接仍然有效，避免出现大量的 404 错误页面。

示例： 将旧的 URL 结构重写为新的 URL 结构。

rewrite ^/old-path$ /new-path permanent;

4. 负载均衡和反向代理

在负载均衡和反向代理场景下，通过 rewrite 指令，可以将请求重写为后端服务器可以处理的格式。

示例： 将 /app1 的请求重写为内部服务器的特定路径。

location /app1/ {
    proxy_pass http://backend1;
    rewrite ^/app1/(.*)$ /$1 break;
}

5. 安全性

通过隐藏实际的 URL 结构，可以提高系统的安全性，避免暴露内部实现细节。

示例： 隐藏实际的文件路径。

rewrite ^/downloads/([a-zA-Z0-9]+)$ /secure/files/$1 last;

6. 动态内容的静态化

将动态生成的内容重写为静态路径，减少服务器的负载。

示例： 将 /article?id=123 重写为静态文件路径 /article/123.html。

rewrite ^/article/(\d+)$ /article/$1.html last;

7. 域名或路径迁移

在域名或路径变更时，通过 rewrite 指令，可以将流量从旧域名或路径无缝地重定向到新域名或路径。

示例： 将旧域名的请求重定向到新域名。

server {
    listen 80;
    server_name old-domain.com;
    rewrite ^(.*)$ http://new-domain.com$1 permanent;
}

java 实现

主要分为 2 个部分：

URL 的替换

针对 url 的替换核心策略：

private String getReplacedUrl(final FullHttpRequest fullHttpRequest,
                              NginxCommonConfigEntry matchRewriteConfig) {
    // rewrite regex replacement
    List<String> values = matchRewriteConfig.getValues();
    final String regex = values.get(0);
    final String replacement = values.get(1);
    final String originalUrl = fullHttpRequest.uri();

    Pattern pattern = Pattern.compile(regex);
    Matcher matcher = pattern.matcher(originalUrl);

    String rewrittenUrl = matcher.replaceAll(replacement);
    return rewrittenUrl;
}

flag 的处理策略

301-返回 301 永久重定向

FullHttpResponse response = new DefaultFullHttpResponse(HttpVersion.HTTP_1_1, HttpResponseStatus.MOVED_PERMANENTLY);
response.headers().set(HttpHeaderNames.LOCATION, "/final-destination");
ctx.writeAndFlush(response).addListener(ChannelFutureListener.CLOSE);

302-临时重定向

// 302 Found
FullHttpResponse response = new DefaultFullHttpResponse(
        HttpVersion.HTTP_1_1, HttpResponseStatus.FOUND);
response.headers().set(HttpHeaderNames.LOCATION, "/final-destination");
ctx.writeAndFlush(response).addListener(ChannelFutureListener.CLOSE);

小结

Nginx 的 rewrite 指令为 URL 重写和重定向提供了强大的功能，能够处理各种复杂的需求，从而提高网站的用户体验、SEO 排名、兼容性、安全性和性能。

通过灵活运用 rewrite 指令，可以有效地管理和优化 URL，使得网站在不同场景下都能表现良好。

下一节，我们考虑实现一下 try_files 的支持。

我是老马，期待与你的下次重逢。

开源地址

为了便于大家学习，已经将 nginx 开源

https://github.com/houbb/nginx4j