Gateway自定义局部过滤器与自定义全局过滤器

最新推荐文章于 2024-06-06 18:54:11 发布

幽游白酥

最新推荐文章于 2024-06-06 18:54:11 发布

阅读量7.3k

点赞数 5

文章标签： gateway filter

本文链接：https://blog.csdn.net/duan_yuer/article/details/120117242

版权

Gateway自定义局部过滤器与自定义全局过滤器

什么是Gateway
Gateway核心概念
Gateway的使用
什么是Gateway过滤器
自定义局部过滤器
自定义全局过滤器

什么是Gateway

Spring Cloud Gateway组件的核心是一系列的过滤器，通过这些过滤器可以将客户端发送的请求转发（路由）到对
应的微服务。 Spring Cloud Gateway是加在整个微服务最前沿的防火墙和代理器，隐藏微服务结点IP端口信息，
从而加强安全保护。Spring Cloud Gateway本身也是一个微服务，需要注册到Eureka服务注册中心。

Gateway核心概念

路由（route）
路由信息的组成：由一个ID、一个目的URL、一组断言工厂、一组Filter组成。如果路由断言为真，说明请求URL和配置路由匹配。
断言（Predicate） Spring Cloud Gateway中的断言函数输入类型是Spring
5.0框架中的ServerWebExchange。Spring Cloud Gateway的断言函数允许开发者去定义匹配来自于HTTP Request中的任何信息比如请求头和参数。
过滤器（Filter）一个标准的Spring WebFilter。 Spring Cloud
Gateway中的Filter分为两种类型的Filter，分别是Gateway Filter和Global
Filter。过滤器Filter将会对请求和响应进行修改处理

Gateway作为网关的其中一个重要功能，就是实现请求的鉴权。而这个动作往往是通过网关提供的过滤器来实现的

Gateway的使用

引入Gateway依赖

<dependencies>
	<dependency>
		<groupId>org.springframework.cloud</groupId>
		<artifactId>spring-cloud-starter-gateway</artifactId>
	</dependency>
	<dependency>
		<groupId>org.springframework.cloud</groupId>
		<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
	</dependency>
</dependencies>

编写启动类

@SpringBootApplication
@EnableDiscoveryClient
public class GatewayApplication {
public static void main(String[] args) {
SpringApplication.run(GatewayApplication.class, args);
}
}

编写配置

server:
  port: 10010
