网关 - Spring Cloud GateWay

本文转载自：https://www.datawisher.cn/

项目实战

explore-spring-cloud-gateway

1. 项目配置

server:
  port: 18080

spring:
  application:
    name: spring-cloud-gateway
  cloud:
    nacos:
      discovery:
        enabled: true
        server-addr: 127.0.0.1:8848
    gateway:
      enabled: true
      routes:
        - id: host_route
          uri: http://localhost:18081
          predicates:
            - Path=/say/hi
      discovery:
        locator:
          enabled: true

management:
  endpoints:
    web:
      exposure:
        include: "*"

configServer:
  addr: 127.0.0.1:8848
  dataId: spring-cloud-gateway-refresh-dev.json
  group: DEFAULT_GROUP

2. 动态路由

路由配置在nacos配置中心，spring-cloud-gateway-refresh-dev.json

网关读取路径的几种方式：

  • application配置文件或配置中心可以直接指定routes


    image

  • 代码里直接获取RouteLocator对象, route_id是自动生成的


    image

3. 查看网关所有配置的路径

http://localhost:18080/actuator/gateway/routes

GateWay 参数说明

Route

路由：由ID，目标URI，断言组，过滤器组。匹配则为True。

Predicate

断言：

ServerWebExchange

1. After、Before、Between

日期后，前，之间
- After=2017-01-20T17:42:47.789-07:00[America/Denver]

- Before=2017-01-20T17:42:47.789-07:00[America/Denver]

- Between=2017-01-20T17:42:47.789-07:00[America/Denver], 2017-01-21T17:42:47.789-07:00[America/Denver]

2. Cookie

cookie的名称和值（正则表达式）
- Cookie=chocolate, ch.p

3. Header

header的名称和值（正则表达式）
- Header=X-Request-Id, \d+

4. Host

主机列表
- Host=**.somehost.org,**.anotherhost.org

同时也支持URI模板变量，例如 {sub}.myhost.org

5. Method

HTTP方法
- Method=GET

6. Path

PathMatcher

- Path=/foo/{segment},/bar/{segment}

Map<String, String> uriVariables = ServerWebExchangeUtils.getPathPredicateVariables(exchange);

String segment = uriVariables.get("segment");

7. Query

查询参数包含baz
- Query=baz

查询参数名为foo，值以ba开头，例如baz，bar
- Query=foo, ba.

8. RemoteAddr

远程IP地址，例如192.168.1.10可访问
- RemoteAddr=192.168.1.1/24

9. Weight

权重
80%走weight_high, 20%走weight_low

spring:
  cloud:
    gateway:
      routes:
      - id: weight_high
        uri: https://weighthigh.org
        predicates:
        - Weight=group1, 8
      - id: weight_low
        uri: https://weightlow.org
        predicates:
        - Weight=group1, 2

如果网关位于代理层之后，比如nginx，需要自定义解析器RemoteAddressResolver，
XForwardedRemoteAddressResolver::trustAll 基于X-Forwarded-For header, 总可以拿到第一个ip地址，这种方法容易受到欺骗干扰，因为客户端可以假造X-Forwarded-For header的值。
XForwardedRemoteAddressResolver::maxTrustedIndex 如果只有一个HAProxy，把值设为1，认为它是可信的。

$remote_addr
是nginx与客户端进行TCP连接过程中，获得的客户端真实地址. Remote Address 无法伪造，因为建立 TCP 连接需要三次握手，如果伪造了源 IP，无法建立 TCP 连接，更不会有后面的 HTTP 请求

X-Real-IP
是一个自定义头。X-Real-Ip 通常被 HTTP 代理用来表示与它产生 TCP 连接的设备 IP，这个设备可能是其他代理，也可能是真正的请求端。需要注意的是，X-Real-Ip 目前并不属于任何标准，代理和 Web 应用之间可以约定用任何自定义头来传递这个信息

X-Forwarded-For
X-Forwarded-For 是一个扩展头。HTTP/1.1（RFC 2616）协议并没有对它的定义，它最开始是由 Squid 这个缓存代理软件引入，用来表示 HTTP 请求端真实 IP，现在已经成为事实上的标准，被各大 HTTP 代理、负载均衡等转发服务广泛使用，并被写入 RFC 7239（Forwarded HTTP Extension）标准之中.

