文章已收录到我的Github精选,欢迎Star:https://github.com/yehongzhi/learningSummary
写在前面
前一篇文章写了Gateway的Predicate(用于路由转发),那么这篇文章就介绍另一个主要的核心,那就是Filter(过滤器)。
过滤器有什么作用呢?工作流程是怎么样的呢?请看下图:
从图中很明显可以看出,在请求后端服务前后都需要经过Filter,于是乎Filter的作用就明确了,在PreFilter(请求前处理)可以做参数校验、流量监控、日志记录、修改请求内容等等,在PostFilter(请求后处理)可以做响应内容修改。
过滤器
Filter分为局部和全局两种:
- 局部Filter(GatewayFilter的子类)是作用于单个路由。如果需要使用全局路由,需要配置Default Filters。
- 全局Filter(GlobalFilter的子类),不需要配置路由,系统初始化作用到所有路由上。
局部过滤器
SpringCloud Gateway内置了很多路由过滤器,他们都是由GatewayFilter的工厂类产生。
AddRequestParameter GatewayFilter
该过滤器可以给请求添加参数。
比如我在consumer服务有一个带有userName
参数的接口,我想请求网关路由转发的时候给加上一个userName=yehongzhi
的参数。
@RequestMapping(value = "/getOrder",method = RequestMethod.GET)
public String getOrder(@RequestParam(name = "userName") String userName) {
return "获取到传入的用户名称:" + userName;
}
配置如下:
spring:
cloud:
gateway:
routes:
- id: add_request_parameter
uri: http://localhost:8081/getOrder
predicates:
- Method=GET
- Path=/getOrder
filters:
- AddRequestParameter=userName,yehongzhi
那么当我请求网关时,输入http://localhost:9201/getOrder
,我们能看到默认加上的userName。
StripPrefix GatewayFilter
该过滤器可以去除指定数量的路径前缀。
比如我想把请求网关的路径前缀的第一级去掉,就可以这样配置实现:
spring:
cloud:
gateway:
routes:
- id: strip_prefix_gateway
uri: http://localhost:8081
predicates:
- Path=/consumer/**
filters:
- StripPrefix=1
当请求路径http://localhost:9201/consumer/getDetail/1
,能获得结果。
相当于请求http://localhost:8081/getDetail/1
,结果是一样的。
PrefixPath GatewayFilter
该过滤器与上一个过滤器相反,是给原有的路径加上指定的前缀。
spring:
cloud:
gateway:
routes:
- id: prefix_path_gateway
uri: http://localhost:8081
predicates:
- Path=/getUserInfo/**
filters:
- PrefixPath=/consumer
当请求http://localhost:9201/getUserInfo/1
时,跟请求http://localhost:8081/consumer/getUserInfo/1
是一样的。
Hystrix GatewayFilter
网关当然有熔断机制,所以该过滤器集成了Hystrix,实现了熔断的功能。怎么使用呢?首先需要引入Hystrix的maven依赖。
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-hystrix</artifactId>
</dependency>
在gateway服务添加fallback()方法
@RestController
public