spring:
  application:
    name: api-gateway
  cloud:
    gateway:
      routes:
     # 路由id，可以随意写
      - id: user-service-route
     # 代理的服务地址
      uri: HTTP://127.0.0.1:9091
     # 路由断言，可以配置映射路径
      predicates:
        - Path=/user/**
eureka:
  client:
    service-url:
      defaultZone: HTTP://127.0.0.1:10086/eureka
  instance:
    prefer-ip-address: true

什么是Gateway过滤器

Gateway作为网关的其中一个重要功能，就是实现请求的鉴权。而这个动作往往是通过网关提供的过滤器来实现的

常见自带过滤器：

过滤器名称	说明
AddRequestHeader	对匹配上的请求加上Header
AddRequestParameters	对匹配上的请求路由添加参数
AddResponseHeader	对从网关返回的响应添加Header
StripPrefix	对匹配上的请求路径去除前缀

在这里插入图片描述

路由前缀

客户端的请求地址与微服务的服务地址如果不一致的时候，可以通过配置路径过滤器实现路径前缀的添加和去除。

提供服务的地址：http://127.0.0.1:9091/user/8

添加前缀：对请求地址添加前缀路径之后再作为代理的服务地址；

http://127.0.0.1:10010/8 --> http://127.0.0.1:9091/user/8 添加前缀路径/user

去除前缀：将请求地址中路径去除一些前缀路径之后再作为代理的服务地址

http://127.0.0.1:10010/api/user/8 --> http://127.0.0.1:9091/user/8 去除前缀路径/api

添加前缀

在gateway中可以通过配置路由的过滤器PrefixPath，实现映射路径中地址的添加；

spring:
  cloud:
    gateway:
      routes:
        #路由的id，可以随意些
        - id: user-service-rote
          #代理的微服务地址
          #  uri: http://127.0.0.1:9999
          uri: lb://user-service
          # 路由断言，可以配置映射路径
          predicates:
            - Path=/**
          filters:
            # 添加请求路径的前缀
            - PrefixPath=/user

通过 PrefixPath=/xxx 来指定了路由要添加的前缀。也就是：

PrefixPath=/user http://localhost:10010/8 --》http://localhost:9091/user/8
PrefixPath=/user/abc http://localhost:10010/8 --》http://localhost:9091/user/abc/8

添加前缀

在gateway中可以通过配置路由的过滤器StripPrefix，实现映射路径中地址的去除：

spring:
  cloud:
    gateway:
      routes:
        #路由的id，可以随意些
        - id: user-service-rote
          #代理的微服务地址
          #  uri: http://127.0.0.1:9999
          uri: lb://user-service
          # 路由断言，可以配置映射路径
       	  predicates:
            - Path=/api/user/**
          filters:
            # 表示过滤1个路径，2表示两个路径，以此类推
            - StripPrefix=1

通过 StripPrefix=1 来指定了路由要去掉的前缀个数。如：路径 /api/user/1 将会被代理到 /user/1 。也就是：

StripPrefix=1 http://localhost:10010/api/user/8 --》http://localhost:9091/user/8
StripPrefix=2 http://localhost:10010/api/user/8 --》http://localhost:9091/8

执行生命周期

Spring Cloud Gateway 的 Filter 的生命周期也类似Spring MVC的拦截器有两个：“pre” 和 “post”。“pre”和 “post”分别会在请求被执行前调用和被执行后调用

在这里插入图片描述
这里的 pre 和 post 可以通过过滤器的 GatewayFilterChain 执行filter方法前后来实现

使用场景

请求鉴权：一般 GatewayFilterChain 执行filter方法前，如果发现没有访问权限，直接就返回空。
异常处理：一般 GatewayFilterChain 执行filter方法后，记录异常并返回。
服务调用时长统计： GatewayFilterChain 执行filter方法前后根据时间统计。

自定义局部过滤器

需求：在过滤器（MyParamGatewayFilterFactory）中将http://localhost:10010/user/8?name=yh 中的参数name的值获取到并输出到控制台

在application.yml文件中添加gateway过滤器：
在这里插入图片描述

在这里插入图片描述](https://img-blog.csdnimg.cn/0bafd595c32841a9872c31236d4a442a.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA5bm95ri455m96YWl,size_20,color_FFFFFF,t_70,g_se,x_16)

建立一个文件config，创建名为MyParamGatewayFiterFactory的类
注意！命名xxxxGatewayFiterFactory，xxxx为yml自定义的名称+GatewayFiterFactory；GatewayFiterFactory没有或者出错会出现以下错误

Failed to start bean 'eurekaAutoServiceRegistration';
 nested exception is reactor.core.Exceptions$ErrorCallbackNotImplemented: 
java.lang.IllegalArgumentException: Unable to find GatewayFilterFactory with name MyParam

在这里插入图片描述
将MyParamGatewayFiterFactory继承父类AbstractGatewayFilterFactory<MyParamGatewayFiterFactory.Config>并添加@Component注解
[外链图片转存失败,源站可能有防盗在这里插入!链机制,建描述]议将图片上https://传(imblog.csdng.ci/c2PPjdN85561ebe74deaa48738e00fcf.png3147)(https://img-.csdnimg.cn/c2d85561ebe74deaa4cf78738e300f11.png)]

创建一个Config类用来读取过滤器配置的参数，在类中创建一个String类型的参数对应配置在application.yml配置文件中的过滤器参数名，并生成get set方法

在这里插入图片描述
重写父类的方法：

重写父类GatewayFilter方法，由源码可看出要求返回类型为
ServerWebExchange exchange, GatewayFilterChain chain

完整代码段

package com.yh.gateway.filter;

import org.springframework.cloud.gateway.filter.GatewayFilter;
import org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.stereotype.Component;

import java.util.Arrays;
import java.util.List;

@Component
public class MyParamGatewayFilterFactory extends AbstractGatewayFilterFactory<MyParamGatewayFilterFactory.Config> {

    public MyParamGatewayFilterFactory() {
            super(Config.class);
        }


        @Override
        public List<String> shortcutFieldOrder() {
        return Arrays.asList("param");
        }

    @Override
    public GatewayFilter apply(Config config) {
        return (exchange, chain) -> {
            // http://localhost:10010/user/8?name=yh config.param ==> name
            //获取请求参数中param对应的参数名 的参数值
            ServerHttpRequest request = exchange.getRequest();
            if (request.getQueryParams().containsKey(config.param)){
                request.getQueryParams().get(config.param).forEach((v) -> {
                    System.out.print("--局部过滤器--获得参数 "+config.param+"="+ v);
                });
            }
          return chain.filter(exchange);//执行请求
        };
    }


    //读取过滤器配置的参数
    public static class Config{
        //对应配置在application.yml配置文件中的过滤器参数名
        private String param;

        public String getParam() {
            return param;
        }

        public void setParam(String param) {
            this.param = param;
        }
    }
}

输出结果：
在这里插入图片描述

自定义全局过滤器

要求：编写全局过滤器，在过滤器中检查请求中是否携带token请求头。如果token请求头存在则放行；如果token为空或者不存在则设置返回的状态码为：未授权也不再执行下去。

创建一个全局过滤器类实现GlobalFilter,；Ordered为过滤器执行顺序

@Component
public class MyGlobalFilter  implements GlobalFilter, Ordered {


    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        return null;
    }

    @Override
    public int getOrder() {
        return 0;
    }
}

@Component
public class MyGlobalFilter  implements GlobalFilter, Ordered {


    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        System.out.println("全局过滤器");
        String token = exchange.getResponse().getHeaders().getFirst("token");//获取第一个名为token的请求头
        //无权限
        if (StringUtils.isBlank(token)) {
            exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);//如果不是返回状态码401
            return exchange.getResponse().setComplete();
        }
        //有权限
        return chain.filter(exchange);
    }

    @Override
    public int getOrder() {
        //值越小，越优先执行
        return 1;
    }
}

打开postman 当没有请求头的时候显示结果为401
在这里插入图片描述

添加请求头token成功访问
请添加图片描述

幽游白酥

关注

5
点赞
踩
34

收藏

觉得还不错? 一键收藏
0
评论
Gateway自定义局部过滤器与自定义全局过滤器

什么是Gateway过滤器自定义局部过滤器需求：在过滤器（MyParamGatewayFilterFactory）中将http://localhost:10010/user/8?name=yh 中的参数name的值获取到并输出到控制台在application.yml文件中添加gateway过滤器：在这里插入图片描述](https://img-blog.csdnimg.cn/0bafd595c32841a9872c31236d4a442a.png?x-oss-process=image/waterm
复制链接

扫一扫