Apache APISIX 中处理 URI 重写时特殊字符的解决方案

问题背景

在使用 Apache APISIX 进行 URI 重写时，经常会遇到需要处理包含特殊字符（如问号?和等号=）的 URI 场景。这类问题在实际配置中比较常见，特别是在需要保留或修改查询参数的情况下。

典型场景分析

在示例配置中，用户尝试将类似 /api/abc/1234/xyz/abn 的路径重写为 /api/abc/1234/xyz?partner=0 的形式。这种转换涉及到两个关键点：

1. 路径部分的捕获和替换（1234作为动态参数）
2. 查询参数的添加（?partner=0）

配置方案

正确的配置方式应该如下：

uri: /api/abc/*
plugins:
  proxy-rewrite:
    host: "abc.demo.co"
    regex_uri: ["^/api/abc/([^/]+)/xyz/abn", "/api/abc/${1}/xyz?partner=0"]
upstream:
  scheme: https
  type: roundrobin
  nodes:
    "abc.demo.co:443": 1

技术要点解析

1. 正则表达式捕获组：([^/]+) 用于捕获路径中的动态部分（如示例中的1234）
2. 替换引用：${1} 引用第一个捕获组的内容
3. 查询参数处理：直接在替换字符串中添加 ?partner=0 即可

常见问题排查

当遇到类似问题时，可以按照以下步骤进行排查：

1. 确认正则表达式是否正确匹配原始URI
2. 检查捕获组引用是否正确（${1}、${2}等）
3. 验证特殊字符是否被正确转义（通常不需要额外转义）
4. 通过Admin API获取实际配置，确认配置是否按预期生效

最佳实践建议

1. 对于复杂的URI重写，建议先在正则表达式测试工具中验证匹配规则
2. 在APISIX日志中关注实际的请求转发情况
3. 对于生产环境，建议先在测试环境验证配置效果
4. 考虑使用APISIX的debug模式获取更详细的处理日志

总结

Apache APISIX 的 proxy-rewrite 插件能够很好地处理包含特殊字符的URI重写需求。关键在于正确构建正则表达式匹配模式和替换字符串。对于查询参数这类特殊字符，直接包含在替换字符串中即可，不需要额外转义处理。通过合理的配置，可以实现各种复杂的URI重写需求。