一、引用Zuul
要将Zuul引用在项目中,请使用组ID为org.springframework.cloud和工件ID为的启动器spring-cloud-starter-netflix-zuul。
<dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-netflix-zuul</artifactId><version>2.1.3.RELEASE</version></dependency>
二、嵌入Zuul反向代理
Spring Cloud嵌入Zuul代理,以简化UI应用程序要对一个或多个后端服务进行代理调用的常见用例的开发。此功能对于用户界面代理所需的后端服务很有用,从而避免了为所有后端独立管理CORS和身份验证问题的需求。
要启用它,请使用注释Spring Boot主类@EnableZuulProxy。这样做会导致将本地请求转发到适当的服务。
按照惯例,ID为users的服务从位于的代理/users(去掉前缀)接收请求。代理使用功能区来定位要通过发现转发到的实例。所有请求均在hystrix命令中执行,因此失败会显示在Hystrix指标中。一旦电路断开,代理就不会尝试与服务联系。
注:
想要跳过自动配置服务路由的步骤,请设置zuul.ignored-services为服务ID模式的列表。如果服务与被忽略但仍包含在显式配置的路由映射中的模式匹配,则将其忽略,如以下示例所示:
zuul:ignoredServices: '*'routes:users: /myusers/** 在上面的例子中,所有的服务都将被忽略,除了为users。
要增加或更改代理路由,可以添加外部配置,如下所示:
zuul:routes:users: /myusers/** 前面的示例意味着HTTP调用要/myusers转发到users服务(例如/myusers/101转发到/101)。
要对路由进行更细粒度的控制,可以分别指定路径和serviceId,如下所示:
zuul:routes:users:path: /myusers/**serviceId: users_service 前面的示例意味着HTTP调用将/myusers转发到该users_service服务。路由必须具有path可以指定为ant风格模式的,因此/myusers/*只能匹配一个级别,但可以/myusers/**分层匹配。
后端的位置可以指定为serviceId(用于发现服务)或url(物理位置),如以下示例所示:
zuul:routes:users:path: /myusers/**url: https://example.com/users_service (2) hystrix.command和ribbon
这些简单的url-routes不会以的形式执行HystrixCommand,也不会使用Ribbon负载均衡多个URL。为了实现这些目标,您可以指定一个serviceId带有静态服务器列表的,如下所示:
zuul:routes:echo:path: /myusers/**serviceId: myusers-servicestripPrefix: truehystrix:command:myusers-service:execution:isolation:thread:timeoutInMilliseconds: ...myusers-service:ribbon:NIWSServerListClassName: com.netflix.loadbalancer.ConfigurationBasedServerListlistOfServers: https://example1.com,http://example2.comConnectTimeout: 1000ReadTimeout: 3000MaxTotalHttpConnections: 500MaxConnectionsPerHost: 100 另一种方法是指定服务路由并配置一个Ribbon客户端serviceId(这样做需要在Ribbon中禁用Eureka支持-有关更多信息,请参见上文),如以下示例所示:
zuul:routes:users:path: /myusers/**serviceId: usersribbon:eureka:enabled: falseusers:ribbon:listOfServers: example.com,google.com (3)PatternServiceRouteMapper
您可以使用来提供serviceId和之间的约定正则映射。它使用正则表达式命名组从中提取变量serviceId并将其注入路由模式,如以下示例所示:
@Bean
public PatternServiceRouteMapper serviceRouteMapper() {return new PatternServiceRouteMapper("(?<name>^.+)-(?<version>v.+$)","${version}/${name}");
} 上面的示例指的是serviceId的myusers-v1被映射到路线/v1/myusers/**。可以接受任何正则表达式,但所有命名组都必须同时存在于servicePattern和中routePattern。如果servicePattern与不匹配serviceId,则使用默认行为。在前面的示例中,serviceIdofmyusers映射到“ / myusers / **”路由(未检测到版本)。默认情况下,此功能是禁用的,仅适用于发现的服务。
(4)zuul.prefix
要为所有映射添加前缀,请设置zuul.prefix一个值,例如/api。默认情况下,代理前缀会从请求中剥离,然后再转发请求(您可以使用来关闭此行为zuul.stripPrefix=false)。您还可以关闭从单个路由中剥离特定于服务的前缀,如以下示例所示:
zuul:routes:users:path: /myusers/**stripPrefix: false 注:zuul.stripPrefix仅适用于中设置的前缀zuul.prefix。它对给定路由中定义的前缀没有任何影响path。/myusers/101转发到/myusers/101在users服务。这些zuul.routes条目实际上绑定到类型的对象ZuulProperties。如果查看该对象的属性,则可以看到它也有一个retryable标志。设置该标志以true使功能区客户端自动重试失败的请求。您还可以将该标志设置为何true时需要修改使用功能区客户端配置的重试操作的参数。
(6)zuul.addProxyHeaders
默认情况下,X-Forwarded-Host标头被添加到转发的请求中。要关闭它,请设置zuul.addProxyHeaders = false。默认情况下,前缀路径被剥离,并且后端的请求选择一个X-Forwarded-Prefix标头(/myusers在前面显示的示例中)。
(7)默认路由(/)
如果设置默认路由(/),则具有的应用程序@EnableZuulProxy可以充当独立服务器。例如,zuul.route.home: /将所有流量(“ / **”)路由到“ home”服务。
如果需要更细粒度的忽略,则可以指定要忽略的特定模式。这些模式在路线定位过程开始时进行评估,这意味着模式中应包含前缀以保证匹配。被忽略的模式跨越所有服务,并取代任何其他路由规范。以下示例显示了如何创建忽略的模式:
zuul:ignoredPatterns: /**/admin/**routes:users: /myusers/** 前面的示例意味着所有呼叫(例如/myusers/101)都被转发到/101该users服务上。但是,包括在内的呼叫/admin/无法解决。
注:如果需要保留路由的顺序,则需要使用YAML文件,因为使用properties文件时顺序会丢失。
以下示例显示了这样的YAML文件:
zuul:routes:users:path: /myusers/**legacy:path: /** 如果要使用properties 文件,则该legacy路径可能会终止于该users 路径的前面,从而导致该users路径不可访问。