SpringCloud Gateway API网关概述

用心去追梦

于 2024-06-18 10:00:25 发布

阅读量455

点赞数 3

CC 4.0 BY-SA版权

本文链接：https://blog.csdn.net/qq_33240556/article/details/139765083

Spring Cloud Gateway 是 Spring Cloud 生态系统中用于构建 API 网关的项目。它提供了一系列功能，使得微服务架构中的请求路由、负载均衡、安全性、监控等变得更加简单和灵活。以下是 Spring Cloud Gateway 的一些关键概念和特性。

1. Spring Cloud Gateway 的核心概念

路由（Route）

路由是网关的基本构建块。每个路由包含一个 ID、一个目标 URI、一些谓词（predicates）和过滤器（filters）。谓词决定请求是否匹配路由，而过滤器则在请求和响应的生命周期中应用特定的逻辑。

谓词（Predicate）

谓词用于匹配传入的请求。Spring Cloud Gateway 提供了多种内置谓词，如 Path、Method、Header 等。例如，Path=/api/** 谓词可以匹配所有以 /api/ 开头的请求路径。

过滤器（Filter）

过滤器用于修改请求或响应。过滤器可以在请求进入路由之前（pre-filter）和响应返回客户端之前（post-filter）进行应用。常见的过滤器包括修改请求头、记录日志、鉴权等。

2. Spring Cloud Gateway 的主要特性

路由匹配

基于 URI、HTTP 方法、请求头、Cookie 等进行路由匹配。

负载均衡

通过集成 Spring Cloud LoadBalancer 或 Netflix Ribbon 实现负载均衡。

过滤器链

支持全局过滤器和特定路由的过滤器，能够在请求和响应生命周期中应用复杂的逻辑。

集成 Spring Security

通过与 Spring Security 集成，实现 API 网关的认证和授权功能。

动态路由

支持从配置中心动态刷新路由，适应微服务的动态变化。

3. Spring Cloud Gateway 的使用示例

添加依赖

在 pom.xml 中添加 Spring Cloud Gateway 的依赖：

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>

配置路由

在 application.yml 中配置路由示例：

spring:
  cloud:
    gateway:
      routes:
      - id: my_route
        uri: http://httpbin.org
        predicates:
        - Path=/get
        filters:
        - AddRequestHeader=X-Request-Foo, Bar

上述配置定义了一个简单的路由，将 /get 请求转发到 http://httpbin.org，并在请求头中添加 X-Request-Foo: Bar。

自定义过滤器

创建自定义过滤器：

import org.springframework.cloud.gateway.filter.GatewayFilter;
import org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory;
import org.springframework.stereotype.Component;
import reactor.core.publisher.Mono;

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

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

    @Override
    public GatewayFilter apply(Config config) {
        return (exchange, chain) -> {
            System.out.println("Pre Filter logic");
            return chain.filter(exchange).then(Mono.fromRunnable(() -> {
                System.out.println("Post Filter logic");
            }));
        };
    }

    public static class Config {
        // Put the configuration properties here
    }
}

在 application.yml 中添加自定义过滤器：

spring:
  cloud:
    gateway:
      routes:
      - id: my_route
        uri: http://httpbin.org
        predicates:
        - Path=/get
        filters:
        - name: CustomFilter