spring-cloud-gateway之GatewayFilterFactory

在前一篇GlobalFilter中剖析了gateway的全局过滤器的设计与实现；全局过滤器是针对于网关而言通用的功能组件实现，采用全局来实现。而对于有些非通用的功能或者面向用户自定义的功能采用全局过滤器实现显然是不合理的，基于此出发开源作者变换了思路，采用工厂模式来即时生产一个自定义或者配置的过滤器来过滤当前的请求。

工厂接口与工厂类依赖图

自上而下分析

gateway声明了一个工厂接口GatewayFilterFactory，此接口继承了ShortcutConfigurable，Configurable接口。默认不支持Configurable接口的操作，需要继承AbstractNameValueGatewayFilterFactory才具备Configuable接口行为。

GatewayFilterFactory

Configurable接口是为了实现一些配置信息（key-value）的使用方便而声明的一个interface，具体作用体现在AbstractNameValueGatewayFilterFactory的子类实现中。

FunctionalInterface函数式接口声明注解，将GatewayFilterFactory声明为一个函数式接口。

ShortcutConfigurable是gateway实现的一个支持工具类，用于参数解析。包含两个枚举实现类，DEFAULT和GATHER_LIST，gateway默认使用的DEFAULT；RouteDefinitionRouteLocator＃lookup方法中解析断言参数时使用了此枚举解析；在RouteDefinitionRouteLocator＃loadGatewayFilters方法中加载配置过滤器时也使用此枚举解析。

AbstractGatewayFilterFactory是GatewayFilterFactory接口的直接抽象实现类，作者意图在于实现扩展性，并且标明是一个会被release的类。

AbstractNameValueGatewayFilterFactory是AbstractGatewayFilterFactory的其中一个抽象子类，重点在于其泛型Config类是一个键值对类型的，被若干个键值对配置的子类继承，如AddRequestHeaderGatewayFilterFactory等。

AbstractChangeRequestUriGatewayFilterFactory是AbstractGatewayFilterFactory的另一个抽象子类，泛型参数与AbstractGatewayFilterFactory一致，只有一个参数名，实现类目前只有RequestHeaderToRequestUriGatewayFilterFactory。

过滤器工厂类分析

• AddRequestHeaderGatewayFilterFactory
  在request header中添加一个键值对的header参数。

• AddRequestParameterGatewayFilterFactory
  在request query参数列表中添加一个查询参数。

• AddResponseHeaderGatewayFilterFactory
  在response header中添加一个键值对的header参数。

• DedupeResponseHeaderGatewayFilterFactory
  删除response header中重复的数据项，分别有三种数据保留策略。

• HystrixGatewayFilterFactory
  熔断器，集成了Netflix开源的Hystrix框架熔断功能，为了避免服务在故障时引发级联故障，通过Hystrix允许下游服务故障时提供熔断返回或者请求转发操作；主要转发逻辑在RouteHystrixCommand中的resumeWithFallback函数中。

   

  

• FallbackHeadersGatewayFilterFactory
  熔断操作引发原因，声明熔断异常类型，这在2.0.2之后的版本才支持。下图是官方最新版本文档说明中的截图，从说明中可以明白可以为不同异常配置不同的熔断路径，并标明异常类型。

• PrefixPathGatewayFilterFactory
  为请求的Uri添加一个前缀路径，Restful Api经常以/api作为规范开头路径，则可以为客户端自动添加此规范，客户端则无需遵循此规范。

• PreserveHostHeaderGatewayFilterFactory
  此过滤器没有参数，配置一个声明属性即可，标明时候对请求Host进行验证，验证操作不发生于此过滤器中。

   

  

• RedirectToGatewayFilterFactory
  将配置所指定的域名请求重定向至所配置地址，并设置当前请求状态码为3XX。

   

  

• RemoveRequestHeaderGatewayFilterFactory
  这个与AddRequestHeaderGatewayFilterFactory呼应，只不过是删除request header中指定的header参数。

• RemoveResponseHeaderGatewayFilterFactory
  与AddResponseHeaderGatewayFilterFactory呼应，删除response header中的指定参数。

• RequestHeaderToRequestUriGatewayFilterFactory
  需要一个NameConfig参数（需要通过此参数在header中获取header属性值），只需要在配置文件中声明开启，前提需要在request header中存在配置参数名的header属性存在；将当前请求的Uri替换成header中指定的Uri；注意这个工厂类的apply方法在父类中，自身只重写了determineRequestUri方法。

• RequestRateLimiterGatewayFilterFactory
  流量限制过滤器，这个实现比较复杂的，基于redis + lua script实现的。

   

  

• RequestSizeGatewayFilterFactory
  限制请求体的大小，默认是5M；这个工厂类也是在2.0.2版本之后加入的。

• RetryGatewayFilterFactory
  重试机制，可以配置指定重试的错误级别和方法类型。

   

  

• RewritePathGatewayFilterFactory
  重写请求的Uri，配置参数需要遵循正则表达式的规则。

• RewriteResponseHeaderGatewayFilterFactory
  重写response中指定的header参数。

• SaveSessionGatewayFilterFactory
  缓存当前请求的Session，调用Web Server的方法缓存，这里是Http Server的动作。

• SecureHeadersGatewayFilterFactory
  为request header添加若干属性。

• SetPathGatewayFilterFactory
  替换Path断言中的路径。

• SetRequestHeaderGatewayFilterFactory
  与AddRequestHeaderGatewayFilterFactory功能相似，一个是全局替换，一个是追加，某种情况下作用一致。

• SetResponseHeaderGatewayFilterFactory
  与AddResponseHeaderGatewayFilterFactory功能相似，这里是设置，而AddResponseHeaderGatewayFilterFactory中是往已存在的header属性集合中添加，当header属性为空时两个作用是一样的。

• SetStatusGatewayFilterFactory
  根据配置设置请求的返回状态。

• StripPrefixGatewayFilterFactory
  这个与PrefixPathGatewayFilterFactory类似，只不过是按照配置截掉Uri的部分path。

Summary

gateway的过滤器工厂类不同于GlobalFilter，所有的过滤器工厂实现类均在GatewayAutoConfiguration中进行注入BeanFactory中，根据每个路由配置的具体gatewayFilter从beanFactory中获取工厂类进行配置并注入对应的RouteLocator；GatewayFilter和GlobalFilter一样最终被封装成OrderedGatewayFilter，然后为每个请求分配一个定制的GatewayFilterChain

作者：Lance徐绍校
链接：https://www.jianshu.com/p/346cc3356784
来源：简书
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。