Apache APISIX重写规则：请求响应重写实战-优快云博客

Apache APISIX重写规则：请求响应重写实战

【免费下载链接】apisix The Cloud-Native API Gateway 项目地址: https://gitcode.com/GitHub_Trending/ap/apisix

引言

在现代API网关架构中，请求和响应的重写能力是至关重要的功能。Apache APISIX作为云原生API网关，提供了强大的proxy-rewrite和response-rewrite插件，能够灵活处理请求转发和响应修改的各种场景。本文将深入探讨这两个插件的实战应用，帮助开发者掌握API网关重写的高级技巧。

核心概念解析

请求重写（Proxy Rewrite）

请求重写发生在请求转发到上游服务之前，主要用于修改请求的元数据信息：

mermaid

响应重写（Response Rewrite）

响应重写发生在上游服务返回响应之后，主要用于修改响应内容和头信息：

mermaid

proxy-rewrite插件深度解析

核心功能特性

功能类别	配置项	描述	使用场景
URI重写	`uri`	直接指定新的URI路径	路径映射、版本控制
正则重写	`regex_uri`	使用正则表达式匹配和替换URI	动态路径转换
方法重写	`method`	修改HTTP请求方法	RESTful API方法转换
Host重写	`host`	修改上游服务Host头	多租户环境、服务发现
头部操作	`headers`	添加、设置、删除请求头	认证、追踪、元数据传递

实战配置示例

基础URI重写

curl http://127.0.0.1:9180/apisix/admin/routes/1 \
-H "X-API-KEY: $admin_key" -X PUT -d '
{
    "uri": "/api/v1/users",
    "plugins": {
        "proxy-rewrite": {
            "uri": "/internal/user-service/v1/users"
        }
    },
    "upstream": {
        "type": "roundrobin",
        "nodes": {
            "user-service.internal:8080": 1
        }
    }
}'

正则表达式路径重写

{
    "uri": "/user/(.*)/profile",
    "plugins": {
        "proxy-rewrite": {
            "regex_uri": ["^/user/(.*)/profile", "/api/profiles/$1"]
        }
    }
}

完整的头部操作示例

{
    "plugins": {
        "proxy-rewrite": {
            "uri": "/api/v2/products",
            "method": "POST",
            "host": "product-service.internal",
            "headers": {
                "add": {
                    "X-Request-ID": "$request_id",
                    "X-Forwarded-User": "$remote_user"
                },
                "set": {
                    "Content-Type": "application/json",
                    "X-Api-Version": "v2"
                },
                "remove": ["User-Agent", "X-Debug-Mode"]
            }
        }
    }
}

response-rewrite插件深度解析

核心功能特性

功能类别	配置项	描述	使用场景
状态码重写	`status_code`	修改HTTP状态码	错误处理、重定向
响应体重写	`body`	替换整个响应体	数据脱敏、格式转换
Base64编码	`body_base64`	Base64解码响应体	二进制数据处理
头部操作	`headers`	添加、设置、删除响应头	CORS、缓存控制、安全头
条件重写	`vars`	基于条件执行重写	条件响应处理
正则过滤	`filters`	正则表达式替换响应体	内容过滤、数据脱敏

实战配置示例

基础响应重写

curl http://127.0.0.1:9180/apisix/admin/routes/1 \
-H "X-API-KEY: $admin_key" -X PUT -d '
{
    "uri": "/api/sensitive-data",
    "plugins": {
        "response-rewrite": {
            "body": "{\"status\":\"success\",\"data\":\"[REDACTED]\"}",
            "headers": {
                "set": {
                    "X-Content-Type-Options": "nosniff",
                    "X-Frame-Options": "DENY"
                }
            }
        }
    }
}'

条件响应重写

{
    "plugins": {
        "response-rewrite": {
            "status_code": 404,
            "body": "{\"error\":\"Resource not found\"}",
            "vars": [
                ["status", "==", 500]
            ]
        }
    }
}

正则过滤敏感信息

{
    "plugins": {
        "response-rewrite": {
            "filters": [
                {
                    "regex": "(\\d{4})-\\d{2}-\\d{2}",
                    "scope": "global",
                    "replace": "$1-XX-XX",
                    "options": "jo"
                },
                {
                    "regex": "\\b\\d{16}\\b",
                    "scope": "global", 
                    "replace": "************XXXX",
                    "options": "jo"
                }
            ]
        }
    }
}

高级应用场景

