SpringCloudAlibaba - Gateway 自定义过滤器工厂

Maggieq8324

已于 2023-03-21 16:04:54 修改

阅读量544

点赞数 1

分类专栏： SpringCloud 文章标签： spring cloud alibaba gateway

于 2021-09-30 12:51:01 首次发布

以下为本篇文章的主要内容，希望大家多提意见，如果喜欢记得点个推荐哦作者：梦想是咸鱼本文版权归作者和优快云博客共有，欢迎转载，转载时保留原作者和文章地址即可。

本文链接：https://blog.youkuaiyun.com/weixin_41182727/article/details/120564252

版权

SpringCloud 专栏收录该内容

24 篇文章

订阅专栏

本文详细介绍了SpringCloud Gateway中过滤器工厂的使用，包括内置过滤器工厂如AddRequestHeaderGatewayFilterFactory的配置示例，以及如何实现自定义过滤器工厂，通过继承AbstractGatewayFilterFactory或AbstractNameValueGatewayFilterFactory来创建过滤器。文中还提供了一个自定义日志打印过滤器工厂的具体实例，并展示了如何修改请求和交换信息。核心API包括exchange.getRequest().mutate().build()用于修改请求，exchange.mutate().build()用于修改交换，以及chain.filter(exchange)用于传递给下一个过滤器处理。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

前言

Gateway中的过滤器可以为路由添加业务逻辑，修改请求以及响应

环境

Spring Cloud Hoxton.SR9 + Spring Cloud Alibaba 2.2.6.RELEASE

Gateway过滤器的生命周期

pre: Gateway转发请求之前
post: Gateway转发请求之后

过滤器工厂

内置过滤器工厂

AddRequestHeader GatewayFilter Factory示例，为原始请求添加请求参数foo=bar

gateway:
  discovery:
    locator:
      # 让gateway通过服务发现组件找到其他的微服务
      enabled: true
  routes:
    - id: user-center
      uri: lb://user-center
      predicates:
        - Path=/**
      filters:
        - AddRequestParameter=foo, bar

输入日志

在这里插入图片描述

详解博客：Spring Cloud Gateway-过滤器工厂详解（GatewayFilter Factories）

自定义过滤器工厂

自定义过滤器工厂 - 实现方式

实现自定义过滤器工厂有两种方式

继承 AbstractGatewayFilterFactory
继承 AbstractNameValueGatewayFilterFactory

自定义过滤器工厂 - 具体实例

实现自定义过滤器工厂 - 日志打印
application.yml

gateway:
  discovery:
    locator:
      # 让gateway通过服务发现组件找到其他的微服务
      enabled: true
  routes:
    - id: user-center
      uri: lb://user-center
      predicates:
        - Path=/**
      filters:
        - PreLog=参数1,参数2

PreLogGatewayFilterFactory.java

import lombok.extern.slf4j.Slf4j;
import org.springframework.cloud.gateway.filter.GatewayFilter;
import org.springframework.cloud.gateway.filter.factory.AbstractNameValueGatewayFilterFactory;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;

/**
 * 自定义过滤器工厂 - 日志打印
 * 必须以GatewayFilterFactory结尾
 */
@Slf4j
@Component
public class PreLogGatewayFilterFactory extends AbstractNameValueGatewayFilterFactory {
    @Override
    public GatewayFilter apply(NameValueConfig config) {
        return ((exchange, chain) -> {
            log.info("自定义过滤器工厂 - 日志打印参数：{},{}", config.getName(), config.getValue());

            // 修改请求
            ServerHttpRequest modifiedRequest = exchange.getRequest()
                    .mutate()
                    .build();

            // 修改exchange
            ServerWebExchange modifiedExchange = exchange.mutate()
                    .request(modifiedRequest)
                    .build();

            // 传递给下一个过滤器处理
            return chain.filter(modifiedExchange);
        });
    }
}

访问GATEWAY_URL/**

在这里插入图片描述

自定义过滤器工厂- 核心API

exchange.getRequest().mutate().xxx // 修改request
exchange.mutate().xxx // 修改exchange
chain.filter(exchange) // 传递给下一个过滤器处理
exchange.getResponse() // 拿到响应

- End - - 个人学习笔记 - - 仅供参考 -