API网关Zuul配置详解(这一篇就够了)

素颜马尾好姑娘i 2022-09-10 08:13 107阅读 0赞

## zuul常用配置 ##

主机相关配置

<table> 
 <thead> 
  <tr> 
   <th>配置项</th> 
   <th>说明</th> 
   <th>默认值</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>zuul.host.connect-timeout-millis</td> 
   <td>连接主机的超时时间，默认单位ms</td> 
   <td>2000</td> 
  </tr> 
  <tr> 
   <td>zuul.host.max-per-route-connections</td> 
   <td>每个路由的连接数</td> 
   <td>20</td> 
  </tr> 
  <tr> 
   <td>zuul.host.max-total-connections</td> 
   <td>总连接数</td> 
   <td>200</td> 
  </tr> 
  <tr> 
   <td>zuul.host.connection-request-timeout-millis</td> 
   <td>连接请求的超时时间</td> 
   <td>-1</td> 
  </tr> 
  <tr> 
   <td>zuul.host.socket-timeout-millis</td> 
   <td>配置请求套接字的超时时间，默认单位ms</td> 
   <td>10000</td> 
  </tr> 
  <tr> 
   <td>zuul.host.time-to-live</td> 
   <td>生存时间</td> 
   <td>-1</td> 
  </tr> 
  <tr> 
   <td>zuul.host.time-unit</td> 
   <td>配置默认的时间单位，默认为ms</td> 
   <td>MILLISECONDS</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td></td> 
   <td></td> 
  </tr> 
 </tbody> 
</table>

Header相关配置

<table> 
 <thead> 
  <tr> 
   <th>配置项</th> 
   <th>说明</th> 
   <th>默认值</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>zuul.ignore-security-headers</td> 
   <td>是否丢弃安全的(敏感的)Header</td> 
   <td>true</td> 
  </tr> 
  <tr> 
   <td>zuul.ignored-headers</td> 
   <td>忽略的头部信息，忽略的header不会传播到下游的服务</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>zuul.add-host-header</td> 
   <td>API网关在进行请求路由转发之前为请求设置Host头信息</td> 
   <td>false</td> 
  </tr> 
  <tr> 
   <td>zuul.add-proxy-headers</td> 
   <td>是否将X-Forwarded-Host添加到请求转发的请求中</td> 
   <td>true</td> 
  </tr> 
  <tr> 
   <td>zuul.include-debug-header</td> 
   <td>是否包含调试相关的header</td> 
   <td>false</td> 
  </tr> 
  <tr> 
   <td>zuul.include-debug-header</td> 
   <td>是否包含调试相关的header</td> 
   <td>false</td> 
  </tr> 
  <tr> 
   <td>zuul.sensitive-headers</td> 
   <td>设置敏感的头部信息，默认情况下,敏感的头信息无法经过API网关进行传递</td> 
   <td>Cookie,Set-Cookie, Authorization</td> 
  </tr> 
  <tr> 
   <td>zuul.set-content-length</td> 
   <td>是否设置Content-length header，表示文本的字节长度</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td></td> 
   <td></td> 
  </tr> 
 </tbody> 
</table>

Ribbon相关配置

<table> 
 <thead> 
  <tr> 
   <th>配置项</th> 
   <th>说明</th> 
   <th>默认值</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>zuul.ribbon-isolation-strategy</td> 
   <td>ribbon的隔离策略，SEMAPHORE和THREAD</td> 
   <td>semaphore</td> 
  </tr> 
  <tr> 
   <td>zuul.semaphore.max-semaphores</td> 
   <td>配置最大信号量</td> 
   <td>100</td> 
  </tr> 
  <tr> 
   <td>zuul.thread-pool.thread-pool-key-prefix</td> 
   <td>设置线程池key的前缀</td> 
   <td>ff</td> 
  </tr> 
  <tr> 
   <td>zuul.thread-pool.use-separate-thread-pools</td> 
   <td>是否开启线程池隔离机制</td> 
   <td>false</td> 
  </tr> 
  <tr> 
   <td>zuul.trace-request-body</td> 
   <td>是否开启请求链路追踪</td> 
   <td>false</td> 
  </tr> 
  <tr> 
   <td>zuul.ribbon.eager-load.enabled</td> 
   <td>是否开启ribbon的eager-load(饿模式)</td> 
   <td>false</td> 
  </tr> 
  <tr> 
   <td>zuul.retryable</td> 
   <td>是否开启重试机制，重试机制由Hystrix提供</td> 
   <td>false</td> 
  </tr> 
  <tr> 
   <td>zuul.routes.feign-consumer.retryable</td> 
   <td>是否开启某一个服务的重试机制</td> 
   <td>false</td> 
  </tr> 
  <tr> 
   <td>zuul.initial-stream-buffer-size</td> 
   <td>设置初始缓冲值大小</td> 
   <td>8192</td> 
  </tr> 
 </tbody> 
</table>

路由规则

