Gateway自定义过滤器——全局过滤器

news2024/11/26 18:45:47

一、什么是全局过滤器🍉

首先，我们要知道全局过滤器其实是特殊路由过滤器(特殊的GatewayFilter)，会有条件地作用于所有路由。
为什么要自定义全局过滤器？就好比是看大门的保安大叔，平时主要是做好进出大门外来人员登记即可，但是因为新冠疫情，现在还需要给外来人员测量体温等等。而已有的全局过滤器就好比是登记操作，而自定义的全局过滤器就好比是测量体温操作，是结合具体场景添加的。

比如以下场景：

  • 认证判断

  • 权限校验

  • 黑白名单

  • 跨域配置

工作原理：

当请求与路由匹配时，过滤WebHandler会将GlobalFilter的所有实例和GatewayFilter的所有特定于路由的实例添加到过滤器链中。该组合的过滤器链由org.springframework.core.Ordered接口排序，您可以通过实现getOrder()方法进行设置。
由于Spring Cloud Gateway区分了过滤器逻辑执行的“前”阶段和“后”阶段，因此具有最高优先级的过滤器在“前”阶段中是第一个，在“后”阶段中是最后一个。

二、自带的全局过滤器包含哪些🍉

要自定义全局过滤，首先我们应该去了解一下gateway自带的主要的全局过滤器有哪些，并了解他们的作用。

  • ForwardRoutingFilter

ForwardRoutingFilter在exchange属性ServerWebExchangeUtils.GATEWAY_REQUEST_URL_ATTR中查找URI。如果URL具有转发scheme（例如forward:/// localendpoint），则它将使用Spring DispatcherHandler来处理请求。请求URL的路径部分被转发URL中的路径覆盖。未经修改的原始URL会附加到ServerWebExchangeUtils.GATEWAY_ORIGINAL_REQUEST_URL_ATTR属性中的列表中。

  • LoadBalancerClientFilter

LoadBalancerClientFilter在ServerWebExchangeUtils.GATEWAY_REQUEST_URL_ATTR的exchange属性中查找URI。如果URL的方案为lb（例如lb:// myservice），它将使用Spring Cloud LoadBalancerClient将名称（在本例中为myservice）解析为实际的主机和端口，并替换同一属性中的URI。未经修改的原始URL会附加到ServerWebExchangeUtils.GATEWAY_ORIGINAL_REQUEST_URL_ATTR属性中的列表中。过滤器还会在ServerWebExchangeUtils.GATEWAY_SCHEME_PREFIX_ATTR属性中查找其是否等于lb。如果是，则适用相同的规则。下面的清单配置一个LoadBalancerClientFilter：

