SpringWebflux中WebClient怎么打印日志

一、背景

去年高峰压测的时候,有个服务是专门调用其它系统的,在测试接口http请求的时候,那TPS唰唰的往下掉,还专门用Arthas看了一下方法执行时间,那家伙,我sleep 2s,看时间都3-4s了,所以就想着后面优化一下。

所以,这不就到我们的主角SpringWebflux了,就想着用服务用Webflux,Http请求直接用WebClient了。但是有一个问题就不得不思考了,怎么记录请求的日志呢?这个日志很重要,必须的记录的清楚,不然不用系统间沟通(扯皮背锅)着实难搞。

二、怎么记录日志?

2.1 思考记录

打印日志,那第一步得去看看官网咯?看看官网提供了什么解决方案

2.1.1 官网寻答案

打开官网,翻到Filter这一页,发现着实有可以记录日志的,我把官网代码粘贴在下图。

WebClient client = WebClient.builder()
        .filter((request, next) -> {
            ClientRequest filtered = ClientRequest.from(request)
                    .header("foo", "bar")
                    .build();

            return next.exchange(filtered);
        })
        .build();

可以看到,我们是可以拿到Request的,这让我一顿高兴,那这操作起来不简单? 但是呢,凡事不能高兴太早。

拿到这ClientRequest去代码一顿敲(clientRequest.xx),这个点都被我按烂了,发现并没有可以获取RequestBody的方法,只有Headers,URI... 可惜这都不是我要的啊。没办法,那就只有换别的方法了。

顺便点了一下filter的ExchangeFilterFunction,发现里面有方法还能拿到Rresponse。代码如下:

static ExchangeFilterFunction ofResponseProcessor(Function<ClientResponse, Mono<ClientResponse>> processor) {
  Assert.notNull(processor, "ClientResponse Function must not be null");
  return (request, next) -> next.exchange(request).flatMap(processor);
}

然后拿着Response又来一顿操作,可以拿到Response Body等,但是...但是...如果我们在Response里面把Response Body 使用掉,就会报错:nested exception is java.lang.IllegalStateException: The client response body can only be consumed once。如图所示。

提前使用ResponseBody

没有办法,查看了ClientResponse实现类org.springframework.web.reactive.function.client.DefaultClientResponse,这个是个包权限的类,虽然很想直接用,比如:requestDescription(URL路径),getBody, 但是是在拿不到啊~~难受

既然如此,那就只有从别的地方寻找。

2.1.2 其它方案

在官网上WebFlux有三种方案,分别是集成Jetty, Netty, HttpComponent5。由于我使用的是HttpComponent5,所以就直接从http这个寻找方案了。

寻寻觅觅,找到了了相似的方案,也可以添加Interceptor。我就直接贴出代码,如下图。

Http添加拦截器

但是在实现时,发现了有两个问题。

问题一

打印Request日志的时候会出现两次。

问题二

打印Response的时候也会出现nested exception is java.lang.IllegalStateException: The client response body can only be consumed once这个异常。

出现这个问题,没有发现啥好用的解决方案。

2.1.3 Google

后来就想着想换成Jetty和Netty,就google了一波,我直接把连接贴出来,就不过多描述了。 连接如下:

Logging Spring WebClient Calls | Baeldung 这个方案也尝试了一波,但是效果如上。会出现问题一,或者在获取Body的时候出现问题。

2.2 解决方案

在经历了好几天Debug和测试后,就选择了妥协方案,直接在webClient请求的时候打印日志。这还算是一个完美的解决方案。

我贴出一部分代码,如下。

    /**
     * 打印全流程日志,需要外部传入参数
     */
    public static Function<ClientResponse, Mono<String>> logging(String url, String method, Object reqBody) {
        return (clientResponse -> clientResponse.bodyToMono(String.class).doOnSuccess(body -> {
            if (log.isDebugEnabled()) {
                log.info("\n" +
                                "TraceId      : {}, {}\n" +
                                "URI          : {}, \n" +
                                "Param        : {}, \n" +
                                "RespHeader   : {}, \n" +
                                "RespStatus   : {}, \n" +
                                "Response     : {}", clientResponse.logPrefix(), method, url, JsonUtils.toJson(reqBody),
                        clientResponse.headers().asHttpHeaders(), clientResponse.rawStatusCode(),
                        StringUtils.abbreviate(body, 4000));
            }
        }));
    }

在获取到Body的时候,直接转化成String.class,如果直接转成ParameterizedTypeReference就会失去部分原请求的数据,这样在扯皮的时候不好找证据呀!(我们打印清晰的日志是为了更好的查询问题,不是扯皮︿( ̄︶ ̄)︿ )

这样打印出来的日志就是我们想要的了,舒服啊~ 这样看起来才舒服。

还写了一些其它的小工具,获取连接,使用方式如下:

小工具使用方式

三、总结

以上是探索WebClient的打印日志的方式,还有不足,欢迎大家讨论,提出更好的方式。谢谢!

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,132评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,802评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,566评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,858评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,867评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,695评论 1 282
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,064评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,705评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,915评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,677评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,796评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,432评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,041评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,992评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,223评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,185评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,535评论 2 343

推荐阅读更多精彩内容