<table> 
 <thead> 
  <tr> 
   <th>配置项</th> 
   <th>说明</th> 
   <th>默认值</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>zuul.routes</td> 
   <td>路由配置规则，<strong><em>详见说明1</em></strong></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>zuul.ignore-local-service</td> 
   <td>是否忽略本地的服务</td> 
   <td>true</td> 
  </tr> 
  <tr> 
   <td>zuul.ignored-services</td> 
   <td>配置忽略的服务，指定的服务不创建路由规则</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>zuul.ignored-patterns</td> 
   <td>匹配该表达式的接口路径不创建路由规则</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>zuul.strip-prefix</td> 
   <td>是否将代理的前缀进行剥离，<strong><em>详见说明2</em></strong></td> 
   <td>true</td> 
  </tr> 
  <tr> 
   <td>zuul.prefix</td> 
   <td>为所有路由规则增加前缀</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>zuul.servlet-path</td> 
   <td>设置servlet路径，<strong><em>详见说明3</em></strong></td> 
   <td>/zuul</td> 
  </tr> 
  <tr> 
   <td>zuul.ssl-hostname-validation-enabled</td> 
   <td>是否开启ssl hostname校验</td> 
   <td>true</td> 
  </tr> 
  <tr> 
   <td>zuul.decode-url</td> 
   <td>在处理传入请求时，请求 URI 在将它们与路由匹配之前被解码</td> 
   <td>true</td> 
  </tr> 
  <tr> 
   <td>zuul.force-original-query-string-encoding</td> 
   <td>用于设置是否强制将查询字符串编码</td> 
   <td>false</td> 
  </tr> 
  <tr> 
   <td>zuul.remove-semicolon-content</td> 
   <td>表示是否可以删除第一个分号之后的路径元素的标志</td> 
   <td>true</td> 
  </tr> 
 </tbody> 
</table>

**说明1**：

zuul.routes

该配置是请求路由配置的核心参数

1.  传统路由方式：

传统的路由方式 zuul.routes.api-a.path: /api-a/\*\* zuul.routes.api-a.url: [http://localhost:8083/][http_localhost_8083]

假如：api网关对外提供的服务端口为8000 访问：[http://localhost:8000/api-a/test][http_localhost_8000_api-a_test] api网关自动路由到：[http://localhost:8083/test][http_localhost_8083_test]

1.  面向服务的路由方式
    
    前提需要引入注册中心
    
    zuul.routes.api-a.path: /api-a/\*\* zuul.routes.api-a.serviceId: serviceA
    
    假如：api网关对外提供的服务端口为8000 访问：[http://localhost:8000/api-a/test][http_localhost_8000_api-a_test] api网关自动路由到：eureka服务名称为serviceA服务的某一个实例的/test接口，如果该服务有多个实例，api网关会自动提供负载均衡

如果不提供以上配置，Zuul默认实现了服务实例的自动化维护 访问 [http://localhost:8000/serviceA/test][http_localhost_8000_serviceA_test] api网关自动路由到对应的服务名为serviceA的某个示例上的/test接口

Zuul中的路由匹配规则使用了Ant风格定义,一共有三种不同的通配符:

*  **?**: 可以匹配单个字符,比如路径是`/api/?`,就可以匹配到`/api/a`,`/api/b`等
 *  **\***: 匹配任意数量的字符,比如路径是`/api/*`,就能匹配到`/api/aa`,`/api/bb`等,但是只能匹配一级,像`/api/aa/bb`这样的路径就匹配不到了
 *  **\*\***: 匹配任意数量的字符,比如路径是`/api/**`,就能匹配到`/api/aa`,`/api/aa/b`等

**说明2**：

zuul.strip-prefix 配置是否将请求前缀进行剥离

zuul.strip-prefix为true，会请请求的前缀进行剥离，将请求前缀当成服务名称。

如：请求 /test/v1/hello，请求转发到test服务的/v1/hello接口

如果strip-prefix为false，则请求转发到配置的服务的/test/v1/hello接口

**说明3**：

zuul.servlet-path

Zuul 是作为一个 Servlet 实现的。对于一般情况，Zuul 被嵌入到 Spring Dispatch 机制中。这让 Spring MVC 可以控制路由。在这种情况下，Zuul 会缓冲请求。如果需要在不缓冲请求的情况下通过 Zuul（例如，对于大文件上传），则 Servlet 也安装在 Spring Dispatcher 之外。

zuul的隔离机制：

zuul有两种隔离机制 线程池隔离和信号量隔离

(1) 信号量隔离，默认值为100，也就是当请求大于100，就会返回500错误

(2) 使用线程池隔离

参考：[https://cloud.spring.io/spring-cloud-netflix/multi/multi\_\_router\_and\_filter\_zuul.html][https_cloud.spring.io_spring-cloud-netflix_multi_multi_router_and_filter_zuul.html]

[http_localhost_8083]: http://localhost:8083/
[http_localhost_8000_api-a_test]: http://localhost:8000/api-a/test
[http_localhost_8083_test]: http://localhost:8083/test
[http_localhost_8000_serviceA_test]: http://localhost:8000/serviceA/test
[https_cloud.spring.io_spring-cloud-netflix_multi_multi_router_and_filter_zuul.html]: https://cloud.spring.io/spring-cloud-netflix/multi/multi__router_and_filter_zuul.html