SpringCloud 嵌入式Zuul反向代理

Spring Cloud已创建嵌入式Zuul代理，以简化UI应用程序要对一个或多个后端服务进行代理调用的常见用例的开发。此功能对于用户界面代理所需的后端服务很有用，从而避免了为所有后端独立管理CORS和身份验证问题的需求。

要启用它，请用@EnableZuulProxy注释Spring Boot主类。这样做会导致将本地呼叫转发到适当的服务。按照约定，ID为users的服务从位于/users的代理接收请求（前缀被去除）。代理使用Ribbon来定位要通过发现转发到的实例。所有请求均在hystrix命令中执行，因此失败以Hystrix指标显示。一旦电路断开，代理就不会尝试与服务联系。

Zuul入门程序不包含发现客户端，因此，对于基于服务ID的路由，您还需要在类路径上提供其中之一（Eureka是一种选择）。

要跳过自动添加服务的过程，请将zuul.ignored-services设置为服务ID模式的列表。如果服务与被忽略但已包含在显式配置的路由映射中的模式匹配，则将其忽略，如以下示例所示：

application.yml。 

 zuul:
  ignoredServices: '*'
  routes:
    users: /myusers/**

在前面的示例中，除 users 外，所有服务均被忽略。

要增加或更改代理路由，可以添加外部配置，如下所示：

application.yml。 

 zuul:
  routes:
    users: /myusers/**

前面的示例意味着对/myusers的HTTP调用被转发到users服务（例如，/myusers/101被转发到/101）。

要对路由进行更细粒度的控制，可以分别指定路径和serviceId，如下所示：

application.yml。 

 zuul:
  routes:
    users:
      path: /myusers/**
      serviceId: users_service

前面的示例意味着对/myusers的HTTP调用将转发到users_service服务。路由必须具有可以指定为蚂蚁样式模式的path，因此/myusers/*仅匹配一个级别，而/myusers/**则分层匹配。

后端的位置可以指定为serviceId（用于发现服务）或url（用于物理位置），如以下示例所示：

application.yml。 

 zuul:
  routes:
    users:
      path: /myusers/**
      url: https://example.com/users_service

这些简单的url路由不会作为HystrixCommand来执行，也不会使用Ribbon对多个URL进行负载均衡。为了实现这些目标，可以使用静态服务器列表指定一个serviceId，如下所示：

application.yml。 

zuul:
  routes:
    echo:
      path: /myusers/**
      serviceId: myusers-service
      stripPrefix: true

hystrix:
  command:
    myusers-service:
      execution:
        isolation:
          thread:
            timeoutInMilliseconds: ...

myusers-service:
  ribbon:
    NIWSServerListClassName: com.netflix.loadbalancer.ConfigurationBasedServerList
    listOfServers: https://example1.com,http://example2.com
    ConnectTimeout: 1000
    ReadTimeout: 3000
    MaxTotalHttpConnections: 500
    MaxConnectionsPerHost: 100

另一种方法是指定服务路由并为serviceId配置Ribbon客户端（这样做需要在Ribbon中禁用Eureka支持- 有关更多信息，请参见上文），如下所示例：

application.yml。 

zuul:
  routes:
    users:
      path: /myusers/**
      serviceId: users

ribbon:
  eureka:
    enabled: false

users:
  ribbon:
    listOfServers: example.com,google.com

您可以使用regexmapper在serviceId和路由之间提供约定。它使用正则表达式命名组从serviceId中提取变量，并将其注入到路由模式中，如以下示例所示：

ApplicationConfiguration.java。 

@Bean
public PatternServiceRouteMapper serviceRouteMapper() {
    return new PatternServiceRouteMapper(
        "(?<name>^.+)-(?<version>v.+$)",
        "${version}/${name}");
}

前面的示例意味着myusers-v1中的serviceId被映射到路由/v1/myusers/**。可以接受任何正则表达式，但是所有命名组必须同时存在于servicePattern和routePattern中。如果

servicePattern与serviceId不匹配，则使用默认行为。在前面的示例中，myusers中的serviceId被映射到/ myusers / **路由（未检测到版本）。默认情况下，此功能是禁用的，仅适用于发现的服务。

要为所有映射添加前缀，请将zuul.prefix设置为一个值，例如/api。默认情况下，在转发请求之前，将从请求中删除代理前缀（您可以使用zuul.stripPrefix=false将此行为关闭）。您还可以关闭从单个路由中剥离特定于服务的前缀，如以下示例所示：

application.yml。 

 zuul:
  routes:
    users:
      path: /myusers/**
      stripPrefix: false

zuul.stripPrefix仅适用于zuul.prefix中设置的前缀。它对给定路由的path中定义的前缀没有任何影响。

在前面的示例中，对/myusers/101的请求被转发到users服务上的/myusers/101。

zuul.routes条目实际上绑定到类型为ZuulProperties的对象。如果查看该对象的属性，则可以看到它也有一个retryable标志。将该标志设置为true，以使Ribbon客户端自动重试失败的请求。当您需要修改使用Ribbon客户端配置的重试操作的参数时，也可以将该标志设置为true。

默认情况下，X-Forwarded-Host标头被添加到转发的请求中。要关闭它，请设置zuul.addProxyHeaders = false。默认情况下，前缀路径被剥离，并且后端请求使用X-Forwarded-Prefix标头（在前面显示的示例中为/myusers）。

如果设置默认路由（/），则带有@EnableZuulProxy的应用程序可以充当独立服务器。例如，zuul.route.home: /会将所有流量（“ / **”）路由到“ home”服务。

如果需要更细粒度的忽略，则可以指定要忽略的特定模式。这些模式在路线定位过程开始时进行评估，这意味着模式中应包含前缀以保证匹配。被忽略的模式跨越所有服务，并取代任何其他路由规范。以下示例显示了如何创建忽略的模式：

application.yml。 

 zuul:
  ignoredPatterns: /**/admin/**
  routes:
    users: /myusers/**

前面的示例意味着所有呼叫（例如/myusers/101）都被转发到users服务上的/101。但是，包括/admin/在内的呼叫无法解决。

 如果您需要保留路由的顺序，则需要使用YAML文件，因为使用属性文件时顺序会丢失。以下示例显示了这样的YAML文件：

application.yml。 

 zuul:
  routes:
    users:
      path: /myusers/**
    legacy:
      path: /**

如果要使用属性文件，则legacy路径可能最终位于users路径的前面，从而导致users路径不可访问。