modify request url in zuul filter(9.21)

问题描述

昨天刚学习了zuul,今天就遇到了一个问题是这样的，filter文件是这样的

public class SimpleFilter extends ZuulFilter {
    @Override
    public String filterType() {
        return "pre";
    }
    @Override
    public int filterOrder() {
        return 0;
    }
    @Override
    public boolean shouldFilter() {
        return true;
    }
    @Override
    public Object run() {
        RequestContext ctx = RequestContext.getCurrentContext();
        HttpServletRequest request = ctx.getRequest();
            String uri = request.getRequestURI().toString();
            if (uri.contains("/api/users")) {
                String newUri = uri.replaceAll("/users/\\d*", "/users/" + 2);
                ctx.set("requestURI", newUri);
            }
            log.info(String.format("%s requestssss to %s", request.getMethod(), request.getRequestURL().toString()));
        return null;
    }
}

我想要完成的目标是将我的URL从local:8888 /user-center/api/users/1 最终变成localhost:8085/api/user/2

矛盾点

• 我们的思路是我们的路由从 local:8888 /user-center/api/users/1先变成localhost:8085/api/user/1,接着再变为localhost:8085/api/user/2发往后台
• 事实上这种情况下我们的发往后台的url变成了 localhost:8085/api/user/1我们使用set()方法是可以更换url的，但为什么这里会失败

解决思路

Q1:RequestContext.getCurrentContext(). getRequest()获取的值是什么，我们修改的这个url是否是对的？
A1: 根据网上的文档发现：

• RequestContext.getCurrentContext()：获取的是用户发送给zuul的所有请求内容。
• RequestContext.getCurrentContext(). getRequest()获取的值是用户发送的原生url请求，即local:8888 /user-center/api/users/1,而且这个值永远不变的，所以我们set的方法就做的事就是将在这个原生的url上基础上进行路由替换，替换后的路由是local:8888/user-center/api/users/2被发往了后台。
• RequestContext.getCurrentContext().get("{key}")：这个api是为了获取当前请求的内容而不是原始的请求内容。

Q2:那么看起来好像我们的set方法没有任何的作用一样，到底set方法啊起作用了吗？
A2: 查询文档知道Zuul让我们自己定义过滤器，并可以让我们指定过滤器执行的顺序，但它内部自己还定义了一系列的过滤器，它内部自己默认的过滤器也会执行, 执行时候过滤器按照从小到大的顺序执行。我们知道zuul定义了四种类型的过滤器：

• pre：可以在请求被路由之前调用。
• routing：在路由请求时候被调用。
• post：在routing和error过滤器之后被调用。
• error：处理请求时发生错误时被调用。

所以这个这个路由转化的过程是没有进行，还是被它内部的filter执行过了，但是执行的时机出了问题？

核心过滤器的总结.png

问题的结论：仔细看看内部的这些过滤器，我们发现pre 的最后一个过滤器PreDecorationFiter它的具体操作内容就是为当前请求做一些预处理,也就是将我们的请求进行转化。我们的代码中filerOder是0，也就是说我们的filter会在请求的转化PreDecorationFiter之前执行，好了，问题就在这里了，我们用set方法修改了url,在执行到PreDecorationFiter的时候，它在原生的request 基础上处理请求，将我们之前的操作覆盖，所以最终发送给backend的请求就是没有经过set的请求。

Q3:怎么解决这个问题？
A3:我们需要改变两个地方：

• 通过RequestContext.getCurrentContext().get("requestURI")获取当时的uri，requestURI属性在PreDecorationFiter时会被赋值，在这之前它是没有值的。
• 在oeder 为5的时候会进行转化，所以我们需要把set方法的执行放在5之后，比如：return filterOrder函数的返回值为6.

反思：感觉自己昨天一天学习zuul的时候，学的还是太浅，只是把zuul的demo跑起来，知道它大致的思路流程和怎么用，并没有把相关的细节搞明白。

action

学习新知识的时候不要浅尝辄止，不仅要知道怎么用，还要知道为什么，去官网要看看细节和原理性的东西。