简介
今天我们要讲的是Gateway的过滤器，以下简称Filter。我们先来对要讲的内容做个简单的概括：
- 作用：过滤器就是在请求的传递过程中，对请求和响应做一些手脚；
- 生命周期：Pre、Post；
- 作用范围：局部过滤器(作用在某一个路由上)、全局过滤器(作用全部路由上)；
生命周期
在Gateway中，Filter的生命周期只有两个：Pre、Post。
- Pre：这种过滤器在请求被路由之前调用。我们可利用这种过滤器实现身份验证、在集群中选择请求的微服务、记录调试信息等。
- Post：这种过滤器在路由到微服务以后执行。这种过滤器可用来为响应添加标准的HTTP Header、收集统计信息和指标、将响应从微服务发送给客户端等。
作用范围
Gateway的Filter从作用范围可分为两种：GatewayFilter、GlobalFilter。
- GatewayFilter：应用到单个路由或者一个分组的路由上。
- GlobalFilter：应用到所有的路由上。
局部过滤器
局部过滤器是针对单个路由的过滤器。
内置局部过滤器
在SpringCloud Gateway中内置了很多不同类型的网关路由过滤器。具体如下：
| 过滤器工厂 | 作用 | 参数 |
|---|---|---|
| AddRequestHeader | 为原始请求添加Header | Header的名称及值 |
| AddRequestParameter | 为原始请求添加请求参数 | 参数名称及值 |
| AddResponseHeader | 为原始响应添加Header | Header的名称及值 |
| DedupeResponseHeader | 剔除响应头中重复的值 | 需要去重的Header名称及去重策略 |
| Hystrix | 为路由引入Hystrix的断路器保护 | HystrixCommand的名称 |
| FallbackHeaders | 为fallbackUri的请求头中添加具体的异常信息 | Header的名称 |
| PrefixPath | 为请求添加一个 preserveHostHeader=true的属性，路由过滤器会检查该属性以决定是否要发送原始的Host | 无 |
| RequestRateLimiter | 用于对请求限流，限流算法为令牌桶 | keyResolver、rateLimiter、statusCode、denyEmptyKey、emptyKeyStatus |
| RedirectTo | 将原始请求重定向到指定的URL | http状态码及重定向的url |
| RemoveHopByHopHeadersFilter | 为原始请求删除IETF组织规定的一系列Header | 默认就会启用，可以通过配置指定仅删除哪些Header |
| RemoveResponseHeader | 为原始请求删除某个Header | Header名称 |
| RemoveRequestHeader | 为原始请求删除某个Header | Header名称 |
| RewritePath | 重写原始的请求路径 | 原始路径正则表达式以及重写后路径的正则表达式 |
| RewriteResponseHeader | 重写原始响应中的某个Header | Header名称，值的正则表达式，重写后的值 |
| SaveSession | 在转发请求之前，强制执行websession::save操作 | 无 |
| secureHeaders | 为原始响应添加一系列起安全作用的响应头 | 无，支持修改这些安全响应头的值 |
| SetPath | 修改原始的请求路径 | 修改后的路径 |
| SetResponseHeader | 修改原始响应中某个Header的值 | Header名称，修改后的值 |
| SetStatus | 修改原始响应的状态码 | HTTP状态码，可以是数字，也可以是字符串 |
| StripPrefix | 用于截断原始请求的路径 | 使用数字表示要截断的路径的数量 |
| Retry | 针对不同的响应进行重试 | retries、statuses、methods、series |
| RequestSize | 设置允许接收最大请求包的大小。如果请求包大小超过设置的值，则返回413 Payload Too Large | 请求包大小，单位为字节，默认值为5M |
| ModifyRequestBody | 在转发请求之前修改原始请求体内容 | 修改后的请求体内容 |
| ModifyResponseBody | 修改原始响应体的内容 | 修改后的响应体内容 |
内置局部过滤器的使用
server:
port: 7000
spring:
application:
name: api-gateway
cloud:
nacos:
discovery:
server-addr: 127.0.0.1:8848
gateway:
discovery:
locator:
enabled: true # 让gateway可以发现nacos中的微服务
lowerCaseServiceId: true # 将请求路径上的服务名配置为小写
routes:
- id: shop-product #当前路由标识，要求唯一
uri: lb://shop-product #lb代表从nacos中获取微服务，shop-product是微服务的名称
order: 1 #路由的优先级，数字越小级别越高
predicates: #断言(就是路由转发要满足的条件)
- Path=/product/** #当请求路径满足Path指定的规则时,才进行路由转发
filters: #过滤器，请求在传递过程中可以通过过滤器对其进行一定的修改
- StripPrefix=1 #去掉请求路径的第一层
- SetStatus=200 #修改返回状态：设置响应的状态码为200
自定义局部过滤
1、在配置文件中，添加一个Log的过滤器配置
server:
port: 7000
spring:
application:
name: api-gateway
cloud:
nacos:
discovery:
server-addr: 127.0.0.1:8848
gateway:
discovery:
locator:
enabled: true # 让gateway可以发现nacos中的微服务
lowerCaseServiceId: true # 将请求路径上的服务名配置为小写
routes:
- id: shop-product #当前路由标识，要求唯一
uri: lb://shop-product #lb代表从nacos中获取微服务，shop-product是微服务的名称
order: 1 #路由的优先级，数字越小级别越高
predicates: #断言(就是路由转发要满足的条件)
- Path=/product/** #当请求路径满足Path指定的规则时,才进行路由转发
filters: #过滤器，请求在传递过程中可以通过过滤器对其进行一定的修改
- StripPrefix=1 #去掉请求路径的第一层
- Log=true, false #控制日志是否开启
2、自定义一个过滤器工厂，实现方法
@Component
public class LogGatewayFilterFactory extends AbstractGatewayFilterFactory<LogGatewayFilterFactory.Config> {
public LogGatewayFilterFactory() {
super(LogGatewayFilterFactory.Config.class);
}
@Override
public List<String> shortcutFieldOrder() {
return Arrays.asList("consoleLog", "cacheLog");
}
@Override
public GatewayFilter apply(LogGatewayFilterFactory.Config config) {
return new GatewayFilter() {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
if(config.isCacheLog()) {
// 缓存日志
System.out.println("cacheLog 已经开启了......");
}
if(config.isConsoleLog()) {
// 控制台日志
System.out.println("consoleLog 已经开启了......");
}
return chain.filter(exchange);
}
};
}
@Data
@NoArgsConstructor
public static class Config {
private boolean consoleLog;
private boolean cacheLog;
}
}
全局过滤器
全局过滤器作用于所有路由，无需配置。通过全局过滤器可以实现对权限的统一校验，安全性验证等功能。
内置全局过滤器
SpringCloud Gateway内部也是通过一系列的内置全局过滤器对整个路由转发进行处理如下：
自定义全局过滤器
内置的过滤器已经可以完成大部分的功能，但是对于企业开发的一些业务功能处理，还是需要我们自己编写过滤器来实现的，那么我们一起通过代码的形式自定义一个过滤器，去完成统一的权限校验。
开发中的鉴权逻辑：
- 当客户端第一次请求服务时，服务端对用户进行信息认证(登录)；
- 认证通过，将用户信息进行加密形成token，返回给客户端，作为登录凭证；
- 以后每次请求，客户端都携带认证的token；
- 服务端对token进行解密，判断是否有效；
如上图，对于验证用户是否已经登录鉴权的过程可以在网关统一检验。检验的标准就是请求中是否携带token凭证以及token的正确性。
下面我们自定义一个GlobalFilter去校验所有请求的请求参数中是否包含“token”，如果不包含请求参数“token”则不转发路由，否则执行正常的逻辑。
@Component
//自定义全局过滤器需要实现GlobalFilter和Ordered接口
public class AuthGlobalFilter implements GlobalFilter, Ordered {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
String token = exchange.getRequest().getQueryParams().getFirst("token");
if(StringUtils.isBlank(token)){
System.out.println("鉴权失败");
exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
return exchange.getResponse().setComplete();
}
//调用chain.filter继续向下游执行
return chain. filter(exchange);
}
@Override
public int getOrder() {
//顺序，数值越小，优先级越高
return 0;
}
}
演示结果如下：
总结
到这儿，Gateway 服务网关核心架构的过滤器就已经介绍完了。下一篇将为大家带来Gateway 服务网关限流相关的文章，敬请期待吧！
后续的文章，我们将继续完善我们的微服务系统，集成更多的Alibaba组件。想要了解更多JAVA后端知识，请点击文末名片与我交流吧。留下您的一键三连，让我们在这个寒冷的东西互相温暖吧！