前言

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

我们为 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-27-nginx return 指令

从零手写实现 nginx-28-nginx error_pages 指令

从零手写实现 nginx-29-nginx try_files 指令

从零手写实现 nginx-30-nginx proxy_pass upstream 指令

从零手写实现 nginx-31-nginx load-balance 负载均衡

从零手写实现 nginx-32-nginx load-balance 算法 java 实现

从零手写实现 nginx-33-nginx http proxy_pass 测试验证

从零手写实现 nginx-34-proxy_pass 配置加载处理

从零手写实现 nginx-35-proxy_pass netty 如何实现？

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

chat

nginx rewrite 有哪些优缺点？

Nginx rewrite 指令在URL重写和重定向方面提供了强大的功能，但也有其优缺点。以下是对其优缺点的详细分析：

优点

灵活性高
- rewrite 指令使用正则表达式，可以处理复杂的URL重写需求，几乎可以满足任何URL重写的场景。
性能高
- Nginx 本身是一个高性能的HTTP服务器，rewrite 指令的执行效率很高，不会显著影响服务器的性能。
丰富的功能
- 可以进行内部重写、临时重定向、永久重定向，还可以根据请求的条件（如请求头、变量等）进行重写和重定向。
SEO优化
- 通过重写URL，可以使网站的URL更加友好，有利于搜索引擎优化（SEO）。
兼容性
- 可以保持旧链接的有效性，通过重写规则将旧的URL重定向到新的URL，保证网站迁移或路径结构调整后的兼容性。
简化配置
- 可以通过简单的重写规则实现复杂的URL路由逻辑，简化服务器配置。

缺点

配置复杂
- 对于不熟悉正则表达式的用户来说，编写和调试rewrite规则可能比较困难，容易出错。
可读性差
- 复杂的重写规则可能导致配置文件的可读性降低，维护起来比较困难。
错误处理困难
- 当重写规则出现错误时，可能导致请求无法正确路由，调试这些问题通常需要一些经验。
影响缓存
- URL的重写可能会影响缓存策略，因为重写后的URL和原始URL可能被视为不同的资源，从而导致缓存命中率降低。
潜在的性能开销
- 虽然Nginx的性能较高，但复杂的重写规则仍可能在高流量情况下带来一定的性能开销，尤其是当规则涉及大量正则表达式匹配时。
安全风险
- 不当的重写规则可能引发安全问题，例如URL重写导致的路径遍历攻击等，需要仔细设计和验证规则。

总结

Nginx rewrite 指令是一个非常强大且灵活的工具，可以极大地满足各种复杂的URL重写和重定向需求。

它的高性能和丰富的功能使得它在许多场景中非常有用。

然而，它的配置复杂性和潜在的错误风险也需要管理员在使用时保持谨慎，确保规则的正确性和安全性。

通过合理的设计和优化，可以最大程度地发挥rewrite 指令的优势，满足应用需求。

如果让你设计 rewrite 指令，你会如何设计？为什么

设计一个URL重写指令时，需要考虑简洁性、易用性、灵活性和性能等多个方面。

以下是一个改进版的重写指令设计思路，并附上设计理由：

设计目标

易用性：让用户更容易编写和理解重写规则。
灵活性：支持复杂的URL重写需求。
性能：保持高效的处理性能。
安全性：减少潜在的安全风险。

设计思路

简化语法：提供更直观的语法，减少对正则表达式的依赖。
条件支持：允许根据请求头、查询参数等条件进行重写。
调试工具：提供调试工具和详细的错误信息。
内置变量：预定义一些常用变量，减少用户记忆负担。
分组和优先级：支持规则分组和优先级设置，简化复杂配置。

重写指令设计示例

基本语法

rewrite [pattern] [replacement] [flag] [condition];

pattern: 匹配模式，支持简单模式和正则表达式。
replacement: 重写后的URL，可以包含捕获组。
flag: 可选参数，表示重写后的行为（如 last、break、redirect、permanent）。
condition: 可选参数，表示重写规则生效的条件。

示例

简单重写

rewrite /old-path /new-path;

将 /old-path 重写为 /new-path。

正则表达式重写

rewrite ^/product/(\d+)$ /new-product/$1;

将 /product/123 重写为 /new-product/123。

条件重写

rewrite ^/details$ /details/$arg_id if ($arg_id);

如果存在查询参数 id，将 /details?id=123 重写为 /details/123。

重定向

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

将 /old-page 重定向到 /new-page，返回301永久重定向。

条件与请求头

rewrite ^/admin$ /admin-login.html if ($http_user_agent ~* "bot");

如果用户代理包含 “bot”，将 /admin 重写为 /admin-login.html。

分组和优先级

rewrite group main {
    priority 1;
    rewrite /old-path /new-path;
    rewrite ^/product/(\d+)$ /new-product/$1;
}

将规则分组，并设置优先级。

理由

简化语法：使用简单的模式匹配，减少用户对正则表达式的依赖，降低使用门槛。
条件支持：允许根据请求头、查询参数等条件进行重写，增强灵活性。
调试工具：提供调试工具和详细的错误信息，方便用户调试和排查问题。
内置变量：预定义一些常用变量，如 $arg_id、$http_user_agent，减少用户记忆负担。
分组和优先级：支持规则分组和优先级设置，使得复杂配置更易于管理。

实现

为实现这些设计，需要在Nginx核心中扩展现有的rewrite模块，增加对条件、分组、优先级和调试工具的支持。

同时，优化正则表达式的处理性能，确保重写指令的高效执行。

通过这样的设计，可以显著提升Nginx重写指令的易用性和灵活性，同时保持高效的性能和安全性。

参考资料

前言
- 手写 nginx 系列
nginx 的 rewirte 指令
- 是什么？
  - 基本语法
  - 常见的 flag
- 为什么需要？
java 实现
- URL 的替换
- flag 的处理策略
  - 301-返回 301 永久重定向
  - 302-临时重定向
小结
开源地址
chat
- nginx rewrite 有哪些优缺点？
  - 优点
  - 缺点
  - 总结
- 如果让你设计 rewrite 指令，你会如何设计？为什么
参考资料

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

前言

手写 nginx 系列

nginx 的 rewirte 指令

是什么？

基本语法

常见的 flag

为什么需要？

1. 用户友好的 URL

2. SEO 优化

3. 兼容旧链接

4. 负载均衡和反向代理

5. 安全性

6. 动态内容的静态化

7. 域名或路径迁移

java 实现

URL 的替换

flag 的处理策略

301-返回 301 永久重定向

302-临时重定向

小结

开源地址

chat

nginx rewrite 有哪些优缺点？

优点

缺点

总结

如果让你设计 rewrite 指令，你会如何设计？为什么

设计目标

设计思路

重写指令设计示例

基本语法

示例

理由

实现

参考资料

更多学习