Zuul 代理文件上传、为路由提供 hystrix 回退、过滤器、超时时间

男娘i 2023-07-11 12:40 14阅读 0赞

**目录**

通过 Zuul 上传文件

Zuul Servlet

Zuul 为路由提供 hystrix 回退

Zuul 过滤器概述与使用

Zuul RequestContext

禁用 Zull 过滤器

Zuul 超时时间

--------------------

# 通过 Zuul 上传文件 #

> 本文环境 java jdk 1.8 + Spring Boot 2.1.3 + Spring Cloud Greenwich.SR1 版本。

**文件上传微服务**

1、文件上传微服务（端口 9394） ec-zebra 后台提供上传接口：

/**
     * 单文件上传。其中不做文件大小、类型等的判断，IO异常的处理，只做简单的上传演示.
     * @param uploadFile：上传的文件封装好的对象
     */
    @RequestMapping(value = "zebra/resource/upload", method = RequestMethod.POST)
    public String singleFileUpload(@RequestParam MultipartFile uploadFile) {
        File file = new File(fileSaveDir);
        try {
            if (uploadFile != null && uploadFile.getSize() > 0) {
                file = new File(file, uploadFile.getOriginalFilename());
                uploadFile.transferTo(file);
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
        return "上传文件保存路径为：" + file.getAbsolutePath();
    }

2、文件上传微服务（端口 9394）提供上传页面，浏览器访问上传页面，用户点击"上传"按钮上传文件：

<form action="" method="post" enctype="multipart/form-data" target="_blank">
        <input type="file" name="uploadFile"/><br>
        <input type="submit" value="上传">
    </form>

> 文件上传不用 zuul 代理时，直接访问文件微服务上传，form 表单的 action 属性值：http://192.168.2.77:9394/zebra/resource/upload

3、文件上传微服务(ec-zebra) 配置文件上传大小限制（否则超过限制上传时会报错。更多配置参考官网：[X. Appendices][]）：

spring:
      servlet:
        multipart: #配置文件上传
          max-file-size: 2048MB #单文件上传时，文件大小的最大值，单位可以是 MB、KB，默认为 1MB
          max-request-size: 2048MB #多文件上传时，文件总大小的最大值，单位可以是 MB、KB，默认为 10 M

![20200305173744357.gif][]

> 源码：[https://github.com/wangmaoxiong/Hystrix-hello-world/tree/master/eureka\_client2020/src/main][https_github.com_wangmaoxiong_Hystrix-hello-world_tree_master_eureka_client2020_src_main]

**zuul 代理文件上传**

1、网关微服务 gateway-server(端口7790) 与文件上传微服务 ec-zebra 注册到同一个注册中心，如下为 zuul 中配置的路由信息：

zuul:
      #routes 配置路由规则，值是一个 Map，key 是代理的微服务名称，如 snow-leopard，值仍然还可以使用 map
      routes:
        ec-zebra:
          path: /zebra/**         #映射路径
          serviceId: ec-zebra     #代理的微服务名称
          strip-prefix: false     # false 表示不剥离 path 中的前缀 zebra,此时前缀会被当作真实的请求路径

> 文件上传使用 zuul 代理时，通过 zuul 代理路径上传：http://192.168.2.77:7790/zebra/resource/upload

2、官网：[Uploading Files through Zuul][] 介绍：如果 zuul 使用 @EnableZuulProxy 注解，则可以使用代理路径上传文件，只要文件很小，它就可以正常工作。对于大文件会存在两个问题：

> 1）如果上传文件大小超过默认配置（max-file-size=1M、max-request-size=10M），则还是会报超过大小限制异常。
> 
> 2）如果文件上传耗时较长，则会报连接超时异常。

3、解决 zuul 代理文件上传大小超过限制异常有两个方法：

> 3.1、直接在 zuul 中也配置文件上传大小，这样只要上传文件大小在此范围内，就不再文件大小报错：

> 3.2、官网推荐方式是在文件上传代理路径加上前缀 "/zuul"，这样"/zuul/\*" 的路径绕过自动 Spring DispatcherServlet，也不会再报大小错误. 如：http://192.168.2.77:7790/zuul/zebra/resource/upload

4、因为 zuul 的 http 请求会使用 hystrix 断路器包裹，以及会使用 ribbon 进行负载均衡，所以解决文件上传超时异常需要配置超时时间，只要在此时间内，则不会再报超时异常：

hystrix.command.default.execution.isolation.thread.timeoutInMilliseconds: 180000
    ribbon:
      ConnectTimeout: 3000
      ReadTimeout: 60000

![20200305173810540.gif][]

> 源码：[https://github.com/wangmaoxiong/Hystrix-hello-world/tree/master/gateway-zuul/src/main][https_github.com_wangmaoxiong_Hystrix-hello-world_tree_master_gateway-zuul_src_main]

# Zuul Servlet #

1、官网 [The Zuul Servlet。][The Zuul Servlet] Zuul 被实现为 Servle，而默认情况下，Zuul 已嵌入到 Spring Dispatch 机制中，这使 Spring MVC 可以控制路由，这种情况下，Zuul 会缓冲请求。

2、如果需要不缓存请求就通过 Zuul（例如对于大文件上传），则 Servlet 也可以安装在 Spring Dispatcher 的外部，默认情况下，该 servlet 的地址为 "/zuul"，可以使用 zuul.servlet-path 属性更改此路径。

3、这就是上面 zuul 代理文件上传时，代理路径需要加上前缀 "/zuul"的原因：http://192.168.2.77:7790/zuul/zebra/resource/upload，因为这样的请求会绕过 Spring Dispatcher 而作为 servlet 请求。

# Zuul 为路由提供 hystrix 回退 #

1、spring-cloud-starter-netflix-zuul 内部依赖了 spring-boot-starter-web,actuator,netflix-hystrix,netflix-ribbon,netflix-archaius 等组件，默认会对 Http 请求进行 hystrix 包裹，以及使用 ribbon 负载均衡。

2、官网[ Providing Hystrix Fallbacks For Routes][Providing Hystrix Fallbacks For Routes] ：当 Zuul 中给定路由的断路器开启时，您可以通过创建 FallbackProvider 类型的 bean 提供回退响应，在此 bean 中需要指定回退的路由 serviceId，并提供一个 ClientHttpResponse 作为回退返回。

import com.netflix.hystrix.exception.HystrixTimeoutException;
    import org.springframework.cloud.netflix.zuul.filters.route.FallbackProvider;
    import org.springframework.http.HttpHeaders;
    import org.springframework.http.HttpStatus;
    import org.springframework.http.MediaType;
    import org.springframework.http.client.ClientHttpResponse;
    import org.springframework.stereotype.Component;
    
    import java.io.ByteArrayInputStream;
    import java.io.IOException;
    import java.io.InputStream;
    
    /**
     * @author @wangmaoxiong
     * org.springframework.cloud.netflix.zuul.filters.route.FallbackProvider：当路由发生故障时提供回退. 实现类必须是组件，交由 Spring 容器管理
     * 1、可以为代理的每一个微服务都提供对应的 FallbackProvider，getRote()方法中返回对应的微服务名称
     * 2、如果要为所有路由统一提供默认回退，则使 getRoute 方法返回 * 或 null
     */
    @Component
    public class ZebraFallbackProvider implements FallbackProvider {
    
        /**
         * 指定路由目标微服务名称
         */
        @Override
        public String getRoute() {
            //返回路由代理的微服务名称，即网关 zuul.routes.customers.serviceId 配置的值
            //未配置 serviceId 时，就是 zuul.routes.customers 的 customers
            //如果要为所有路由统一提供默认回退，则使 getRoute 方法返回 * 或 null
            return "ec-zebra";
        }
    
        @Override
        public ClientHttpResponse fallbackResponse(String route, final Throwable cause) {
            //根据不同的异常类型返回不同的 Http 状态
            // HttpStatus.GATEWAY_TIMEOUT 表示网关超时(状态码504)，HttpStatus.INTERNAL_SERVER_ERROR 表示 内部服务器错误（状态码500）
            if (cause instanceof HystrixTimeoutException) {
                return response(HttpStatus.GATEWAY_TIMEOUT);
            } else {
                return response(HttpStatus.INTERNAL_SERVER_ERROR);
            }
        }
    
        private ClientHttpResponse response(final HttpStatus status) {
            //org.springframework.http.client.ClientHttpResponse 接口表示 http 响应，直接使用匿名函数实现此接口
            return new ClientHttpResponse() {
                @Override
                public HttpStatus getStatusCode() throws IOException {
                    //org.springframework.http.HttpStatus 是一个枚举，其中提供了所有的 http 状态
                    //比如 HttpStatus.OK 状态码是 200，HttpStatus.INTERNAL_SERVER_ERROR 状态码是 500;
                    return status;
                }
    
                @Override
                public int getRawStatusCode() throws IOException {
                    //返回原始状态码，同样可以通过 org.springframework.http.HttpStatus 枚举
                    //如 HttpStatus.BAD_REQUEST.value() 返回 400
                    return status.value();
                }
    
                @Override
                public String getStatusText() throws IOException {
                    //返回状态的文本内容，如 HttpStatus.BAD_REQUEST.getReasonPhrase() 返回 Bad Request
                    return status.getReasonPhrase();
                }
    
                @Override
                public void close() {
                }
    
                @Override
                public InputStream getBody() throws IOException {
                    //返回响应的正文，浏览器直接访问接口发生回退时，它会直接显示在页面上.
                    return new ByteArrayInputStream(("fallback " + ZebraFallbackProvider.this.getRoute()).getBytes());
                }
    
                @Override
                public HttpHeaders getHeaders() {
                    //返回 http 头信息
                    HttpHeaders headers = new HttpHeaders();
                    headers.setContentType(MediaType.APPLICATION_JSON);
                    return headers;
                }
            };
        }

> 可以为代理的每一个微服务都提供对应的 FallbackProvider 实现类，getRote() 方法中返回对应的微服务名称
> 
> 如果要为所有路由统一提供默认回退，则使 getRoute 方法返回 \* 或 null

3、为目标微服务提供 FallbackProvider 回退之后，当用户通过 zuul 访问目标微服务时，如果目标微服务故障，则自动进入 FallbackProvider 实现类，并返回其中的 ClientHttpResponse 作为 http 响应。

![2020030517382978.png][]

> 用户通过网关微服务 gateway-server 由线路 2 访问目标微服务 ec-zebra 时，如果 ec-zebra 服务故障，则进入 zuul 的 FallbackProvider 回退方法。
> 
> 用户通过网关微服务 gateway-server 由线路 1 访问目标微服务 ec-zebra 时，只有当 snow-leopard 服务 服务故障无法访问时，才会进入 zuul 的 FallbackProvider 回退方法。
> 
> 演示动图：[https://github.com/wangmaoxiong/MyDocument/blob/master/images/3.gif][https_github.com_wangmaoxiong_MyDocument_blob_master_images_3.gif]
> 
> 源码：[https://github.com/wangmaoxiong/Hystrix-hello-world/tree/master/gateway-zuul/src/main/java/com/wmx/gatewayzuul/fallback][https_github.com_wangmaoxiong_Hystrix-hello-world_tree_master_gateway-zuul_src_main_java_com_wmx_gatewayzuul_fallback]

# Zuul 过滤器概述与使用 #

1、Zuul 主要的功能就是 [Router and Filter][]（路由和过滤器），Zuul 中定义了四种标准过滤器类型，它们对应于请求的典型生命周期。

2、官网 [@EnableZuulServer Filters][EnableZuulServer Filters] 介绍 @EnableZuulServer 注解方式时有如下默认过滤器，它们都默认运行着。

**pre：前置过滤器**

1、在请求被路由之前调用，可利用这种过滤器实现身份验证、在集群中选择请求的微服务、记录调试信息等。

> 1）org.springframework.cloud.netflix.zuul.filters.pre.ServletDetectionFilter（优先级为 -3。优先级数值越小，执行越靠前）：检测请求是否通过 Spring Dispatcher，设置键 FilterConstants.IS*DISPATCHER*SERVLET*REQUEST*KEY. 的布尔值。
> 
> 2）org.springframework.cloud.netflix.zuul.filters.pre.FormBodyWrapperFilter（优先级为-1）：解析表单数据并为下游请求重新编码。
> 
> 3）org.springframework.cloud.netflix.zuul.filters.pre.DebugFilter(优先级为 1）：如果设置了调试请求参数(debug=true)，则将 RequestContext.setDebugRouting（）和 RequestContext.setDebugRequest（）设置为 true 开启调试。

**route: 路由过滤器**

1、将请求路由到微服务，默认使用 Apache Httpclient， 或 Netfilx Ribbon请求微服务。

> 1）org.springframework.cloud.netflix.zuul.filters.route.RibbonRoutingFilter(优先级为 10）：使用 Ribbon、Hystrix 和可插拔的 HTTP 客户端发送请求。 服务 ID 位于 RequestContext 属性中。
> 
> 2）RibbonRoutingFilter 默认使用 Apache HttpClient，配置属性 ribbon.okhttp.enabled=true 可以启用 OkHttpClient 作为 http 客户端，ribbon.restclient.enabled=true 可以启用 Netflix Ribbon HTTP client。
> 
> 3）org.springframework.cloud.netflix.zuul.filters.route.SendForwardFilter(优先级为 500）：通过使用 Servlet RequestDispatcher 转发请求，转发位置存储在 RequestContext 属性 FilterConstants.FORWARD*TO*KEY 中。 这对于转发到当前应用程序中的端点很有用。

**post: 后缀过滤器**

1、在路由到微服务以后执行，可用来为响应添加标准的 Http Header、收集统计信息和指标、将响应从微服务发送给客户端等。

> 1）org.springframework.cloud.netflix.zuul.filters.post.SendResponseFilter：将代理请求的响应写入当前响应。内容压缩，编码。

**error: 错误过滤器**

1、在其他阶段发生错误时执行该过滤器。

> 1）org.springframework.cloud.netflix.zuul.filters.post.SendErrorFilter(优先级为 0）：如果 RequestContext.getThrowable（）不为 null，则默认转发到 /error 端点。
> 
> 2）可以在全局配置文件中设置 "error.path" 属性来更改默认转发路径（/error）

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdteDE5OTMzMjg_size_16_color_FFFFFF_t_70][]

3、过滤器写法可以参考上面默认提供的过滤器的源码，自定义 Zuul 过滤器需要继承 ZuulFilter。下面编写一个简单的前置过滤器：

import com.netflix.zuul.ZuulFilter;
    import com.netflix.zuul.context.RequestContext;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.cloud.netflix.zuul.filters.support.FilterConstants;
    import org.springframework.stereotype.Component;
    
    import javax.servlet.http.HttpServletRequest;
    /**
     * @author wangmaoxiong
     * 1、com.netflix.zuul.ZuulFilter：是整个 Zuul 过滤器构架的超类
     * 2、前置过滤器可在 com.netflix.zuul.context.RequestContext 中设置数据，以供下游过滤器使用 .
     * 3、过滤器必须交由 Spring 容器管理，比如用 @Component 或者 @Bean 等
     */
    public class QueryParamPreFilter extends ZuulFilter {
        private static final Logger logger = LoggerFactory.getLogger(QueryParamPreFilter.class);
        /**
         * 是否继续执行 run 方法. 返回 true 表示继续执行 run 方法中的业务代码，否则 false 不再执行此过滤器
         * FORWARD_TO_KEY = "forward.to"
         * SERVICE_ID_KEY = "serviceId"
         */
        @Override
        public boolean shouldFilter() {
            RequestContext ctx = RequestContext.getCurrentContext();
            return !ctx.containsKey(FilterConstants.FORWARD_TO_KEY) && !ctx.containsKey(FilterConstants.SERVICE_ID_KEY);
        }
        /**
         * 指定过滤器执行优先级。数值越小，优先级越高
         * FilterConstants 定义了过滤器常数。pre_decoration_filter_order：表示前置过滤器优先级，常数值 5
         */
        @Override
        public int filterOrder() {
            return FilterConstants.PRE_DECORATION_FILTER_ORDER - 1;
        }
        /**
         * 过滤器类型
         * PRE_TYPE = "pre"：前缀过滤器
         * ROUTE_TYPE = "route"：路由过滤器
         * POST_TYPE = "post"：后缀过滤器
         * ERROR_TYPE = "error"：错误过滤器
         */
        @Override
        public String filterType() {
            return FilterConstants.PRE_TYPE;
        }
        /**
         * 如果 shouldFilter（）返回 true，则将调用 run 方法。 该方法是 ZuulFilter 的核心方法，用于编写业务逻辑.
         */
        @Override
        public Object run() {
            //com.netflix.zuul.context.RequestContext：zuul 的请求上下文
            RequestContext ctx = RequestContext.getCurrentContext();
            //获取 javax.servlet.http.HttpServletRequest
            HttpServletRequest request = ctx.getRequest();
    
            String remoteHost = request.getRemoteHost();
            int remotePort = request.getRemotePort();
            logger.info("用户 ip = {}，port = {}，wmx = {}", remoteHost, remotePort, request.getParameter("wmx"));
            return null;
        }
    }

![20200307103617107.gif][]

> 更多示例可以参考官网：[How to Write a Pre Filter][][、How to Write a Route Filter、][How to Write a Route Filter][How to Write a Post Filter][]

# Zuul RequestContext #

1、为了在 Zuul 的过滤器之间传递数据，Zuul 使用了 com.netflix.zuul.context.RequestContext，它的数据保存在每个请求特定的ThreadLocal 中。

2、有关将请求路由到哪里，错误信息，以及实际的 HttpServletRequest 和 HttpServletResponse 的信息存储都在 RequestContext 中。

3、RequestContext 扩展了 ConcurrentHashMap（并发集合），因此任何内容都可以存储在上下文中。

4、org.springframework.cloud.netflix.zuul.filters.support.FilterConstants：包含了 Spring Cloud Netflix Zuul 安装的过滤器使用的常量。

# 禁用 Zull 过滤器 #

1、官网 [Disable Zuul Filters 。][Disable Zuul Filters]Spring Cloud Zuul  在 org.springframework.cloud.netflix.zuul.filters 包下提供了许多在代理模式和服务器模式下默认启用的 ZuulFilter bean。

2、如果要禁用某个 ZuulFilter，请设置属性 zuul.<SimpleClassName>.<filterType> .disable = true。

> `SimpleClassName：是过滤器的名称，如`DebugFilter
> 
> `filterType：是过滤器对应的类型，如 pre、post、`route、error

![20200307151802916.gif][]

> 本文演示的源码：[https://github.com/wangmaoxiong/Hystrix-hello-world/tree/master/gateway-zuul/src/main/java/com/wmx/gatewayzuul][https_github.com_wangmaoxiong_Hystrix-hello-world_tree_master_gateway-zuul_src_main_java_com_wmx_gatewayzuul]

# Zuul 超时时间 #

1、官网 [Zuul Timeouts。][Zuul Timeouts]如果要为通过 Zuul 代理的请求配置套接字超时和读取超时，则根据配置有两种选择：

> 1）如果 Zuul 使用服务发现，则使用 ribbon.ReadTimeout 和 ribbon.SocketTimeout Ribbon 属性配置超时，单位毫秒。
> 
> 2）如果 Zull 通过指定 URL 配置的路由，则使用 zuul.host.connect-timeout-millis 和 zuul.host.socket-timeout-millis 属性

2、意思就是如果 zuul.routes 路由使用 serviceId 配置，则使用 ribbon. 的方式配置，如果 zuul.routes 路由使用 url 配置，则使用 zuul.host. 方式配置。

> 如果需要 zuul 代理文件上传，则还需要加上 ribbon.ConnectTimeout 连接超时配置.

#zuul网关代理路径默认有 hystrix 包裹，和 ribbon 进行负载均衡，所以需要设置它们的超时时间，单位毫秒
    #注意服务熔断超时时间要不 ribbon 负载均衡时间长，否则控制台会有警告，因为熔断无意义了
    hystrix.command.default.execution.isolation.thread.timeoutInMilliseconds: 180000
    ribbon:
      ConnectTimeout: 3000
      ReadTimeout: 60000
      SocketTimeout: 60000

[X. Appendices]: https://docs.spring.io/spring-boot/docs/2.1.3.RELEASE/reference/htmlsingle/#appendix
[20200305173744357.gif]: https://img-blog.csdnimg.cn/20200305173744357.gif
[https_github.com_wangmaoxiong_Hystrix-hello-world_tree_master_eureka_client2020_src_main]: https://github.com/wangmaoxiong/Hystrix-hello-world/tree/master/eureka_client2020/src/main
[Uploading Files through Zuul]: https://cloud.spring.io/spring-cloud-static/spring-cloud-netflix/2.1.0.RELEASE/single/spring-cloud-netflix.html#_uploading_files_through_zuul
[20200305173810540.gif]: https://img-blog.csdnimg.cn/20200305173810540.gif
[https_github.com_wangmaoxiong_Hystrix-hello-world_tree_master_gateway-zuul_src_main]: https://github.com/wangmaoxiong/Hystrix-hello-world/tree/master/gateway-zuul/src/main
[The Zuul Servlet]: https://cloud.spring.io/spring-cloud-static/spring-cloud-netflix/2.1.0.RELEASE/single/spring-cloud-netflix.html#_the_zuul_servlet
[Providing Hystrix Fallbacks For Routes]: https://cloud.spring.io/spring-cloud-static/spring-cloud-netflix/2.1.0.RELEASE/single/spring-cloud-netflix.html#hystrix-fallbacks-for-routes
[2020030517382978.png]: https://img-blog.csdnimg.cn/2020030517382978.png
[https_github.com_wangmaoxiong_MyDocument_blob_master_images_3.gif]: https://github.com/wangmaoxiong/MyDocument/blob/master/images/3.gif
[https_github.com_wangmaoxiong_Hystrix-hello-world_tree_master_gateway-zuul_src_main_java_com_wmx_gatewayzuul_fallback]: https://github.com/wangmaoxiong/Hystrix-hello-world/tree/master/gateway-zuul/src/main/java/com/wmx/gatewayzuul/fallback
[Router and Filter]: https://cloud.spring.io/spring-cloud-static/spring-cloud-netflix/2.1.0.RELEASE/single/spring-cloud-netflix.html#_router_and_filter_zuul
[EnableZuulServer Filters]: https://cloud.spring.io/spring-cloud-static/spring-cloud-netflix/2.1.0.RELEASE/single/spring-cloud-netflix.html#zuul-developer-guide-enable-filters
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdteDE5OTMzMjg_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200307102958158.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdteDE5OTMzMjg=,size_16,color_FFFFFF,t_70
[20200307103617107.gif]: https://img-blog.csdnimg.cn/20200307103617107.gif
[How to Write a Pre Filter]: https://cloud.spring.io/spring-cloud-static/spring-cloud-netflix/2.1.0.RELEASE/single/spring-cloud-netflix.html#zuul-developer-guide-sample-pre-filter
[How to Write a Route Filter]: https://cloud.spring.io/spring-cloud-static/spring-cloud-netflix/2.1.0.RELEASE/single/spring-cloud-netflix.html#zuul-developer-guide-sample-route-filter
[How to Write a Post Filter]: https://cloud.spring.io/spring-cloud-static/spring-cloud-netflix/2.1.0.RELEASE/single/spring-cloud-netflix.html#zuul-developer-guide-sample-post-filter
[Disable Zuul Filters]: https://cloud.spring.io/spring-cloud-static/spring-cloud-netflix/2.1.0.RELEASE/single/spring-cloud-netflix.html#_disable_zuul_filters
[20200307151802916.gif]: https://img-blog.csdnimg.cn/20200307151802916.gif
[https_github.com_wangmaoxiong_Hystrix-hello-world_tree_master_gateway-zuul_src_main_java_com_wmx_gatewayzuul]: https://github.com/wangmaoxiong/Hystrix-hello-world/tree/master/gateway-zuul/src/main/java/com/wmx/gatewayzuul
[Zuul Timeouts]: https://cloud.spring.io/spring-cloud-static/spring-cloud-netflix/2.1.0.RELEASE/single/spring-cloud-netflix.html#_zuul_timeouts