转载

Spring Cloud Zuul 那些你不知道的功能点

本文摘自于 《Spring Cloud微服务入门实战与进阶》 一书。

1. /routes 端点

当@EnableZuulProxy与Spring Boot Actuator配合使用时，Zuul会暴露一个路由管理端点/routes。

借助这个端点，可以方便、直观地查看以及管理Zuul的路由。

将所有端点都暴露出来，增加下面的配置:

访问 http://localhost:2103/actuator/routes 可以显示所有路由信息：

2. /filters 端点

/fliters端点会返回Zuul中所有过滤器的信息。可以清楚的了解Zuul中目前有哪些过滤器，哪些被禁用了等详细信息。

访问 http://localhost:2103/actuator/filters 可以显示所有过滤器信息：

3. 文件上传

创建一个新的Maven项目zuul-file-demo，编写一个文件上传的接口，如代码清单7-20所示。

代码清单 7-20 文件上传接口

将服务注册到Eureka中，服务名称为zuul-file-demo，通过PostMan来上传文件,如图7-4所示

Spring Cloud Zuul 那些你不知道的功能点

可以看到接口正常返回了文件上传之后的路径，接下来我们换一个大一点的文件，文件大小为1.7MB。

Spring Cloud Zuul 那些你不知道的功能点

可以看到报错了（如图7-5所示），通过Zuul上传文件，如果超过1M需要配置上传文件的大小, Zuul和上传的服务都要加上配置:

配置加完后重新上传就可以成功了，如图7-6所示。

Spring Cloud Zuul 那些你不知道的功能点

第二种解决办法是在网关的请求地址前面加上/zuul，就可以绕过Spring DispatcherServlet进行上传大文件。

通过加上/zuul前缀可以让Zuul服务不用配置文件上传大小，但是接收文件的服务还是需要配置文件上传大小，否则文件还是会上传失败。

在上传大文件的时候，时间比较会比较长，这个时候需要设置合理的超时时间来避免超时。

在Hystrix隔离模式为线程下zuul.ribbon-isolation-strategy=thread，需要设置Hystrix超时时间。

4. 请求响应信息输出

系统在生产环境出现问题时，排查问题最好的方式就是查看日志了，日志的记录尽量详细，这样你才能快速定位问题。

下面带大家学习如何在Zuul中输出请求响应的信息来辅助我们解决一些问题。

熟悉Zuul的朋友都知道，Zuul中有4种类型过滤器，每种都有特定的使用场景，要想记录响应数据，那么必须是在请求路由到了具体的服务之后，返回了才有数据，这种需求就适合用post过滤器来实现了。如代码清单7-21所示。

代码清单 7-21 Zull获取请求信息

输出效果如下:

Spring Cloud Zuul 那些你不知道的功能点

获取响应内容第一种方式，如代码清单7-22所示。

代码清单 7-22 获取响应内容(一)

获取响应内容第二种方式，如代码清单7-23所示。

代码清单 7-23 获取响应内容（二）

为什么上面两种方式可以取到响应内容？

在RibbonRoutingFilter或者SimpleHostRoutingFilter中可以看到下面一段代码，如代码清单7-24所示。

代码清单 7-24 响应内容获取源码

forward()方法对服务调用，拿到响应结果，通过setResponse()方法进行响应的设置，如代码清单7-25所示。

代码清单 7-25 setResponse(一)

上面第一行代码就可以解释我们的第一种获取的方法，这边直接把响应内容加到了RequestContext中。

第二种方式的解释就在helper.setResponse的逻辑里面了，如代码清单7-26所示。

代码清单 7-26 setResponse(二)

5. Zuul自带的Debug功能

Zuul中自带了一个DebugFilter，一开始我也没明白这个DebugFilter有什么用，看名称很容易理解，用来调试的，可是你看它源码几乎没什么逻辑，就set了两个值而已，如代码清单7-27所示。

代码清单 7-27 DebugFilter run方法

要想让这个过滤器执行就得研究下它的shouldFilter()方法，如代码清单7-28所示。

代码清单 7-28 DebugFilter shouldFilter 方法

只要满足两个条件中的任何一个就可以开启这个过滤器，第一个条件是请求参数中带了某个参数=true就可以开启，这个参数名是通过下面的代码获取的，如代码清单7-29所示。

代码清单 7-29 DebugFilter启用参数（一）

DynamicStringProperty是Netflix的配置管理框架Archaius提供的API，可以从配置中心获取配置，由于Netflix没有开源Archaius的服务端，所以这边用的就是默认值debug,如果大家想动态去获取这个值的话可以用携程开源的Apollo来对接Archaius，这个在后面章节给大家讲解。

可以在请求地址后面追加debug=true来开启这个过滤器，参数名称debug也可以在配置文件中进行覆盖，用zuul.debug.parameter指定，否则就是从Archaius中获取，没有对接Archaius那就是默认值debug。

第二个条件代码，如代码清单7-30所示。

代码清单 7-30 DebugFilter启用参数(二)

是通过配置zuul.debug.request来决定的，可以在配置文件中配置zuul.debug.request=true开启DebugFilter过滤器。

DebugFilter过滤器开启后，并没什么效果，在run方法中只是设置了DebugRouting和DebugRequest两个值为true,于是继续看源码，发现在很多地方有这么一段代码，比如com.netflix.zuul.FilterProcessor.runFilters(String)中，如代码清单7-31所示。