Spring Cloud Zuul之ZuulFilter详解

时间：2024-04-16 10:08:23

简介

Spring Cloud Zuul网关在整个微服务体系中肩负对外开放接口、请求拦截、路由转发等作用，其核心处理则是ZuulFilter

ZuulFilter部分源码

Zuul Filter全部继承于com.netflix.zuul.ZuulFilter这个抽象类，该抽象类则实现了com.netflix.zuul.IZuulFilter和java.lang.Comparable，其中IZuulFilter接口定义了以下两个方法。

  • shouldFilter() 判断是否致性run()方法
  • run() 过滤器核心方法，实现该方法从而达到我们的目的

ZuulFilter定义了以下方法

abstract public String filterType();

filterType定义过滤器的类型，按照类型对过滤器进行分类，以下是四种过滤器的作用

  1. “pre”过滤器：用于处理路由前缀或路由前预处理
  2. “route”过滤器：将接受到的请求转发至指定服务
  3. “error”过滤器：用于错误处理
  4. “post”过滤器：路由后处理，位于前三个过滤器之前，是最后一个调用的

 

public boolean isStaticFilter() {return true; // 默认为true}

isStaticFilter用于判断是否是静态的。静态过滤器是无状态的，可以重写该方法来覆盖默认值。

 

abstract public int filterOrder();

filterOrder用于判断过滤器的执行顺序，数字越小则执行得更早。

 

public boolean isFilterDisabled() // 默认为false

isFilterDisabled用于判断过滤器是否关闭，可重写该方法覆盖默认值。

 

ZuulFilter执行链

 

 

ZuulFilter的加载

Filter的加载所需要的主要类在Zuul-Core包下，这里简单介绍一下

  • ZuulServlet 负责Zuul初始化以及Filter的执行
  • ZuulRunner 负责将用户请求的javax.servlet.http.HttpServletRequest包装成com.netflix.zuul.http.HttpServletRequestWrapper。并封装ZuulProcessor的方法，以对外部类提供访问方式
  • ZuulProcessor 负责Filter的具体执行
  • ZuulLoader 负责加载过滤器到当前过滤器链中

 

Zuul默认过滤器

在Spring Cloud Zuul中，为了让api网关组件可以被更方便的使用，它在http请求生命周期的各个阶段默认实现了一批核心过滤器，它们会在api网关服务启动的时候被自动加载和启动。我们可以在源码中查看和了解它们，它们定义与spring-cloud-netflix-core模块的
org.springframework.cloud.netflix.zuul.filters包下。在默认启动的过滤器中包含三种不同生命周期的过滤器，这些过滤器都非常重要，可以帮组我们理解zuul对外部请求处理的过程，以及帮助我们在此基础上扩展过滤器去完成自身系统需要的功能。

 

Pre过滤器

  • ServletDetectionFilter：它的执行顺序为-3，是最先被执行的过滤器。该过滤器总是会被执行，主要用来检测当前请求是通过Spring的DispatcherServlet处理运行的，还是通过ZuulServlet来处理运行的。它的检测结果会以布尔类型保存在当前请求上下文的isDispatcherServletRequest参数中，这样后续的过滤器中，我们就可以通过RequestUtils.isDispatcherServletRequest()和RequestUtils.isZuulServletRequest()方法来判断请求处理的源头，以实现后续不同的处理机制。一般情况下，发送到api网关的外部请求都会被Spring的DispatcherServlet处理，除了通过/zuul/*路径访问的请求会绕过DispatcherServlet（比如之前我们说的大文件上传），被ZuulServlet处理，主要用来应对大文件上传的情况。另外，对于ZuulServlet的访问路径/zuul/*，我们可以通过zuul.servletPath参数进行修改。

       

  • Servlet30WrapperFilter：它的执行顺序为-2，是第二个执行的过滤器，目前的实现会对所有请求生效，主要为了将原始的HttpServletRequest包装成Servlet30RequestWrapper对象。

       

FormBodyWrapperFilter：它的执行顺序为-1，是第三个执行的过滤器。该过滤器仅对两类请求生效，第一类是Context-Type为application/x-www-form-urlencoded的请求，第二类是Context-Type为multipart/form-data并且是由String的DispatcherServlet处理的请求（用到了ServletDetectionFilter的处理结果）。而该过滤器的主要目的是将符合要求的请求体包装成FormBodyRequestWrapper对象。


  • DebugFilter：它的执行顺序为1，是第四个执行的过滤器，该过滤器会根据配置参数zuul.debug.request和请求中的debug参数来决定是否执行过滤器中的操作。而它的具体操作内容是将当前请求上下文中的debugRouting和debugRequest参数设置为true。由于在同一个请求的不同生命周期都可以访问到这二个值，所以我们在后续的各个过滤器中可以利用这二个值来定义一些debug信息，这样当线上环境出现问题的时候，可以通过参数的方式来激活这些debug信息以帮助分析问题，另外，对于请求参数中的debug参数，我们可以通过zuul.debug.parameter来进行自定义。

  • PreDecorationFilter：执行顺序是5，是pre阶段最后被执行的过滤器，该过滤器会判断当前请求上下文中是否存在forward.do和serviceId参数，如果都不存在，那么它就会执行具体过滤器的操作（如果有一个存在的话，说明当前请求已经被处理过了，因为这二个信息就是根据当前请求的路由信息加载进来的）。而当它的具体操作内容就是为当前请求做一些预处理，比如说，进行路由规则的匹配，在请求上下文中设置该请求的基本信息以及将路由匹配结果等一些设置信息等，这些信息将是后续过滤器进行处理的重要依据，我们可以通过RequestContext.getCurrentContext()来访问这些信息。另外，我们还可以在该实现中找到对HTTP头请求进行处理的逻辑，其中包含了一些耳熟能详的头域，比如X-Forwarded-Host,X-Forwarded-Port。另外，对于这些头域是通过zuul.addProxyHeaders参数进行控制的，而这个参数默认值是true，所以zuul在请求跳转时默认会为请求增加X-Forwarded-*头域，包括X-Forwarded-Host,X-Forwarded-Port，X-Forwarded-For，X-Forwarded-Prefix,X-Forwarded-Proto。也可以通过设置zuul.addProxyHeaders=false关闭对这些头域的添加动作。

Route过滤器

  • RibbonRoutingFilter:它的执行顺序为10，是route阶段的第一个执行的过滤器。该过滤器只对请求上下文中存在serviceId参数的请求进行处理，即只对通过serviceId配置路由规则的请求生效。而该过滤器的执行逻辑就是面向服务路由的核心，它通过使用ribbon和hystrix来向服务实例发起请求，并将服务实例的请求结果返回。这里摘选一部分源码，SERVICE_ID_KEY等参数则是在PreDecorationFilter中预处理

       

       

  • SimpleHostRoutingFilter：它的执行顺序为100，是route阶段的第二个执行的过滤器。该过滤器只对请求上下文存在routeHost参数的请求进行处理，即只对通过url配置路由规则的请求生效。而该过滤器的执行逻辑就是直接向routeHost参数的物理地址发起请求，从源码中我们可以知道该请求是直接通过httpclient包实现的，而没有使用Hystrix命令进行包装，所以这类请求并没有线程隔离和断路器的保护。

       

  • SendForwardFilter：它的执行顺序是500，是route阶段第三个执行的过滤器。该过滤器只对请求上下文中存在的forward.do参数进行处理请求，即用来处理路由规则中的forward本地跳转装配。

        



Post过滤器


    

  • SendErrorFilter：它的执行顺序是0，是post阶段的第一个执行的过滤器。该过滤器仅在请求上下文中包含error.status_code参数（由之前执行的过滤器设置的错误编码）并且还没有被该过滤器处理过的时候执行。而该过滤器的具体逻辑就是利用上下文中的错误信息来组成一个forward到api网关/error错误端点的请求来产生错误响应。
    • 



        


    

  • SendResponseFilter：它的执行顺序为1000，是post阶段最后执行的过滤器，该过滤器会检查请求上下文中是否包含请求响应相关的头信息，响应数据流或是响应体，只有在包含它们其中一个的时候执行处理逻辑。而该过滤器的处理逻辑就是利用上下文的响应信息来组织需要发送回客户端的响应内容。
    • 



自定义过滤器使用场景


    

  1. XSS过滤，可以利用Pre过滤器预先处理数据，防止不安全数据到下游服务。
    2. 

  2. 接口权限过滤，同样是采用Pre过滤器验证当前用户是否拥有访问权限。
    3. 

  3. 灰度发布，可以采用Route过滤器自定义路由规则
    4. 






            

            
        

	    
	    
    


相关文章