
SA实战 ·《SpringCloud Alibaba实战》第14章(二)
网关过滤器
过滤器可以在请求过程中,修改请求的参数和响应的结果等信息。在生命周期的角度总体上可以分为前置过滤器(Pre)和后置过滤器(Post)。在实现的过滤范围角度可以分为局部过滤器(GatewayFilter)和全局过滤器(GlobalFilter)。局部过滤器作用的范围是某一个路由,全局过滤器作用的范围是全部路由。
- Pre前置过滤器:在请求被网关路由之前调用,可以利用这种过滤器实现认证、鉴权、路由等功能,也可以记录访问时间等信息。
- Post后置过滤器:在请求被网关路由到微服务之后执行。可以利用这种过滤器修改HTTP的响应Header信息,修改返回的结果数据(例如对于一些敏感的数据,可以在此过滤器中统一处理后返回),收集一些统计信息等。
- 局部过滤器(GatewayFilter):也可以称为网关过滤器,这种过滤器主要是作用于单一路由或者某个路由分组。
- 全局过滤器(GlobalFilter):这种过滤器主要作用于所有的路由。
局部过滤器
局部过滤器又称为网关过滤器,这种过滤器主要是作用于单一路由或者某个路由分组。
局部过滤器概述
在SpringCloud Gateway中内置了很多不同类型的局部过滤器,主要如下所示。
演示内部过滤器
演示内部过滤器时,我们为原始请求添加一个名称为IP的Header,值为localhost,并添加一个名称为name的参数,参数值为binghe。同时修改响应的结果状态,将结果状态修改为1001。
(1)在服务网关的application.yml文件中的spring.cloud.gateway.routes节点下的- id: user-gateway下面进行如下配置。
(2)在用户微服务的io.binghe.shop.user.controller.UserController类中新增apiFilter1()方法,如下所示。
可以看到,在新增加的apiFilter1()方法中,获取到新增加的Header与参数,并将获取出来的参数与Header打印出来。并且方法返回的是字符串apiFilter1。
(3)分别启动用户微服务与网关服务,在浏览器中输入http://localhost:10001/server-user/user/api/filter1,如下所示。
此时,查看浏览器中的响应状态码,如下所示。
可以看到,此时的状态码已经被修改为1001。
接下来,查看下用户微服务的控制台输出的信息,发现在输出的信息中存在如下数据。
说明使用SpringCloud Gateway的内置过滤器成功为原始请求添加了一个名称为IP的Header,值为localhost,并添加了一个名称为name的参数,参数值为binghe。同时修改了响应的结果状态,将结果状态修改为1001,符合预期效果。
自定义局部过滤器
这里,我们基于SpringCloud Gateway自定义局部过滤器实现是否开启灰度发布的功能,整个实现过程如下所示。
(1)在服务网关的application.yml文件中的spring.cloud.gateway.routes节点下的- id: user-gateway下面进行如下配置。
(2)在网关服务模块shop-gateway中新建io.binghe.shop.filter包,在包下新建GrayscaleGatewayFilterConfig类,用于接收配置中的参数,如下所示。
(3)在io.binghe.shop.filter包下GrayscaleGatewayFilterFactory类,继承org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory类,主要是实现自定义过滤器,模拟实现灰度发布。代码如下所示。
(4)分别启动用户微服务和服务网关,在浏览器中输入http://localhost:10001/server-user/user/get/1001,如下所示。
可以看到,通过服务网关正确访问到了用户微服务,并正确获取到了用户信息。
接下来,查看下服务网关的终端,发现已经成功输出了如下信息。
说明正确实现了自定义的局部过滤器。
全局过滤器
全局过滤器是一系列特殊的过滤器,会根据条件应用到所有路由中。
全局过滤器概述
在SpringCloud Gateway中内置了多种不同的全局过滤器,如下所示。
演示全局过滤器
(1)在服务网关模块shop-gateway模块下的io.binghe.shop.config包下新建GatewayFilterConfig类,并在类中配置几个全局过滤器,如下所示。
注意:@Order注解中的数字越小,执行的优先级越高。
(2)启动用户微服务与服务网关,在浏览器中访问http://localhost:10001/server-user/user/get/1001,如下所示。
在服务网关终端输出如下信息。
说明我们演示的全局过滤器生效了。
自定义全局过滤器
SpringCloud Gateway内置了很多全局过滤器,一般情况下能够满足实际开发需要,但是对于某些特殊的业务场景,还是需要我们自己实现自定义全局过滤器。
这里,我们就模拟实现一个获取客户端访问信息,并统计访问接口时长的全局过滤器。
(1)在网关服务模块shop-order的io.binghe.shop.filter包下,新建GlobalGatewayLogFilter类,实现org.springframework.cloud.gateway.filter.GlobalFilter接口和org.springframework.core.Ordered接口,代码如下所示。
上述代码的实现逻辑还是比较简单的,这里就不再赘述了。
(2)启动用户微服务与网关服务,在浏览器中输入http://localhost:10001/server-user/user/api/filter1?name=binghe,如下所示。
接下来,查看服务网关的终端日志,可以发现已经输出了如下信息。
说明我们自定义的全局过滤器生效了。
网关熔断机制
其实熔断机制在《SA实战 ·《SpringCloud Alibaba实战》第13章-服务网关:项目整合SpringCloud Gateway网关》一文中就基于SpringCloud Gateway整合Sentinel实现了。大家可以参见《SA实战 ·《SpringCloud Alibaba实战》第13章-服务网关:项目整合SpringCloud Gateway网关》一文。
注意:整个实战案例基于SpringCloud Alibaba技术栈实现,所以,整个案例专栏也是偏向于使用SpringCloud Alibaba技术栈的。
好了,今天我们就到儿吧,限于篇幅,文中并未给出完整的案例源代码,想要完整源代码的小伙伴可加入【冰河技术】知识星球获取源码。也可以加我微信:hacker_binghe,一起交流技术。
文章转自公众号:冰河技术