Filter

过滤器

GatewayFilter

1. AddRequestHeader

增加请求头的参数
- AddRequestHeader=X-Request-Foo, Bar

2. AddRequestParameter

增加请求参数
- AddRequestParameter=foo, bar

3. AddResponseHeader

增加响应头的参数
- AddResponseHeader=X-Response-Foo, Bar

4. DedupeResponseHeader

- DedupeResponseHeader=Access-Control-Allow-Credentials Access-Control-Allow-Origin # name用空格隔开

5. Hystrix

Hystrix已经进入维护模式，spring cloud未来版本会将之移除，替代方式是使用Resilience4J的Spring Cloud CircuitBreaker Gateway Filter

需要加入Netflix组件spring-cloud-starter-netflix-hystrix
- Hystrix=myCommandName

6. Spring Cloud CircuitBreaker

可加入spring-cloud-starter-netflix-hystrix 或 spring-cloud-starter-circuitbreaker-reactor-resilience4j, 建议使用后者。

7. FallbackHeaders

fallback头加入自定义的异常名称和信息

8. MapRequestHeader

X-Request-Foo头中的值会被Bar中的值替换掉
- MapRequestHeader=Bar, X-Request-Foo

9. PrefixPath

/mypath会影响到所有请求，比如/hello会转换成/mypath/hello
- PrefixPath=/mypath

10. PreserveHostHeader

这个过滤器无参数。确定是否发送主机头，而非由http客户端来决定。
- PreserveHostHeader

11. RequestRateLimiter

使用RateLimiter实现。调用频次过多，默认返回HTTP 429 - Too Many Requests。
KeyResolver接口。之后版本会有多个实现。PrincipalNameKeyResolver是它的默认实现。从ServerWebExchange中检索Principal,名称是Principal.getName().

Redis实现RateLimiter。基于stripe工作。需要依赖spring-boot-starter-data-redis-reactiv。
它使用到令牌桶的算法。注意两个参数redis-rate-limiter.replenishRate 和 redis-rate-limiter.burstCapacity

12. RedirectTo

status和url两个参数, 状态码一定是300系列的。
- RedirectTo=302, https://acme.org

13. RemoveHopByHopHeadersFilter

从转发的请求里删除头信息
设置spring.cloud.gateway.filter.remove-non-proxy-headers.headers属性

14. RemoveRequestHeader

删除请求头
- RemoveRequestHeader=X-Request-Foo

15. RemoveResponseHeader

删除响应头
- RemoveResponseHeader=X-Response-Foo
可使用spring.cloud.gateway.default-filters属性配置

16. RemoveRequestParameter

删除请求参数
- RemoveRequestParameter=foo

17. RewritePath

重写请求路径，通过正则参数或替换参数
- RewritePath=/foo(?<segment>/?.*), $\{segment}

18. RewriteLocationResponseHeader

- RewriteLocationResponseHeader=AS_IN_REQUEST, Location, ,

19. RewriteResponseHeader

- RewriteResponseHeader=X-Response-Foo, , password=[^&]+, password=***

20. SaveSession

- SaveSession

21. SecureHeaders

22. SetPath

定义路径模板， 例如foo/bar，会被设置为/bar
`- SetPath=/{segment}

23. SetRequestHeader

- SetRequestHeader=X-Request-Foo, Bar

24. SetResponseHeader

- SetResponseHeader=X-Response-Foo, Bar

25. SetStatus

- SetStatus=BAD_REQUEST 或 - SetStatus=401

26. StripPrefix

27. Retry

当前不支持带有body的POST和PUT操作

28. RequestSize

31. Default

spring.cloud.gateway.default-filters参数设置默认过滤器

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成，浏览时请结合常识与多方信息审慎甄别。
平台声明：文章内容（如有图片或视频亦包括在内）由作者上传并发布，文章内容仅代表作者本人观点，简书系信息发布平台，仅提供信息存储服务。

友情链接更多精彩内容