Spring Cloud Gateway 概述与基本配置（下）

Wells974

已于 2024-06-18 23:03:18 修改

阅读量886

点赞数 5

分类专栏：爪哇文章标签： spring cloud spring 后端 gateway

于 2024-06-18 23:02:42 首次发布

本文链接：https://blog.csdn.net/YeJingLiangZuo/article/details/139785802

版权

爪哇专栏收录该内容

17 篇文章 1 订阅

订阅专栏

在上篇文章中，我们介绍了 Spring Cloud Gateway 的基本概念和配置方法。在这篇文章中，我们将进一步探讨 Spring Cloud Gateway 的进阶配置和高级功能，包括更多内置过滤器、自定义断言工厂、集成 Eureka 以及如何创建自定义过滤器，帮助你更好地利用 Spring Cloud Gateway 构建复杂的 API 网关。

一、更多内置过滤器

Spring Cloud Gateway 提供了丰富的内置过滤器，用于实现各种常见的网关功能。以下是几个常用的内置过滤器示例：

1. 重写路径

重写路径过滤器可以修改请求路径，通常用于路径映射。例如：

spring:
  cloud:
    gateway:
      routes:
        - id: rewrite_path_route
          uri: http://httpbin.org:80
          predicates:
            - Path=/foo/**
          filters:
            - RewritePath=/foo/(?<segment>.*), /$\{segment}

在这个例子中，请求路径 /foo/bar 将被重写为 /bar 并转发到目标 URI。

2. 重定向

重定向过滤器可以将请求重定向到另一个 URL。例如：

yaml复制代码spring:
  cloud:
    gateway:
      routes:
        - id: redirect_route
          uri: http://httpbin.org:80
          predicates:
            - Path=/redirect
          filters:
            - RedirectTo=302, http://example.com

在这个例子中，请求路径 /redirect 将被重定向到 http://example.com。

二、集成 Eureka

Spring Cloud Gateway 可以与 Eureka 集成，实现服务发现和动态路由。以下是在 application.yml 中的集成配置示例：

yaml复制代码spring:
  application:
    name: gateway-service

eureka:
  client:
    service-url:
      defaultZone: http://localhost:8761/eureka/

spring:
  cloud:
    gateway:
      discovery:
        locator:
          enabled: true

在上述配置中，启用了 Eureka 客户端，并配置了服务发现。Spring Cloud Gateway 将自动从 Eureka 获取注册的服务实例信息，并根据服务名称进行路由。

三、自定义断言工厂

除了内置的断言工厂外，Spring Cloud Gateway 还允许你定义自定义断言工厂，以满足特定的路由匹配需求。以下是一个自定义断言工厂的示例：

java复制代码import org.springframework.cloud.gateway.handler.predicate.RoutePredicateFactory;
import org.springframework.web.server.ServerWebExchange;

import java.util.function.Predicate;

public class CustomRoutePredicateFactory extends RoutePredicateFactory<CustomRoutePredicateFactory.Config> {

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

    @Override
    public Predicate<ServerWebExchange> apply(Config config) {
        return exchange -> {
            // 自定义断言逻辑
            return exchange.getRequest().getHeaders().containsKey(config.getHeaderName());
        };
    }

    public static class Config {
        private String headerName;

        public String getHeaderName() {
            return headerName;
        }

        public void setHeaderName(String headerName) {
            this.headerName = headerName;
        }
    }
}

在 application.yml 中使用自定义断言工厂：

yaml复制代码spring:
  cloud:
    gateway:
      routes:
        - id: custom_predicate_route
          uri: http://httpbin.org:80
          predicates:
            - CustomHeader=X-Custom-Header

四、自定义过滤器

类似于自定义断言工厂，Spring Cloud Gateway 也允许你定义自定义过滤器。以下是一个自定义过滤器的示例：

java复制代码import org.springframework.cloud.gateway.filter.GatewayFilter;
import org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

public class CustomGatewayFilterFactory extends AbstractGatewayFilterFactory<CustomGatewayFilterFactory.Config> {

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

    @Override
    public GatewayFilter apply(Config config) {
        return (exchange, chain) -> {
            // 自定义过滤器逻辑
            return chain.filter(exchange).then(Mono.fromRunnable(() -> {
                // 响应处理逻辑
                exchange.getResponse().getHeaders().add("X-Custom-Header", config.getHeaderValue());
            }));
        };
    }

    public static class Config {
        private String headerValue;

        public String getHeaderValue() {
            return headerValue;
        }

        public void setHeaderValue(String headerValue) {
            this.headerValue = headerValue;
        }
    }
}

在 application.yml 中使用自定义过滤器：

spring:
  cloud:
    gateway:
      routes:
        - id: custom_filter_route
          uri: http://httpbin.org:80
          predicates:
            - Path=/customfilter
          filters:
            - Custom=headerValue

五、全局过滤器

除了路由级过滤器外，Spring Cloud Gateway 还支持全局过滤器，它们适用于所有路由。以下是一个全局过滤器的示例：

import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

@Component
public class CustomGlobalFilter implements GlobalFilter, Ordered {

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        // 全局过滤器逻辑
        return chain.filter(exchange).then(Mono.fromRunnable(() -> {
            // 响应处理逻辑
            exchange.getResponse().getHeaders().add("X-Global-Header", "GlobalHeader");
        }));
    }

    @Override
    public int getOrder() {
        return -1;
    }
}

全局过滤器无需在 application.yml 中配置，会自动应用于所有请求。