Zuul开发人员指南

有关Zuul如何工作的一般概述，请参阅 Zuul维基 。

Zuul Servlet

Zuul被实现为Servlet。对于一般情况，Zuul嵌入到Spring调度机制中。这允许Spring MVC控制路由。在这种情况下，Zuul被配置为缓冲请求。如果需要通过Zuul不缓冲请求（例如大文件上传），Servlet也将安装在Spring调度程序之外。默认情况下，它位于/zuul。可以使用zuul.servlet-path属性更改此路径。

Zuul RequestContext

要在过滤器之间传递信息，Zuul使用a RequestContext 。其数据按照每个请求的ThreadLocal进行。关于路由请求，错误以及实际HttpServletRequest和HttpServletResponse的路由信息​​。RequestContext扩展ConcurrentHashMap，所以任何东西都可以存储在上下文中。 FilterConstants 包含由Spring Cloud Netflix安装的过滤器使用的密钥（稍后再安装）。

@EnableZuulProxy与@EnableZuulServer

Spring Cloud Netflix根据使用何种注释来启用Zuul安装多个过滤器。@EnableZuulProxy是@EnableZuulServer的超集。换句话说，@EnableZuulProxy包含@EnableZuulServer安装的所有过滤器。“代理”中的其他过滤器启用路由功能。如果你想要一个“空白”Zuul，你应该使用@EnableZuulServer。

@EnableZuulServer过滤器

创建从Spring Boot配置文件加载路由定义的SimpleRouteLocator。

安装了以下过滤器（正常Spring豆类）：

前置过滤器

ServletDetectionFilter：检测请求是否通过Spring调度程序。使用键FilterConstants.IS_DISPATCHER_SERVLET_REQUEST_KEY设置布尔值。

FormBodyWrapperFilter：解析表单数据，并对下游请求进行重新编码。

DebugFilter：如果设置debug请求参数，则此过滤器将RequestContext.setDebugRouting()和RequestContext.setDebugRequest()设置为true。

路由过滤器

SendForwardFilter：此过滤器使用ServletRequestDispatcher转发请求。转发位置存储在RequestContext属性FilterConstants.FORWARD_TO_KEY中。这对于转发到当前应用程序中的端点很有用。

过滤器：

SendResponseFilter：将代理请求的响应写入当前响应。

错误过滤器：

SendErrorFilter：如果RequestContext.getThrowable()不为null，则转发到/错误（默认情况下）。可以通过设置error.path属性来更改默认转发路径（/error）。

@EnableZuulProxy过滤器

创建从DiscoveryClient（如Eureka）以及属性加载路由定义的DiscoveryClientRouteLocator。每个serviceId从DiscoveryClient创建路由。随着新服务的添加，路由将被刷新。

除了上述过滤器之外，还安装了以下过滤器（正常Spring豆类）：

前置过滤器

PreDecorationFilter：此过滤器根据提供的RouteLocator确定在哪里和如何路由。它还为下游请求设置各种与代理相关的头。

路由过滤器

RibbonRoutingFilter：此过滤器使用Ribbon，Hystrix和可插拔HTTP客户端发送请求。服务ID位于RequestContext属性FilterConstants.SERVICE_ID_KEY中。此过滤器可以使用不同的HTTP客户端。他们是：

ApacheHttpClient。这是默认的客户端。

SquareupOkHttpClientv3。通过在类路径上设置com.squareup.okhttp3:okhttp库并设置ribbon.okhttp.enabled=true来启用此功能。

Netflix Ribbon HTTP客户端。这可以通过设置ribbon.restclient.enabled=true来启用。这个客户端有限制，比如它不支持PATCH方法，还有内置的重试。

SimpleHostRoutingFilter：此过滤器通过Apache HttpClient发送请求到预定的URL。URL位于RequestContext.getRouteHost()。

自定义Zuul过滤示例

以下大部分以下“如何撰写”示例都包含 示例Zuul过滤器 项目。还有一些 *** 作该存储库中的请求或响应正文的例子。

如何编写预过滤器

前置过滤器用于设置RequestContext中的数据，用于下游的过滤器。主要用例是设置路由过滤器所需的信息。

public class QueryParamPreFilter extends ZuulFilter {

@Override

public int filterOrder() {

return PRE_DECORATION_FILTER_ORDER - 1// run before PreDecoration

}

@Override

public String filterType() {

return PRE_TYPE

}

@Override

public boolean shouldFilter() {

RequestContext ctx = RequestContext.getCurrentContext()

return !ctx.containsKey(FORWARD_TO_KEY) // a filter has already forwarded

&&!ctx.containsKey(SERVICE_ID_KEY)// a filter has already determined serviceId

}

    @Override

    public Object run() {

        RequestContext ctx = RequestContext.getCurrentContext()

HttpServletRequest request = ctx.getRequest()

if (request.getParameter("foo") != null) {

    // put the serviceId in `RequestContext`

    ctx.put(SERVICE_ID_KEY, request.getParameter("foo"))

    }

        return null

    }

}

上面的过滤器从foo请求参数填充SERVICE_ID_KEY。实际上，做这种直接映射并不是一个好主意，而是从foo的值来查看服务ID。

现在填写SERVICE_ID_KEY，PreDecorationFilter将不会运行，RibbonRoutingFilter将会。如果您想要路由到完整的网址，请改用ctx.setRouteHost(url)。

要修改路由过滤器将转发的路径，请设置REQUEST_URI_KEY。

如何编写路由过滤器

路由过滤器在预过滤器之后运行，并用于向其他服务发出请求。这里的大部分工作是将请求和响应数据转换到客户端所需的模型。

