实现kong网关路由前rewrite插件遇到的问题

rewrite uri有两种方式，一种是路由前做rewrite操作，在路由判断之前rewrite uri到新的内部地址，然后再执行路由判断。另外一种是路由后rewrite，也就是路由匹配后，改写发送到上游服务器的uri。我们遇到的需求是在路由前做rewrite操作，大多数rewrite插件的例子是在kong:access()阶段做rewrite处理。疑问就来了，为什么不在kong.rewite()阶段rewrite uri，而是要在kong:access()阶段做rewrite uri。

Kong的执行流程

我们来分析kong的执行流程，其中nginx配置文件最能体现kong的插件加载过程。

server {
    server_name kong;
    listen 0.0.0.0:8000 reuseport backlog=16384;
    listen 0.0.0.0:8443 ssl http2 reuseport backlog=16384;

    rewrite_by_lua_block {
        Kong.rewrite()
    }

    access_by_lua_block {
        Kong.access()
    }

    header_filter_by_lua_block {
        Kong.header_filter()
    }

    body_filter_by_lua_block {
        Kong.body_filter()
    }

    log_by_lua_block {
        Kong.log()
    }

    location / {
        proxy_pass            $upstream_scheme://kong_upstream$upstream_uri;
    }

}

函数名	LUA-NGINX-MODULE Context	描述
:init_worker()	init_worker_by_lua	在每个 Nginx 工作进程启动时执行
:certificate()	ssl_certificate_by_lua	在SSL握手阶段的SSL证书服务阶段执行
:rewrite()	rewrite_by_lua	从客户端接收作为重写阶段处理程序的每个请求执行。在这个阶段，无论是API还是消费者都没有被识别，因此这个处理器只在插件被配置为全局插件时执行
:access()	access_by_lua	为客户的每一个请求而执行，并在它被代理到上游服务之前执行
:header_filter()	header_filter_by_lua	从上游服务接收到所有响应头字节时执行
:body_filter()	body_filter_by_lua	从上游服务接收的响应体的每个块时执行。由于响应流回客户端，它可以超过缓冲区大小，因此，如果响应较大，该方法可以被多次调用
:log()	log_by_lua	当最后一个响应字节已经发送到客户端时执行

kong的路由判断是在kong:access()阶段执行，在access()阶段做rewrite操作实际上是路由后rewrite。查看kong的源码，可以知道在kong:access()阶段，修改 ngx.var.upstream_uri 变量可以实现rewrite uri功能, 最后发往上游的请求地址为：

proxy_pass            $upstream_scheme://kong_upstream$upstream_uri;

如果要在路由前做rewrite操作，那么rewrite插件应该在kong:rewrite()阶段实现。

路由前rewrite的问题

rewrite相关的指令

• ngx.req.set_uri

syntax: ngx.req.set_uri(uri, jump?, binary?)

context: set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*

Rewrite the current request's (parsed) URI by the uri argument. The uri argument must be a Lua string and cannot be of zero length, or a Lua exception will be thrown.

• ngx.exec

ngx.exec
syntax: ngx.exec(uri, args?)

context: rewrite_by_lua*, access_by_lua*, content_by_lua*

Does an internal redirect to uri with args and is similar to the echo_exec directive of the echo-nginx-module.

• ngx.redirect

ngx.redirect
syntax: ngx.redirect(uri, status?)

context: rewrite_by_lua*, access_by_lua*, content_by_lua*

Issue an HTTP 301 or 302 redirection to uri.

ngx.redirect是301和302重定向指令， ngx.exec 为内部重定向指令，其中ngx.exec 和ngx.req.set_uri都设置了ngx.var.uri变量。但这几个rewrite指令在kong:rewrite()阶段皆不生效，原因是kong在路由匹配的时候使用ngx.var.request_uri。

具体如下：

// kong/router.lua:1691
15     local var           = ngx.var
....
1691   local req_uri = var.request_uri

再来分析ngx.var.request_uri 和ngx.var.uri的区别

• ngx.var.request_uri

full original request URI (with arguments)

• ngx.var.uri

current URI in request, normalized

The value of $uri may change during request processing, e.g. when doing internal redirects, or when using index files.

ngx.var.request_uri 是原始请求的uri，不可改变。ngx.var.uri在请求处理过程中可以更改，例如执行内部重定向后。由于kong使用ngx.var.request_uri做路由判断，而ngx.var.request_uri是不可更改的，所以无法在路由前做rewrite操作。

从什么时候开始不支持路由前rewrite操作？

commit 2bfa9539ea7a89978f1576020b840cace932ce12 (HEAD)
Author: Aapo Talvensaari <aapo.talvensaari@gmail.com>
Date:   Wed Apr 12 11:07:19 2017 +0300

    fix(router) match against non-normalized URI

    Change the router to use `ngx.var.request_uri` instead of
    the normalized `ngx.var.uri`. Makes proxying more transparent.

    Fixes #2366

    Signed-off-by: Thibault Charbonnier <thibaultcha@me.com>

从这个commit之后就不支持access之前的rewrite操作，这个commit为了解决特殊字符url 无法路由的问题，所以改成用ngx.var.request_uri做路由匹配。不支持access之前的rewrite操作的kong版本：从 version 0.10.1 到 2.0.x。

• 相关issue

https://github.com/Kong/kong/issues/2366

https://github.com/Kong/kong/issues/3140

解决办法

目前rewrite 相关的issue处于task/needs-investigation的状态，解决办法有：

• 修改kong源码，使用ngx.var.uri做路由匹配，但潜在风险未知

local req_uri = var.request_uri

• 使用老版本的kong，0.10.1之前的版本

kong不支持kong:access()之前的rewrite指令，使用kong 0.10.1之前的版本或者修改kong源码才能实现路由前rewrite uri。主流的做法是kong:access()阶段做rewrite操作，也就是路由匹配之后，修改发送给上游服务的uri。支持路由后rewrite功能的插件有request-transformer, request-transformation-advanced，或者内部定制插件支持该功能。

参考

• Plugin Development - Implementing Custom Logic

• https://github.com/Kong/kong/issues/2366

• https://github.com/Kong/kong/issues/3140