系列学习 Gateway 之第 3 篇 —— 过滤器 Filter,自定义全局过滤器
本篇博客基于:https://blog.csdn.net/BiandanLoveyou/article/details/117323743
过滤器的作用
当我们有很多个服务时,比如会员服务、订单服务、商品服务等服务,客户端请求各个服务的 Api 时,每个服务都需要做相同的事情,比如鉴权、限流、日志输出等。对于这样重复的工作,我们就在微服务的上一层加一个全局的权限控制、限流、日志输出的 Api Gatewat 服务,然后再将请求转发到具体的业务服务层。这个Api Gateway服务就是起到一个服务边界的作用,外接的请求访问系统,必须先通过网关层。
过滤器的生命周期
Gateway 同 Zuul 类似,有“pre”和“post”两种方式的filter。客户端的请求先经过“pre”类型的filter,然后将请求转发到具体的业务服务,比如 goods-service,收到业务服务的响应之后,再经过“post”类型的 filter 处理,最后返回响应到客户端。
Gateway过滤器分类
Gateway 的过滤器 Filter 分为2种:Gateway Filter 和 Global Filter。
过滤器 Filter 将会对请求和响应进行修改处理。Gateway Filter 是针对于单个路由的过滤器,它在配置文件中的写法同 predicate 类似;Global Filter 是针对于所有路由的全局过滤器。
Gateway Filter 单个路由的过滤器简介
Gateway Filter 工厂同上一篇介绍的 predicate 工厂类似,都是在配置文件 application.yml 中配置,遵循了约定大于配置的思想,只需要在配置文件配置 GatewayFilter Factory的名称,而不需要写全部的类名,比如 AddRequestHeaderGatewayFilterFactory 只需要在配置文件中写AddRequestHeader,而不是全部类名。在配置文件中配置的 GatewayFilter Factory 最终都会相应的过滤器工厂类处理。下图给出 Gateway 内置过滤器一览表:
接下来以 path 过滤器为例子学习一下
Path过滤器之路径重写:RewritePath
Path 过滤器可以实现 URL 重写。通过重写 URL 可以隐藏实际路径,提高安全性,方便用户记忆和输入,易于被搜索引擎收录等优点。
spring:application:name: gateway-servercloud:gateway:routes:# 路由的 ID,没有固定规则但要求唯一,建议配合服务名# 产品微服务路由- id: product-server# 根据服务名称从注册中心获取服务地址uri: lb://product-server# 断言predicates:- Path=/product/**, /api-gateway/**# 配置过滤器filters:#此工厂将/api-gateway/(?.*)重写为{redirectURL},然后转发到对应的微服务- RewritePath=/api-gateway(?<redirectURL>/?.*), $\{redirectURL}
重启 Gateway 服务,浏览器地址访问:http://127.0.0.1:9999/api-gateway/product/1
说明 Gateway 帮我们把请求重定向到产品的微服务了,因为我们根本没有 api-gateway 路由。
实际开发过程中,很少用到很多内置的过滤器,因为跟之前 predicate 的解释一样,如果修改了某个规则,需要升级版本。开发用到最多的就是自己写一个全局过滤器这种方式。
Global Filter 全局过滤器简介
全局过滤器,不需要在配置文件中配置。作用在所有的路由上,最终通过 GatewayFilterAdapter 包装成 GatewayFilterChain 可识别的过滤器,它为请求业务以及路由的 URI 转为真实业务服务请求地址的核心过滤器,不需要配置,系统初始化时加载,并作用在每个路由上。通过全局过滤器可以实现鉴权、安全验证等功能。
下图中每一个 GlobalFilter 都作用在每一个 router上,能够满足大多数的业务需求。但我们也可以根据实际项目编写自己的全局过滤器。
自定义全局过滤器工厂
全局过滤器需要实现 GlobalFilter 和 Ordered 接口。我们改造 gateway 模块,代码结构如图:
创建 filter 包,在 filter 包下创建 MyGlobalFilter
package com.study.filter;import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.Ordered;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;/*** @author biandan* @description 自定义全局过滤器* @signature 让天下没有难写的代码* @create 2021-05-28 下午 5:35*/
@Component
public class MyGlobalFilter implements GlobalFilter, Ordered {/*** 过滤器业务逻辑* @param exchange* @param chain* @return*/@Overridepublic Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {System.out.println("********** 自定义全局过滤器被执行 ***********");return chain.filter(exchange);//继续往下执行}/*** 过滤器执行顺序,数值越小,优先级越高* @return*/@Overridepublic int getOrder() {return 0;}
}
因为全局过滤器是启动时就加载的,因此我们只需要在 MyGlobalFilter 类上添加注解 @Component 即可,无需注册 Bean。
然后修改 application.yml 配置如下(把配置里的 filter 注释掉,使用全局的过滤器):
server:port: 9999eureka:instance:hostname: 127.0.0.1client:serviceUrl:defaultZone: http://${eureka.instance.hostname}:8080/eureka/spring:application:name: gateway-servercloud:gateway:routes:# 路由的 ID,没有固定规则但要求唯一,建议配合服务名# 产品微服务路由- id: product-server# 根据服务名称从注册中心获取服务地址uri: lb://product-server# 断言predicates:- Path=/product/**# # 配置过滤器
# filters:
# #此工厂将/api-gateway/(?.*)重写为{redirectURL},然后转发到对应的微服务
# - RewritePath=/api-gateway(?<redirectURL>/?.*), $\{redirectURL}
重启 Gateway 微服务,浏览器地址输入:http://127.0.0.1:9999/product/1
查看后台控制台输出,说明我们自定义的全局过滤器被执行了:
实战:自定义全局过滤器实现统一鉴权
接下来,我们小试牛刀,通过自定义全局过滤器,进行一个小测试:通过 token 判断用户是否登录,完成统一鉴权的案例。
在 filter 包下创建:TokenGlobalFilter
package com.study.filter;import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.core.io.buffer.DataBuffer;
import org.springframework.http.HttpStatus;
import org.springframework.http.server.reactive.ServerHttpResponse;
import org.springframework.stereotype.Component;
import org.springframework.util.StringUtils;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;/*** @author biandan* @description* @signature 让天下没有难写的代码* @create 2021-05-29 上午 12:01*/
@Component
public class TokenGlobalFilter implements GlobalFilter, Ordered {/*** 过滤器业务逻辑:进行 token 校验* @param exchange* @param chain* @return*/@Overridepublic Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {//获取 token 参数,注意使用的是 getFirst 方法,getFirst 并不是获取第一个的意思String token = exchange.getRequest().getQueryParams().getFirst("token");if(!StringUtils.isEmpty(token)){if("123".equals(token)){//模拟 token 鉴权逻辑,实际项目应该是从 Redis 里获取System.out.println("鉴权成功!token="+token);return chain.filter(exchange);}}ServerHttpResponse response = exchange.getResponse();//响应类型response.getHeaders().add("Content-Type","application/json;charset=utf-8");//响应状态码:401,未授权response.setStatusCode(HttpStatus.UNAUTHORIZED);//响应内容String message = HttpStatus.UNAUTHORIZED.getReasonPhrase();DataBuffer buffer = response.bufferFactory().wrap(message.getBytes());return response.writeWith(Mono.just(buffer));}/*** 过滤器执行顺序,数值越小,优先级越高* @return*/@Overridepublic int getOrder() {return 1;}
}
说明:我们验证请求必须携带 token=123 才进行路由,否则认为未授权,返回失败信息。过滤器顺序设置为1,与之前的0区分。
重启 Gateway 微服务,测试。浏览器地址输入:http://127.0.0.1:9999/product/1
然后增加 token=123 的参数:http://127.0.0.1:9999/product/1?token=123
OK,过滤器我们讲解到这。
系列学习 Gateway 之第 3 篇 —— 过滤器 Filter,自定义全局过滤器相关推荐
- Gateway自定义全局过滤器
一.Gateway全局过滤器 1.全局过滤器(Global Filters)简介 Gateway过滤器在实现方式上,有两种过滤器: GatewayFilter(局部过滤器/网关过滤器): 需要通过 s ...
- Django框架学习20--模板变量,模板标签,模板过滤器及自定义模板过滤器,自定义模板标签
1.模板变量 string 字符串和 int 类型,通过key名称直接取值,如:{{ n_name }} list类型的取值,通过点下班取值,如:{{ fancy.0 }}.{{ fancy.1 }} ...
- 服务网关(Gateway)自定义全局过滤器统一Token处理
网关登录校验 在网关工程中添加全局过滤器 import com.alibaba.fastjson.JSON; import com.xuecheng.commons.model.vo.AuthIn ...
- asp.net mvc 自定义全局过滤器 验证用户是否登录
一般具有用户模块的系统都需要对用户是否登录进行验证,如果用户登录了就可以继续操作,否则退回用户的登录页面 对于这样的需求我们可以通过自定义一个独立的方法来完成验证的操作,但是这样代码的重复率就大大提高 ...
- Gateway网关-全局过滤器
全局过滤器 上一节学习的过滤器,网关提供了31种,但每一种过滤器的作用都是固定的.如果我们希望拦截请求,做自己的业务逻辑则没办法实现. 全局过滤器作用 全局过滤器的作用也是处理一切进入网关的请求和微服 ...
- SpringCloud Alibaba 2021微服务实战十三 gateway 全局过滤器打印日志及如何忽略全局过滤器
API 网关的职能 API 网关的分类与功能 下面讲解自定义过滤器 之记录日志功能应用! 全局过滤器拦截请求打印日志: 代码: package com.liu.learn.filter;import ...
- Java过滤器Filter讲解(Java基础)
你好我是辰兮,很高兴你能来阅读,本篇文章小结了Java过滤器的知识点,献给初学者,分享获取新知,希望我们一起进步. 文章目录 一.什么是过滤器 二.如何编写过滤器 三. 过滤器的配置 四.Filter ...
- JavaWeb过滤器(Filter)详解,是时候该把过滤器彻底搞懂了(万字说明)
注意:这篇文章很长,学习完后将会解决你对于过滤器(Filter)的所有疑惑,下面将通过理论和代码的结合来进行讲解演示..... 目录 基本介绍 过滤器原理 过滤器(Filter)接口 ...
- methods vue 使用过滤器_Vue.js中过滤器(filter)的使用
Vue.js 过滤器的基本使用(filter) vue中的过滤器分为两种:局部过滤器和全局过滤器 1.定义无参全局过滤器 Vue.filter('msgFormat', function(msg) { ...
- filter过滤器_Java过滤器Filter讲解(Java基础)
Java过滤器Filter讲解(Java基础) 双体的小伙伴们,Java过滤器Filter讲解(Java基础).初学JAVA的的学者们,今天满满的干货,跟随我一起学习吧. 超能就在这里 ...
最新文章
- Web开发人员为什么越来越懒了?
- GridSearchCV 与 RandomizedSearchCV 调参
- 采访与书评 —— 《BDD In Action》
- 2017/5 JavaScript基础4--- 表达式、运算符
- LeetCode-二分查找-35. 搜索插入位置
- Codeforces Round #260 (Div. 1) C. Civilization(dfs+并查集)
- 主线程 唤醒_python线程之九:生产者消费者3种方式,2个线程1个协程
- java数组的调用_java中数组的应用及方法
- postman安装路径_Newman进行postman脚本自动化
- 复制oracle9i数据库,Oracle 10g 中Duplicate 复制数据库
- 使用notebook 笔记(1)
- C# 如何理解如下泛型约束 class AT:where T:class{}
- 如何根治BYOD中国式“水土不服”
- ubuntu16.04连接android手机蓝牙共享网络热点
- centos树莓派版本安装ssh_树莓派安装系统+ssh登录
- iPhoneX开了个好头,苹果今年将推廉价版iPhoneX柏颖
- esp32~MP3音频文件学习,app架构
- Hello 内存 cache 主存 外存
- Laravel-excel安装及使用
- 精伦iDR210读卡器驱动安装教程