Spring Cloud Gateway 配置大全

Spring Cloud Gateway 配置大全

了解Gateway的配置才可以理解使用Gateway可以做什么事情，才能更好地应用在产品开发中。

Predicates

Predicates主要起的作用是：配置路由匹配请求的规则

Http相关

Path

配置对于请求路径的匹配规则

1. yml配置，多个参数用逗号隔开

- Path = /aa/**,/bb/**

2. json配置

{"name":"Path","args":{"pattern":"/aa/**","pattern1":"/bb/**"}}

Cookie

配置对Cookie中值的匹配，第一个为key，第二个为value。下例匹配cookie设置chocolate:ch.p的请求

1. yml配置

- Cookie = chocolate,ch.p

2. json配置

{"name":"Cookie","args":{"_genkey_0":"chocolate","_genkey_1":"ch.p"}}

Header

匹配Http请求中设置的内容，http-header设置X-Request-Id:\d+可以匹配，第二个参数第二个参数是正则表达式

1. yml配置

- Header = X-Request-Id,\d+

2. json配置

{"name":"Header","args":{"_genkey_0":"X-Request-Id","_genkey_1":"\d+"}}

Host

匹配Http请求Host，匹配所有host为**.somehost.com的请求

1. yml配置

- Host = **.somehost.com

2. json配置

{"name":"Host","args":{"_genkey_0":"**.somehost.com"}}

Method

匹配Http请求头

1. yml配置

- Method = GET

2. json配置

{"name":"Method","args":{"_genkey_0":"GET"}}

Query

匹配Http请求中的查询参数，请求中携带param1=value的请求可以匹配

1. yml配置

- Query = param1,value

2. json配置

{"name":"Query","args":{"_genkey_0":"param1","_genkey_1":"value"}}

RemoteAddr

匹配请求中的RemoteAddr

1. yml配置

- RemoteAddr = 192.168.1.1/24

2. json配置

{"name":"RemoteAddr","args":{"_genkey_0":"192.168.1.1/24"}}

时间相关

After

设置时间之后可以访问

1. yml配置

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

2. json配置

{"name":"After","args":{"_genkey_0":"2017-01-20T17:42:47.789-07:00[America/Denver]"}}

Before

设置时间之前可以访问

1. yml配置

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

2. json配置

{"name":"Before","args":{"_genkey_0":"2017-01-20T17:42:47.789-07:00[America/Denver]"}}

Before

设置时间段内可以访问

1. yml配置

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

2. json配置

{"name":"Between","args":{"_genkey_0":"2017-01-20T17:42:47.789-07:00[America/Denver]"，"_genkey_1":"2017-01-21T17:42:47.789-07:00[America/Denver]"}}

权重路由

至少两组以上路由可以配置权重路由，配置后会根据权重随机访问几个路由

1. yml配置

- Weight = service1,80

2. json配置

{"name":"Weight","args":{"_genkey_0":"service1","_genkey_1":"80"}}

Filters

路径重写

1. yml配置

- RewritePath = /path/(?>.*), /$\{segment}

2. json配置

{"name":"RewritePath","args":{"_genkey_0":"/foo/(?.*)","_genkey_1":"/$\\{segment}"}}

修改请求头

1. yml配置

- AddRequestHeader = X-Request-Foo,Bar

2. json配置

{"name":"AddRequestHeader","args":{"_genkey_0":"X-Request-Foo","_genkey_1":"Bar"}}

修改请求参数

1. yml配置

- AddRequestParameter = foo,bar

2. json配置

{"name":"AddRequestParameter","args":{"_genkey_0":"foo","_genkey_1":"bar"}}

修改响应参数

1. yml配置

- AddResponseHeader = X-Request-Foo,Bar

2. json配置

{"name":"AddResponseHeader","args":{"_genkey_0":"X-Request-Foo","_genkey_1":"Bar"}}

路径前缀增强

请求路径/hello, 将会被替换为 /mypath/hello

1. yml配置

- PrefixPath = /mypath

2. json配置

{"name":"PrefixPath","args":{"_genkey_0":"/mypath"}}

路径前缀删除

请求/name/bar/foo，去除掉前面两个前缀之后，最后转发到目标服务的路径为/foo

1. yml配置

- StripPrefix = 2

2. json配置

{"name":"StripPrefix","args":{"_genkey_0":"2"}}

请求携带保留原始Host

1. yml配置

- PreserveHostHeader

2. json配置

{"name":"PreserveHostHeader","args":{}}

重定向

1. yml配置

- RedirectTo = 302,http://acme.org

2. json配置

{"name":"RedirectTo","args":{"_genkey_0":"302","_genkey_1":"http://acme.org"}}

断路器

1. yml配置

- name: Hystrix
  args:
	  # 断路后跳转地址
	  name: fallbackcmd
      fallbackUri: forward:/incaseoffailureusethis

2. json配置

{"name":"Hystrix","args":{"name":"fallbackcmd","fallbackUri":"forward:/incaseoffailureusethis"}}

集成Redis原生支持请求限流

1. yml配置

 - name: RequestRateLimiter
   args:
     redis-rate-limiter.replenishRate: 10  
     redis-rate-limiter.burstCapacity: 20

2. json配置

{"name":"RequestRateLimiter","args":{"redis-rate-limiter.replenishRate":"10","redis-rate-limiter.burstCapacity":"20"}}

删除请求头属性

1. yml配置

- RemoveRequestHeader = X-Request-Foo

2. json配置

{"name":"RemoveRequestHeader","args":{"_genkey_0":"X-Request-Foo"}}

删除响应头属性

1. yml配置

- RemoveResponseHeader = X-Request-Foo

2. json配置

{"name":"RemoveResponseHeader","args":{"_genkey_0":"X-Request-Foo"}}

重写响应头

将请求 /42?user=ford&password=omg!what&flag=true, 改为 /42?user=ford&password=***&flag=true

1. yml配置

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

2. json配置

{"name":"RewriteResponseHeader","args":{"_genkey_0":"X-Response-Foo","_genkey_1":"password=[^&]+","_genkey_2":"password=***"}}

重设请求路径

请求/foo/bar，在接下来的处理中被改为/bar

1. yml配置

- SetPath =/{segment}

2. json配置

{"name":"SetPath","args":{"_genkey_0":"/{segment}"}}

设置响应头

在接下来的处理中修改响应头X-Response-Foo为Bar

1. yml配置

- SetResponseHeader =X-Request-Foo,Bar

2. json配置

{"name":"SetResponseHeader","args":{"_genkey_0":"X-Response-Foo","_genkey_1":"Bar"}}

设置Http状态

1. yml配置

- name: SetStatus
  args:
	  status: 401

2. json配置

{"name":"SetStatus","args":{"_genkey_0":"302"}}

设置文件传输大小

1. yml配置

 - name: RequestSize
   args:
	   maxSize: 5000000

2. json配置

{"name":"RequestSize","args":{"_genkey_0":"5000000"}}

失败重试

1. yml配置

- name: Retry
  args:
	  retries: 3
      statuses: BAD_GATEWAY