zuul如果两个filter的order一样，是如何排序的？

最新推荐文章于 2023-07-23 21:30:20 发布

公众号:方志朋

最新推荐文章于 2023-07-23 21:30:20 发布

阅读量1.3k

点赞数 2

文章标签：网关 java spring redis spring boot

引言

最近有个网友问了一个问题，zuul中如果两个filter的order一样，是如何排序的？引起了我的兴趣，特地去阅读了它的源码。

zuul是干什么的

如果你有使用过springcloud应该听说过zuul，它的定位是分布式微服务中的API网关服务，当然后面可能要被gateway替代了。zuul是一个L7应用程序网关，提供了动态路由，监视，弹性，安全性等功能。zuul的大部分功能是通过filter实现的。

zuul定义了四种不同生命周期的filter

为了方便操作，zuul内置了一些filter，这些filter主要通过@EnableZuulServer和@EnableZuulProxy注解开启相关功能。@EnableZuulServer注解开启的filter功能如下：

@EnableZuulProxy注解除了开启上面这些filter功能之外，还开启了如下的功能：

如何自定义filter

只需继承ZuulFilter类，实现它的filterType、filterOrder、shouldFilter 和 run方法即可，具体实现可参考如下代码：

public class LogFilter extends ZuulFilter {

    @Override
    public String filterType() {
        return FilterConstants.PRE_TYPE;
    }

    @Override
    public int filterOrder() {
        return 1;
    }

    @Override
    public boolean shouldFilter() {
        return RequestContext.getCurrentContext().sendZuulResponse();
    }

    @Override
    public Object run() throws ZuulException {
        RequestContext currentContext = RequestContext.getCurrentContext();
        HttpServletRequest request = currentContext.getRequest();
        log.info("zuul pre filter-->" + request.getRequestURL() + "-->" + request.getMethod());
        return null;
    }
}

上面的四个方法有哪些作用呢？

方法名称	作用
filterType	filter类型，包含：pre、routing、post和error四种类型
filterOrder	排序，该值越小，filter越早执行
shouldFilter	开关，表示是否需要执行该filter
run	filter具体的功能方法

需要注意的是，要想使zuul的功能生效，切记要在springboot启动类上定义@EnableZuulServer或@EnableZuulProxy注解，表示开启zuul的功能。

filterOrder是如何排序的

先看看所有的zuulFilter在哪里执行的，谜底就在FilterProcessor类的runFilters方法中。

该方法很简单，先获取所有zuulFilter，然后遍历所有zuulFilter，调用processZuulFilter方法执行具体的zuulFilter，然后将执行结果返回。

我们重点看看这个方法

FilterLoader.getInstance().getFiltersByType(sType);

该方法的具体逻辑

根据filterType从缓存中获取filter集合，如果缓存中有直接返回
如果缓存中没有，则创建filter集合，将所有filter中跟filterType的filter添加到filter集合中。
排序filter集合
将新创建的filter集合放入缓存。

从上面可以看出filter的排序是通过如下方法执行的：

Collections.sort(list);

该方法底层其实是通过list的sort方法实现的

看看ArrayList的sort方法，传入的Comparator为null

它的底层又是通过Arrays类的静态方法sort实现的

由于上一步Comparator为null，则会执行sort方法。

该方法是通过ComparableTimSort类的sort方法实现的，这个方法是最核心的方法了

我们可以看到该方法其实是通过binarySort二分查找排序的。

通过compareTo方法比较大小。

我们回头再看看ZuulFilter类

它实现了Comparable接口，重写了compareTo方法

所以，看到这里我们可以得出结论：ZuulFilter是通过Integer的compare方法比较filterOrder参数值大小来排序的。

如果filterOrder一样如何排序？

我们看看Integer的compare方法具体的逻辑

如果x==y，则返回0，x<y，则返回 -1，否则返回1 前面在二分查找中，只有x<y时，才会交换位置。看到这里，我们得出这样的结论，如果filterOrder一样，则Collections.sort(list);排序时不交换位置，这按照ZuulFilter默认加载顺序。那么，ZuulFilter的默认加载顺序是怎么样的？

它是通过getAllFilters方法获取ZuulFilter集合，该方法其实返回的是名称为filters的ConcurrentHashMap的values，即返回Set集合，是无序的。

重要的事情说三遍：如果filterOrder一样，ZuulFilter是无序的。
重要的事情说三遍：如果filterOrder一样，ZuulFilter是无序的。
重要的事情说三遍：如果filterOrder一样，ZuulFilter是无序的。

所以，filterOrder切记不要定义相同的，不然可能会出现无法预知的执行结果。

两种排序方法

自定义排序其实有两种方法：

实现Comparable接口，重写compareTo方法，
实现Comparator接口，重写compare方法
如果要使用Collections.sort(list);排序，它默认用的是第一种方法，上面的filterOrder之所以可以排序，是因为Integer实现了Comparable接口，重写了compareTo方法

如果想自己定义排序规则可以通过实现Comparator接口，重写compare方法。

Collections.sort(list,new Comparator<Integer>(){
    @Override
    public int compare(Integer o1, Integer o2) {
        return o2 - o1;
    }
});

它的底层也是通过二分查找实现的

那么这两种方法有什么区别呢？

Comparable接口位于java.lang包下，而Comparator接口位于java.util包下。
Comparable接口是内部比较器，一个类如果想要使用Collections.sort(list) 方法进行排序，则需要实现该接口
Comparator接口是外部比较器用于对那些没有实现Comparable接口或者对已经实现的Comparable中的排序规则不满意进行排序.无需改变类的结构，更加灵活。

彩蛋

zuul中是通过filterOrder参数的大小排序的，而在spring中是通过@Order注解排序的。

默认情况下，如果不指定value值，则value是Integer的最大值。由于排序规则是value越小，则排在越靠前，所以如果不指定value值，则它排在最后。

spring是通过OrderComparator类排序的，它实现了Comparator接口，它的doCompare方法实现的排序。

最终也是调用Integer类的compare方法，该方法前面已经介绍过了。

热门内容：

最近面试BAT，整理一份面试资料《Java面试BAT通关手册》，覆盖了Java核心技术、JVM、Java并发、SSM、微服务、数据库、数据结构等等。获取方式：点“在看”，关注公众号并回复 666 领取，更多内容陆续奉上。
明天见(｡･ω･｡)ﾉ♡

公众号:方志朋

关注

2
点赞
踩
3

收藏

觉得还不错? 一键收藏
1
评论
zuul如果两个filter的order一样，是如何排序的？

引言最近有个网友问了一个问题，zuul中如果两个filter的order一样，是如何排序的？引起了我的兴趣，特地去阅读了它的源码。zuul是干什么的如果你有使用过springcloud应该...
复制链接

扫一扫