spring:
  cloud:
    gateway:
      routes:
      - id: myRoute
        uri: lb://service
        predicates:
        - Path=/service/**

注意1：默认情况下，当在LoadBalancer中找不到服务实例时，将返回503。您可以通过设置spring.cloud.gateway.loadbalancer.use404 = true将网关配置为返回404。

注意2：从LoadBalancer返回的ServiceInstance的isSecure值将覆盖对网关的请求中指定的方案。例如，如果请求通过HTTPS进入网关，但是ServiceInstance指示它不安全，则下游请求通过HTTP发出。相反的情况也可以适用。但是，如果在网关配置中为路由指定了GATEWAY_SCHEME_PREFIX_ATTR，则会删除前缀，并且路由URL产生的方案将覆盖ServiceInstance配置。

注意3：LoadBalancerClientFilter在默认情况下使用阻塞的LoadBalancerClient。建议改用ReactiveLoadBalancerClientFilter。可以通过将spring.cloud.loadbalancer.ribbon.enabled的值设置为false来切换到该值。

  • ReactiveLoadBalancerClientFilter

ReactiveLoadBalancerClientFilter与上面的LoadBalancerClientFilter类似，差异主要是ReactiveLoadBalancerClientFilter是非阻塞的。

注意1：与LoadBalancerClientFilter一样，默认情况下，当ReactorLoadBalancer无法找到服务实例时，将返回503。您可以通过设置spring.cloud.gateway.loadbalancer.use404 = true将网关配置为返回404。

  • NettyRoutingFilter

如果ServerWebExchangeUtils.GATEWAY_REQUEST_URL_ATTR的exchange属性中的URL带有http或https，则将运行NettyRoutingFilter。它使用Netty HttpClient发出下游代理请求。响应将放入ServerWebExchangeUtils.CLIENT_RESPONSE_ATTR的exchange属性中，供后面的过滤器使用。 （还有一个实验性的WebClientHttpRoutingFilter，它执行相同的功能，但不需要Netty。）

经过该过滤器时，会通过ServerWebExchangeUtils.setAlreadyRouted方法把exchange对象标记为“已路由”。

  • RouteToRequestUrlFilter

如果ServerWebExchangeUtils.GATEWAY_ROUTE_ATTR的exchange属性中存在Route对象，则RouteToRequestUrlFilter将运行。它基于请求URI创建一个新URI，但使用Route对象的URI属性进行更新。新的URI放置在ServerWebExchangeUtils.GATEWAY_REQUEST_URL_ATTR的exchange属性中。

如果URI具有scheme前缀（例如lb:ws://serviceid），则将从URI中剥离lb方案，并将其放在ServerWebExchangeUtils.GATEWAY_SCHEME_PREFIX_ATTR中，以供后面在过滤器链中使用。

  • WebsocketRoutingFilter

顾名思义，WebsocketRoutingFilter过滤器是用于处理websocket请求的，如果ServerWebExchangeUtils.GATEWAY_REQUEST_URL_ATTR的exchange属性中的URL具有ws或wss的schema，则将运行WebsocketRoutingFilter。它使用Spring WebSocket基础结构向下游转发websocket请求。

您可以通过为URI加上lb前缀来平衡websocket的负载，例如lb:ws://serviceid

经过该过滤器时，会通过ServerWebExchangeUtils.setAlreadyRouted方法把exchange对象标记为“已路由”。

配置示例如下，通常情况下，除了配置ws，还需要配置一个http的，因为发起websocket连接的请求是http请求。

# 官方示例
spring:
  cloud:
    gateway:
      routes:
      # SockJS route
      - id: websocket_sockjs_route
        uri: http://localhost:3001
        predicates:
        - Path=/websocket/info/**
      # Normal Websocket route
      - id: websocket_route
        uri: ws://localhost:3001
        predicates:
        - Path=/websocket/**
  • GatewayMetricsFilter

该过滤器主要用于做网关度量监控的，要启用，需添加spring-boot-starter-actuator依赖。然后，默认情况下，只要属性spring.cloud.gateway.metrics.enabled未设置为false，GatewayMetricsFilter就会运行。此过滤器添加一个带有以下标记的计时器度量标准，名为gateway.requests：

  • routeId: 路由ID.
  • routeUri: 需要路由的API
  • outcome: 结果分类参考 HttpStatus.Series.
  • status: 返回给客户端的http status
  • httpStatusCode: 返回给客户端的http status
  • httpMethod: 用户请求的http Method
    这些指标随后可从/actuator/metrics/gateway.requests中进行抓取，并可轻松地与Prometheus集成以创建Grafana dashboard。

要启用prometheus端点，请添加micrometer-registry-prometheus依赖。

三、如何自定义全局过滤器🍉

在这里演示过滤黑白名单

1.在配置文件中定义黑白名单🥝

在这里插入图片描述

#配置端口号
server:
  port: 81
#服务名称
spring:
  application:
    name: qy165-lzq
#配置路径规则
  cloud:
    gateway:
      routes:
        - id: lzq01 #路由的唯一标识-------随便起只要不重复就可以  如果不写默认uuid创建
          uri: http://localhost:8001  # 真是转发地址
          predicates:                 # 断言  当满足当前条件时进行跳转到uri  可以理解为判断
            - Path=/aaa/**

        - id: lzq02
          uri: lb://lzq-01      #lb 表示跳转方式 获取nacos上的服务器名
          predicates:
            - Path=/aaa/**
#连接nacos地址
    nacos:
      discovery:
        server-addr: localhost:8848
        register-enabled: false


filter:
  whitePaths:
    - "/product/login"
    - "/product/aaa"
    - "/product/bbb"
  blackPaths:
    - "/product/ccc"

2.定义工具类读取黑白名单🥝

在这里插入图片描述

package com.lzq.filter;

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

import java.util.HashSet;
import java.util.Set;

@Component
@ConfigurationProperties(prefix = "filter")
@Data
public class FilterUrl {
     private Set<String> whitePaths=new HashSet<>();
     private Set<String> blackPaths=new HashSet<>();


}

3.编写过滤器🥝

定义实体类实现接口

在这里插入图片描述

package com.lzq.filter;

import com.alibaba.fastjson.JSON;
import org.springframework.beans.factory.annotation.Autowired;
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.server.reactive.ServerHttpRequest;
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;

import java.nio.charset.StandardCharsets;
import java.util.HashMap;
import java.util.Map;
@Component
public class LogFilter implements GlobalFilter, Ordered {
    @Autowired
    private FilterUrl filterUrl;
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        ServerHttpRequest request = exchange.getRequest();
        ServerHttpResponse response = exchange.getResponse();
        //过滤的业务代码
        //1.获取请求路径---
        String path = request.getPath().toString();
        //判断该路径是否放行路径
        if(filterUrl.getWhitePaths().contains(path)){
            return chain.filter(exchange);
        }

        //获取请求头
        String token = request.getHeaders().getFirst("token");
        if(StringUtils.hasText(token)&&"admin".equals(token)){ //查看redis中是否存在该token
            return chain.filter(exchange);//放行
        }
        //json数据
        Map<String, Object> map = new HashMap<>();
        map.put("msg", "未登录");
        map.put("code", 403);

        //3.3作JSON转换
        byte[] bytes = JSON.toJSONString(map).getBytes(StandardCharsets.UTF_8);
        //3.4调用bufferFactory方法,生成DataBuffer对象
        DataBuffer buffer = response.bufferFactory().wrap(bytes);

        //4.调用Mono中的just方法,返回要写给前端的JSON数据
        return response.writeWith(Mono.just(buffer));

    }

    //Ordered:优先级 值越小 优先级越高
    @Override
    public int getOrder() {
        return 0;
    }
}

4.解决跨域问题🥝

第一种方式创建实体类

在这里插入图片描述

package com.lzq.config;



import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.cors.CorsConfiguration;
import org.springframework.web.cors.reactive.CorsWebFilter;
import org.springframework.web.cors.reactive.UrlBasedCorsConfigurationSource;
import org.springframework.web.util.pattern.PathPatternParser;

import java.util.Date;

@Configuration
public class CorConfig {
    //处理跨域
    @Bean
    public CorsWebFilter corsFilter() {
        CorsConfiguration config = new CorsConfiguration();
        config.addAllowedMethod("*");
        config.addAllowedOrigin("*");
        config.addAllowedHeader("*");
        UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource(new PathPatternParser());
        source.registerCorsConfiguration("/**", config);
        return new CorsWebFilter(source);
    }
}

第二种方式在配置文件中编写

在这里插入图片描述

server:
  port: 81
spring:
  application:
    name: gateway  #服务名称
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848 #nacos地址
    gateway:
      globalcors:
        add-to-simple-url-handler-mapping: true
        cors-configurations:
          '[/**]':  #拦截的请求
            allowedOrigins: #允许跨域的请求
              - "http://localhost:8080"
            allowedMethods: #运行跨域的请求方式
              - "GET"
              - "POST"
              - "DELETE"
              - "PUT"
              - "OPTIONS"
            allowedHeaders: "*" #允许请求中携带的头信息
            allowedCredentials: true #是否允许携带cookie
            maxAge: 36000 #跨域检测的有效期,单位s

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/764534.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

Chatglm实现agent控制

Chatglm实现agent控制

背景&#xff1a; 这个系列文章&#xff0c;会从LLM搭建应用生态角度来写。从0到1训练一个大的通用的模型对于大部分人和团队来讲是不现实的。重资金&#xff0c;重技术含量、重投入这几个门槛可以把很多团队直接劝退。那么在LLM蓬勃发展的时候我们可以做些什么呢&#xff0c;…
阅读更多...
C语言程序设计——字符、字符串、内存函数

C语言程序设计——字符、字符串、内存函数

一、长度不受限的字符串函数 1. strlen size_t strlen(const char* str); 功能&#xff1a;求字符串长度 &#xff08;1&#xff09;字符串以\0作为结束标志&#xff0c;strlen函数返回的是在字符串中\0之前出现的字符个数&#xff08;不包含\0&#xff09;。 &#xff08…
阅读更多...
【每日运维】大文件的分割与合并

【每日运维】大文件的分割与合并

产生背景 特殊单位需要将文件刻盘带入&#xff0c;并且刻盘有大小限制&#xff0c;所以有了这个需求 推荐方法 个人电脑上使用 split 命令指定大小分割Linux 服务上使用 cat 命令进行合并使用 md5sum 命令校验包的完整性 方法演示 需要将一个按照100M分割后刻盘导入 在个…
阅读更多...
数据结构 ~ 树

数据结构 ~ 树

什么是树 - tree 一种分层数据的抽象模型&#xff1b; 如&#xff1a;DOM、级联选择、树形控件&#xff0c;js 中没有树 可以用 Object 构建树&#xff1a; const tree {val: a,children: [{val: a-1,children: [{val: a-1-1,children: []}]},{val: a-2,children: [{val: a…
阅读更多...
mapbox绘制多边形

mapbox绘制多边形

1、实现效果 请忽略马赛克 2、实现思路 绘制一个填充的多边形&#xff0c;再描个边框。 3、实现代码 绘制多边形函数 drawPolygon() {map.addSource(maine, {type: geojson,data: https://asc-test1.oss-cn-beijing.aliyuncs.com/2023/07/05/45f6bd80f2f34d79b3e457b31ec5d…
阅读更多...
云原生网关如何实现安全防护能力

云原生网关如何实现安全防护能力

作者&#xff1a;刘晓瑞(钰诚) 云原生网关&#xff1a;将安全、流量和微服务三合一 作为面向南北向的公网网关&#xff0c;使用 Waf 防护异常流量是很常规的需求&#xff0c;而且随着互联网环境变得越来越复杂&#xff0c;用户对防护的诉求是持续增强的&#xff0c;常规做法是…
阅读更多...
需要我怎么帮你？关于维护Nutsdb开源社区的思考

需要我怎么帮你？关于维护Nutsdb开源社区的思考

背景 近来有人问我打算怎么继续维护Nutsdb社区&#xff0c;他们当中不乏有开源项目的狂热爱好者&#xff0c;发起了好几个几千star的开源项目&#xff0c;也有对Nutsdb感兴趣的&#xff0c;想来问问后续的计划。这不禁让我回想到从刚开始参与这个项目到最近这段时间一个人维护…
阅读更多...
三维重建的工作

三维重建的工作

文章目录 一、北京&#xff1a;二、广州&#xff1a;三、深圳&#xff1a; 一、北京&#xff1a; 链接 三维重建技术是自动驾驶领域4D真值数据生成的核心基础能力。融合LiDAR、Camera、IMU、轮速计等传感器数据像BlockNeRF一样重建城市级别逼真精细的三维场景&#xff0c;将…
阅读更多...
ArcGIS Pro 矢量数据的空间校正

ArcGIS Pro 矢量数据的空间校正

GIS 数据通常来自多个源。当数据源之间出现不一致时，有时需要执行额外的工作以将新数据集与其余数据进行整合。相对于基础数据而言，一些数据会在几何上发生变形或旋转。 在编辑环境中，空间校正提供用于对齐和整合数据的交互式方法。 空间校正可执行的一些任务包括：将数据…
阅读更多...
SQLite数据库安装

SQLite数据库安装

安装方式一&#xff1a; sudi apt-get install sqlite 安装方式二&#xff1a; https://www.sqlite.org/download.html 1. 把下载的文件 sqlite-autoconf-3420000.tar.gz 上传到开发板 2. tar xvf sqlite-autoconf-3420000.tar.gz 解压 3. cd sqlite-autoconf-3420000 进入…
阅读更多...
[Mysql] 索引失效的情况详解~

[Mysql] 索引失效的情况详解~

一条查询语句走了索引和没走索引的查询效率是非常大的&#xff0c;但有很多情况导致我们的索引失去效果。这里总结一下常见的索引失效的情况~ 数据准备 我们准备一张简单的学生来做演示。 CREATE TABLE student (id int NOT NULL COMMENT id,name varchar(255) COLLATE utf8…
阅读更多...
基于weka手工实现支持向量机smo算法

基于weka手工实现支持向量机smo算法

关于svm机器学习模型&#xff0c;我主要学习的是周志华老师的西瓜书&#xff08;《机器学习》&#xff09;&#xff1b; 但是西瓜书中对于参数优化&#xff08;即&#xff1a;Sequential Minimal Optimization&#xff0c;smo算法&#xff09;部分讲解的十分简略&#xff0c;看…
阅读更多...
Linux运维面试题（三）之shell编程类

Linux运维面试题（三）之shell编程类

Linux运维面试题&#xff08;三&#xff09;之shell编程类 文本截取有一个b.txt文本&#xff0c;要求将所有域名截取出来&#xff0c;并统计重复域名出现的次数统计当前服务器正在连接的IP地址&#xff0c;并按连接次数排序&#xff08;cut不能以空格做分隔符&#xff09; 随机…
阅读更多...
Vis相关的期刊会议

Vis相关的期刊会议

中国计算机学会推荐国际学术会议和期刊目录 文档&#xff0c; 下载 link&#xff1a;CCF推荐国际学术刊物目录-中国计算机学会 一.可视化方向文章 1.IEEE VIS&#xff0c;是由 IEEE Visualization and Graphics Technical Committee(VGTC) 主办的数据可视化领域的顶级会议&a…
阅读更多...
VMware桥接模式无法识别英特尔AX200无线网卡解决办法

VMware桥接模式无法识别英特尔AX200无线网卡解决办法

1.先到英特尔网站下载最新驱动&#xff0c;更新网卡驱动适用于 Intel 无线网络卡的 Windows 10 和 Windows 11* Wi-Fi 驱动程序 2.到控制面板查看无线网卡属性是否有下图组件 没有的话&#xff0c;依次操作 安装---服务---添加---从磁盘安装----浏览--进入VMware安装目录&…
阅读更多...
Linux系统的目录结构

Linux系统的目录结构

目录 一、Linux系统使用注意 1、Linux严格区分大小写 2、Linux文件"扩展名" 3、Linux中所有内容以文件形式保存 4、Linux中存储设备都必须在挂载之后才能使用 二、目录结构 1、Linux分区与Windows分区 2、Linux系统文件架构 3、Linux系统的文件目录用途 一、…
阅读更多...
Docker【安装与基本使用】

Docker【安装与基本使用】

【1】Docker的安装 注意&#xff1a;如果之前安装过docker其他版本&#xff0c;请删除干净。 docker-01 10.0.0.51 2G docker-02 10.0.0.52 2G docker-01 [rootdocker-01 ~]# cp -rp /usr/share/zoneinfo/Asia/Shanghai /etc/localtime cp: overwrite ‘/etc/localtime’? …
阅读更多...
（中等）LeetCode146 LRU 缓存 Java

（中等）LeetCode146 LRU 缓存 Java

本题有两种实现操作&#xff0c;需要使用到一个哈希表和一个双向链表。在Java语言中&#xff0c;有一种结合了哈希表和双向链表的数据结构&#xff0c;LinkedHashMap import java.util.LinkedHashMap; import java.util.Map;class LRUCache extends LinkedHashMap<Integer,…
阅读更多...
网络运维能转型到系统运维吗？

网络运维能转型到系统运维吗？

很多网工处于刚起步的初级阶段&#xff0c;各大公司有此专职&#xff0c;但重视或重要程度不高&#xff0c;可替代性强&#xff1b;小公司更多是由其它岗位来兼顾做这一块工作&#xff0c;没有专职&#xff0c;也不可能做得深入。 现在开始学习入门会有一些困难&#xff0c;不…
阅读更多...
【深度学习】日常笔记13

【深度学习】日常笔记13

前向传播&#xff08;forward propagation或forward pass&#xff09;指的是&#xff1a;按顺序&#xff08;从输⼊层到输出层&#xff09;计算和存储神经⽹络中每层的结果。 绘制计算图有助于我们可视化计算中操作符和变量的依赖关系。下图是与上述简单⽹络相对应的计算图&…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023