场景一：API版本控制

mermaid

配置示例：

{
    "uri": "/api/v1/*",
    "plugins": {
        "proxy-rewrite": {
            "regex_uri": ["^/api/v1/(.*)", "/internal/$1"]
        },
        "response-rewrite": {
            "filters": [{
                "regex": "\"legacy_field\"",
                "replace": "\"standard_field\"",
                "scope": "global"
            }]
        }
    }
}

场景二：多租户路由

{
    "uri": "/tenant/:tenant_id/*",
    "vars": [
        ["arg_tenant_id", "!=", null]
    ],
    "plugins": {
        "proxy-rewrite": {
            "regex_uri": ["^/tenant/([^/]+)/(.*)", "/$2"],
            "headers": {
                "set": {
                    "X-Tenant-ID": "$1"
                }
            }
        }
    }
}

场景三：A/B测试流量分割

{
    "uri": "/api/feature",
    "plugins": {
        "proxy-rewrite": {
            "uri": "/api/feature-a",
            "vars": [
                ["cookie_ab_test", "==", "group_a"]
            ]
        }
    }
},
{
    "uri": "/api/feature", 
    "plugins": {
        "proxy-rewrite": {
            "uri": "/api/feature-b",
            "vars": [
                ["cookie_ab_test", "==", "group_b"]
            ]
        }
    }
}

性能优化与最佳实践

1. 正则表达式优化

# 不推荐 - 过于复杂的正则
"regex_uri": ["^/api/(v[0-9]+)/(users|products)/([0-9]+)/?(.*)", "/$2/$3"]

# 推荐 - 简化正则表达式
"regex_uri": ["^/api/v[0-9]+/(.*)", "/$1"]

2. 条件重写优化

# 使用vars条件避免不必要的重写
{
    "response-rewrite": {
        "body": "{\"cache\":\"hit\"}",
        "vars": [
            ["upstream_cache_status", "==", "HIT"]
        ]
    }
}

3. 批量操作优化

# 合并多个重写操作
{
    "plugins": {
        "proxy-rewrite": {
            "uri": "/optimized/path",
            "headers": {
                "set": {
                    "X-Optimized": "true",
                    "X-Version": "2.0"
                }
            }
        }
    }
}

常见问题与解决方案

问题1：重写循环

症状: 请求陷入无限重定向循环

解决方案:

{
    "plugins": {
        "proxy-rewrite": {
            "uri": "/target",
            "vars": [
                ["uri", "!~", "^/target"]
            ]
        }
    }
}

问题2：编码问题

症状: 中文字符或特殊字符处理异常

解决方案:

{
    "plugins": {
        "proxy-rewrite": {
            "use_real_request_uri_unsafe": true
        }
    }
}

问题3：性能瓶颈

症状: 高并发下响应时间增加

解决方案:

避免在response-rewrite中使用复杂正则
使用vars条件限制重写范围
考虑使用专门的过滤服务处理复杂转换

监控与调试

关键监控指标

指标名称	描述	告警阈值
`rewrite_latency`	重写操作耗时	> 50ms
`regex_complexity`	正则表达式复杂度	> 1000步骤
`rewrite_errors`	重写失败次数	> 10/分钟

调试技巧

# 启用调试日志
curl http://127.0.0.1:9080/apisix/admin/routes/1 \
-H "X-API-KEY: $admin_key" -X PUT -d '
{
    "plugins": {
        "proxy-rewrite": {
            "uri": "/debug",
            "headers": {
                "set": {
                    "X-Debug-Mode": "enabled"
                }
            }
        }
    }
}'

总结

Apache APISIX的proxy-rewrite和response-rewrite插件提供了强大的请求和响应处理能力。通过本文的实战指南，您应该能够：

掌握核心功能: 理解两个插件的主要特性和适用场景
实施最佳实践: 应用性能优化技巧和配置规范
解决常见问题: 识别并处理重写过程中的典型问题
设计高级方案: 构建复杂的API网关重写策略

记住，重写操作虽然强大，但也需要谨慎使用。始终在生产环境部署前进行充分的测试，确保重写逻辑的正确性和性能表现。

通过合理运用这些重写技术，您可以构建更加灵活、安全和高效的API网关架构，为微服务架构提供坚实的流量管理基础。

【免费下载链接】apisix The Cloud-Native API Gateway 项目地址: https://gitcode.com/GitHub_Trending/ap/apisix

创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考