首页 > Spring Cloud
阅读:193
Spring Cloud实现Zuul自带的Debug功能
Zuul 中自带了一个 DebugFilter,一开始笔者也没明白这个 DebugFilter 有什么用,看名称很容易理解,它是用来调试的,可是你看它的源码几乎没什么逻辑,就 set 了两个值而已,代码如下所示。
第一个条件是请求参数中带了“某个参数 =true”就可以开启,这个参数名是通过下面的代码获取的,代码如下所示。
可以在请求地址后面追加“debug=true”来开启这个过滤器,参数名称 debug 也可以在配置文件中进行覆盖,用 zuul.debug.parameter 指定,否则就是从 Archaius 中获取,没有对接 Archaius 那就是默认值 debug。
第二个条件的代码,具体代码如下所示。
DebugFilter 过滤器开启后,并没什么效果,在 run 方法中只是设置了 DebugRouting 和 DebugRequest 两个值为 true,于是继续看源码,发现在很多地方都有这样一段代码,比如 com.netflix.zuul.FilterProcessor.runFilters(String) 中,代码如下所示。
到了这步后还是有些疑惑,一般我们调试信息的话肯定是用日志输出来的,日志级别就是 Debug,但这个 Debug 信息只是累加起来存储到 RequestContext 中,没有对使用者展示。
在 org.springframework.cloud.netflix.zuul.filters.post.SendResponseFilter.addResponseHeaders() 这段代码中我们看到了希望。具体代码如下所示。
图 1 调试内容
@Override public Object run() { RequestContext ctx = RequestContext.getCurrentContext(); ctx.setDebugRouting(true); ctx.setDebugRequest(true); return null; }要想让这个过滤器执行就得研究一下它的 shouldFilter() 方法,代码如下所示。
@Override public boolean shouldFilter() { HttpServletRequest request = RequestContext.getCurrentContext().getRequest(); if ("true".equals(request.getParameter(DEBUG_PARAMETER.get()))) { return true; } return ROUTING_DEBUG.get(); }只要满足两个条件中的任何一个就可以开启这个过滤器。
第一个条件是请求参数中带了“某个参数 =true”就可以开启,这个参数名是通过下面的代码获取的,代码如下所示。
private static final DynamicStringProperty DEBUG_PARAMETER = DynamicPropertyFactory.getInstance()
.getStringProperty(ZuulConstants.ZUUL_DEBUG_PARAMETER, "debug");
可以在请求地址后面追加“debug=true”来开启这个过滤器,参数名称 debug 也可以在配置文件中进行覆盖,用 zuul.debug.parameter 指定,否则就是从 Archaius 中获取,没有对接 Archaius 那就是默认值 debug。
第二个条件的代码,具体代码如下所示。
private static final DynamicBooleanProperty ROUTING_DEBUG = DynamicPropertyFactory
.getInstance().getBooleanProperty(ZuulConstants.ZUUL_DEBUG_REQUEST, false);
DebugFilter 过滤器开启后,并没什么效果,在 run 方法中只是设置了 DebugRouting 和 DebugRequest 两个值为 true,于是继续看源码,发现在很多地方都有这样一段代码,比如 com.netflix.zuul.FilterProcessor.runFilters(String) 中,代码如下所示。
if (RequestContext.getCurrentContext().debugRouting()) {
Debug.addRoutingDebug("Invoking {" + sType + "} type filters");
}
到了这步后还是有些疑惑,一般我们调试信息的话肯定是用日志输出来的,日志级别就是 Debug,但这个 Debug 信息只是累加起来存储到 RequestContext 中,没有对使用者展示。
在 org.springframework.cloud.netflix.zuul.filters.post.SendResponseFilter.addResponseHeaders() 这段代码中我们看到了希望。具体代码如下所示。
private void addResponseHeaders() { RequestContext context = RequestContext.getCurrentContext(); HttpServletResponse servletResponse = context.getResponse(); if (this.zuulProperties.isIncludeDebugHeader()) { @SuppressWarnings("unchecked") List<String> rd = (List<String>) context.get(ROUTING_DEBUG_KEY); if (rd != null) { StringBuilder debugHeader = new StringBuilder(); for (String it : rd) { debugHeader.append("[[[" + it + "]]]"); } servletResponse.addHeader(X_ZUUL_DEBUG_HEADER, debugHeader.toString()); } } }核心代码在于 this.zuulProperties.isIncludeDebugHeader(),只有满足这个条件才会把 RequestContext 中的调试信息作为响应头输出,在配置文件中增加下面的配置即可:
zuul.include-debug-header=true
最后在请求的响应头中可以看到调试内容,如图 1 所示。图 1 调试内容
所有教程
- socket
- Python基础教程
- C#教程
- MySQL函数
- MySQL
- C语言入门
- C语言专题
- C语言编译器
- C语言编程实例
- GCC编译器
- 数据结构
- C语言项目案例
- C++教程
- OpenCV
- Qt教程
- Unity 3D教程
- UE4
- STL
- Redis
- Android教程
- JavaScript
- PHP
- Mybatis
- Spring Cloud
- Maven
- vi命令
- Spring Boot
- Spring MVC
- Hibernate
- Linux
- Linux命令
- Shell脚本
- Java教程
- 设计模式
- Spring
- Servlet
- Struts2
- Java Swing
- JSP教程
- CSS教程
- TensorFlow
- 区块链
- Go语言教程
- Docker
- 编程笔记
- 资源下载
- 关于我们
- 汇编语言
- 大数据
- 云计算
- VIP视频