public class OkHttpRoutingFilter extends ZuulFilter {

@Autowired

private ProxyRequestHelper helper

@Override

public String filterType() {

return ROUTE_TYPE

}

@Override

public int filterOrder() {

return SIMPLE_HOST_ROUTING_FILTER_ORDER - 1

}

@Override

public boolean shouldFilter() {

return RequestContext.getCurrentContext().getRouteHost() != null

&&RequestContext.getCurrentContext().sendZuulResponse()

}

    @Override

    public Object run() {

OkHttpClient httpClient = new OkHttpClient.Builder()

// customize

.build()

RequestContext context = RequestContext.getCurrentContext()

HttpServletRequest request = context.getRequest()

String method = request.getMethod()

String uri = this.helper.buildZuulRequestURI(request)

Headers.Builder headers = new Headers.Builder()

Enumeration<String>headerNames = request.getHeaderNames()

while (headerNames.hasMoreElements()) {

String name = headerNames.nextElement()

Enumeration<String>values = request.getHeaders(name)

while (values.hasMoreElements()) {

String value = values.nextElement()

headers.add(name, value)

}

}

InputStream inputStream = request.getInputStream()

RequestBody requestBody = null

if (inputStream != null &&HttpMethod.permitsRequestBody(method)) {

MediaType mediaType = null

if (headers.get("Content-Type") != null) {

mediaType = MediaType.parse(headers.get("Content-Type"))

}

requestBody = RequestBody.create(mediaType, StreamUtils.copyToByteArray(inputStream))

}

Request.Builder builder = new Request.Builder()

.headers(headers.build())

.url(uri)

.method(method, requestBody)

Response response = httpClient.newCall(builder.build()).execute()

LinkedMultiValueMap<String, String>responseHeaders = new LinkedMultiValueMap<>()

for (Map.Entry<String, List<String>>entry : response.headers().toMultimap().entrySet()) {

responseHeaders.put(entry.getKey(), entry.getValue())

}

this.helper.setResponse(response.code(), response.body().byteStream(),

responseHeaders)

context.setRouteHost(null)// prevent SimpleHostRoutingFilter from running

return null

    }

}

上述过滤器将Servlet请求信息转换为OkHttp3请求信息，执行HTTP请求，然后将OkHttp3响应信息转换为Servlet响应。警告：此过滤器可能有错误，但功能不正确。

如何编写过滤器

后置过滤器通常 *** 纵响应。在下面的过滤器中，我们添加一个随机UUID作为X-Foo头。其他 *** 作，如转换响应体，要复杂得多，计算密集。

public class AddResponseHeaderFilter extends ZuulFilter {

@Override

public String filterType() {

return POST_TYPE

}

@Override

public int filterOrder() {

return SEND_RESPONSE_FILTER_ORDER - 1

}

@Override

public boolean shouldFilter() {

return true

}

@Override

public Object run() {

RequestContext context = RequestContext.getCurrentContext()

    HttpServletResponse servletResponse = context.getResponse()

servletResponse.addHeader("X-Foo", UUID.randomUUID().toString())

return null

}

}

Zuul错误如何工作

如果在Zuul过滤器生命周期的任何部分抛出异常，则会执行错误过滤器。SendErrorFilter只有RequestContext.getThrowable()不是null才会运行。然后在请求中设置特定的javax.servlet.error.*属性，并将请求转发到Spring Boot错误页面。

Zuul渴望应用程序上下文加载

Zuul内部使用Ribbon调用远程URL，并且Ribbon客户端默认在第一次调用时由Spring Cloud加载。可以使用以下配置更改Zuul的此行为，并将导致在应用程序启动时，子Ribbon相关的应用程序上下文正在加载。

application.yml

zuul:

  ribbon:

    eager-load:

      enabled: true

        server.port=8081

        spring.application.name=first-service

        eureka.instance.instance-id=${spring.application.name}:${random.int}

        eureka.client.serviceUrl.defaultZone=http://localhost:1111/eureka/

如图：

        server.port=5555

        spring.application.name=api-gateway

        eureka.instance.instance-id=${spring.application.name}:${random.int}

        eureka.client.serviceUrl.defaultZone=http://localhost:1111/eureka/

        # 表示eureka client发送心跳给server端的频率。如果在leaseExpirationDurationInSeconds后，server端没有收到client的心跳，则将摘除该instance。缺省=30

        eureka.instance.lease-renewal-interval-in-seconds=30

        # 表示eureka server至上一次收到client的心跳之后，等待下一次心跳的超时时间，在这个leaseExpirationDurationInSeconds时间内若没收到下一次心跳，则将移除该instance，缺省=90

        eureka.instance.lease-expiration-duration-in-seconds=90

        zuul.routes.api-a-url.path=/api-a/**

        zuul.routes.api-a-url.service-id=first-service

        zuul.routes.api-b-url.path=/api-b/**

        zuul.routes.api-b-url.service-id=feign-consumer

如图：

        @SpringBootApplication

        @EnableZuulProxy    // 启用Zuul代理

    如图：

    加载zuul routes配置：

    加载后属性为LinkedHashMap结构，处理缺省属性，ZuulRoute为ZuulProperties内部类

    Zuul代理类加载：

    初始化路由转发过滤器RibbonRoutingFilter：

      构造RibbonRoutingFilter：

    显示配置已加载：

        访问地址：localhost:5555/api-a/index

        进入过滤顺序为10的RibbonRoutingFilter：

        判断是否执行过滤器（依赖com.netflix.zuul.context.RequestContext）：

        执行过滤器，先构造RibbonCommandContext上下文：

        构造请求头，请求参数，负载等：

        RibbonCommand执行转发：

        吧啦吧啦到达服务返回结果，catch异常。。。先到这

---