Gateway基本配置的参数以及yml示例

不太厉害的程序员

于 2024-05-15 16:35:45 发布

阅读量633

点赞数 23

文章标签： gateway

本文链接：https://blog.csdn.net/m0_46401054/article/details/138913669

版权

Spring Cloud Gateway作为API网关，可以通过配置文件来定义路由规则、过滤器和相关参数。

参入如下：

routes: 定义了一组路由规则，每个路由规则包含了路由的ID、目标URI、断言集合和过滤器集合。
- id: 路由的唯一标识符，用于区分不同的路由规则。
- uri: 请求最终被转发到的目标地址，可以是具体的URL或者服务名称。
- predicates: 断言集合，用于定义路由匹配的条件，如路径、方法、头信息等。可以使用多种断言类型，如Path、Method、Header等。
- filters: 过滤器集合，用于在请求被路由前后对请求或响应进行修改。可以添加多个过滤器，按照顺序执行。
- order: 路由的优先级，数字越小，优先级越高。当有多个路由规则匹配时，将根据优先级选择最合适的路由。
- default-filters: 默认的过滤器配置，可以全局应用。这些过滤器将应用于所有的路由规则。
discovery.locator.enabled: 当设置为true时，Spring Cloud Gateway将从服务发现客户端获取服务实例信息，以实现负载均衡。这需要与服务注册中心（如Eureka）配合使用。
hystrix.command: 与Hystrix相关的配置，可以设置降级和熔断的相关参数。Hystrix是一个用于处理分布式系统中的容错和隔离的工具。
- fallbackUri: 指定降级时的备用URI，当请求失败时会转发到该URI进行处理。
- execution.isolation.thread.timeoutInMilliseconds: 设置Hystrix命令执行的超时时间，单位为毫秒。
requestratelimiter: 用于设置请求速率限制的参数，如replenishRate和burstCapacity。
- key-resolver: 用于解析请求的键值，用于确定是否超过速率限制。
- redis-rate-limiter.replenishRate: 每秒允许的请求数。
- redis-rate-limiter.burstCapacity: 令牌桶的最大容量。
stripPrefix: 用于配置是否移除请求路径的前缀。例如，如果设置为1，则请求路径中的前缀将被删除。
preserveHostHeader: 用于配置是否保留原始请求的Host头信息。如果设置为false，则在转发请求时将不包含原始的Host头信息。
retry: 用于配置请求重试的策略，如重试次数和状态码。
- retries: 重试次数。
- methods: 指定哪些HTTP方法需要进行重试，如GET、POST等。
- backoff: 退避策略，用于控制重试之间的等待时间。
  - firstBackoff: 第一次重试的等待时间。
  - maxBackoff: 最大等待时间。
  - factor: 退避因子，用于计算后续重试的等待时间。
  - jitter: 抖动因子，用于增加重试之间的随机性。
requestSize: 用于限制客户端请求体的最大大小。可以设置一个具体的大小，如10MB。
modifyRequestBody: 用于修改请求体内容的配置。
- replace: 替换请求体中的内容。
  - from: 要替换的原始内容。
  - to: 替换后的新内容。

yml配置示例

spring:
  cloud:
    gateway:
      # 定义路由规则
      routes:
        - id: route_id
          uri: http://example.com
          predicates:
            - Path=/api/**
          filters:
            - StripPrefix=1
            - name: RequestRateLimiter
              args:
                key-resolver: "#{@ipKeyResolver}"
                redis-rate-limiter.replenishRate: 10
                redis-rate-limiter.burstCapacity: 20
          order: 100
          default-filters:
            - name: Retry
              args:
                retries: 3
                methods: GET,POST
                backoff:
                  firstBackoff: 100ms
                  maxBackoff: 1000ms
                  factor: 2
                  jitter: 0.2
        # 其他路由规则...

      # 配置服务发现客户端
      discovery:
        locator:
          enabled: true

      # 配置 Hystrix
      hystrix:
        command:
          fallbackUri: forward:/fallback
          execution:
            isolation:
              thread:
                timeoutInMilliseconds: 2000

      # 配置请求体大小限制
      requestSize:
        maxSize: 10MB

      # 配置请求体修改
      modifyRequestBody:
        replace:
          from: "oldValue"
          to: "newValue"