云计算、AI、云原生、大数据等一站式技术学习平台

网站首页 > 教程文章 正文

详细介绍一下Spring Cloud GateWay中Router的使用?

jxf315 2025-05-22 11:11:54 教程文章 15 ℃

在之前的分享中,我们介绍了Spring Cloud Gateway中的相关的概念,在其中提到了一个比较关键的概念就是Router路由,作为网关的核心功能模块Router如何使用就成了我们需要关心的问题了,下面我们就来介绍一下Router的基本使用方式。

Router(路由)作为Spring Cloud Gateway中的核心概念之一,主要的作用就是定义请求如何被分发到具体的服务或处理逻辑。而Gateway的主要功能就是基于这些路由来决定请求的转发目标。

Router的基本概念

在之前的分享中我们提到过,在Spring Cloud Gateway中,路由是指将客户端请求映射到后台服务或指定的处理器。一个路由包含两个主要部分,如下所示。

  • Predicate(断言):用于判断请求是否与路由匹配。如果断言返回true,则该路由会被选中。
  • Filter(过滤器):在请求转发之前或之后对请求进行处理。可以用于修改请求头、添加认证信息、限流等。

Router的配置方式

在Spring Boot中对于路由的配置提供了如下的几种配置方式。

Java 代码方式

我们可以在Spring Cloud Gateway中通过提供的RouteLocator接口来定义路由,如下所示,可以在@Bean方法中通过DSL的方式来配置路由。

import org.springframework.cloud.gateway.route.RouteLocator;
import org.springframework.cloud.gateway.route.builder.RouteLocatorBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class GatewayConfig {

    @Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder builder) {
        return builder.routes()
                .route("path_route", r -> r.path("/get")
                        .uri("http://httpbin.org"))
                .route("host_route", r -> r.host("*.myhost.org")
                        .uri("http://httpbin.org"))
                .route("rewrite_route", r -> r.host("*.rewrite.org")
                        .filters(f -> f.rewritePath("/foo/(?<segment>.*)", "/${segment}"))
                        .uri("http://httpbin.org"))
                .build();
    }
}

在上面这段代码中,第一个路由根据请求路径/get匹配,并将请求转发到http://httpbin.org;第二个路由根据请求的Host匹配,将*.myhost.org的请求转发到http://httpbin.org;第三个路由使用了一个过滤器,将请求路径进行重写,然后转发。

当然除了通过代码的方式来配置之外,我们还可以通过配置文件的方式来进行上面的操作的配置。

配置文件方式

可以在application.yml或application.properties配置文件中通过如下的配置方式来定义路由配置。

spring:
  cloud:
    gateway:
      routes:
        - id: path_route
          uri: http://httpbin.org
          predicates:
            - Path=/get
        - id: host_route
          uri: http://httpbin.org
          predicates:
            - Host=*.myhost.org
        - id: rewrite_route
          uri: http://httpbin.org
          predicates:
            - Host=*.rewrite.org
          filters:
            - RewritePath=/foo/(?<segment>.*), /${segment}

通过这个配置,在这个配置中,定义了相同的路由规则,但我们是通过配置文件来实现配置操作的。

Router的主要组件

根据我们之前的介绍,在Router中主要包括了两个组件一个是Predicates(断言)另一个是Filters(过滤器)。当然在Router中还包括了其他的组件信息,

Predicates(断言)

Predicates用于确定一个路由是否与当前请求匹配。常见的Predicate有

  • Path: 根据请求路径进行匹配。
  • Host: 根据请求的Host进行匹配。
  • Method: 根据HTTP方法匹配,如GET, POST等。
  • Header: 根据请求头匹配。

我们还可以组合多个Predicate来构建复杂的路由匹配条件。

.route("combined_route", r -> r.host("*.myhost.org")
        .and().path("/foo/**")
        .uri("http://httpbin.org"))

Filters(过滤器)

Filters用于在请求转发前或转发后进行额外处理。常见的过滤器有,如下一些

  • AddRequestHeader: 添加请求头。
  • AddRequestParameter: 添加请求参数。
  • RewritePath: 重写请求路径。
  • StripPrefix: 去除路径中的前缀。
  • Hystrix: 用于熔断处理。
.filters(f -> f.addRequestHeader("X-Request-Foo", "Bar"))

当然我们还可以通过自定义过滤器来实现复杂的处理逻辑。

URI

URI指定了匹配到路由后的请求应该被转发到哪里。可以是一个完整的URL,也可以是一个负载均衡的服务名。

.route("lb_route", r -> r.path("/service/**")
        .uri("lb://MY-SERVICE"))

在上面的例子中,lb://MY-SERVICE表示通过负载均衡将请求转发到MY-SERVICE服务。

Router的执行流程

  • 请求匹配: Gateway首先根据定义的Predicates判断请求是否与某个路由匹配。
  • 过滤器链执行: 如果请求匹配,则执行路由中的过滤器链。
  • 请求转发: 最终将请求转发到指定的目标URI。
  • 高级特性

    • 路由优先级: 如果多个路由都匹配同一个请求,Gateway会根据它们的定义顺序来决定使用哪个路由,通常后定义的路由优先级较高。
    • 动态路由: 通过Spring Cloud Config或其他动态配置机制,可以动态调整路由而无需重启服务。

    示例

    假设你有一个简单的微服务架构,其中有多个服务,如user-service和order-service。你可以通过Spring Cloud Gateway来定义路由,将不同路径的请求转发到相应的服务。

    spring:
      cloud:
        gateway:
          routes:
            - id: user_route
              uri: lb://user-service
              predicates:
                - Path=/user/**
            - id: order_route
              uri: lb://order-service
              predicates:
                - Path=/order/**
    

    在这个配置中:

    • /user/**路径的请求将被转发到user-service服务。
    • /order/**路径的请求将被转发到order-service服务。

    通过以上介绍,我们可以看到Spring Cloud Gateway的路由机制非常灵活且强大,能够满足各种微服务架构下的请求路由需求。

    Tags:

    最近发表
    标签列表