Feign Client全局日志打印

一、背景介绍

spring cloud 微服务架构中，需要对依赖服务的请求留痕(URL，出参，入参、耗时等)

1.现状

调用FeignClient(Integration类中)时 手工记录log

缺点：重复工作、log格式不统一

优点：充分满足个性化需求、灵活度极高(再说上天了)

 

2.目标

实现简洁统一的全局外部服务调用日志输出

示例如下：

get: GET 200 http://wwww.feigntest.com/dict/items?systemId=11 86 RESPONSE BODY:{"code":"000000","success":true}

post: POST 200 http://wwww.feigntest.com/limitBill 85 REQUEST BODY:{"custNo":"121212","startTime":null,"endTime":null} RESPONSE BODY:{"code":"001001010","success":false}

异常: POST UnknownHostException http://wwww.feigntest.com/errorUri 206 REQUEST BODY:{"custNo":"121212"}

3.实现基础

基于FeignClient已有的全局请求日志处理类feign.Logger

feign.Logger日志输出级别为debug

输出header信息较多，大多服务并不需要

 

网上有类似资料，讲解如何启用feign.Logger、如何修改debug为info级别

本文增加对输出内容的简化.

 

二、如何使用

step 1.重写feign.Logger 

-> 修改feign.Logger日志输出级别为info，简化输出内容

package com.cdfinance.mall.config;
import feign.Request;
import feign.Response;
import feign.Util;
import lombok.extern.slf4j.Slf4j;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
import static feign.Util.UTF_8;
import static feign.Util.decodeOrDefault;
/**
 * Feign请求日志处理类<br/>
 * 所有通过Feign请求的外部接口都会被监控
 *
 * @version V1.0
 * @author: maoliang
 * @date: 2020/3/27
 */
@Slf4j
public class FeignLogger extends feign.Logger {
    static ThreadLocal<Map<String, String>> logContext = new ThreadLocal();
    static String PATH = "path";
    static String METHOD = "method";
    static String REQUEST_BODY = "body";
    @Override
    protected void logRequest(String configKey, Level logLevel, Request request) {
        Map<String, String> logMap = new HashMap<>(3);
        logMap.put(PATH, request.url());
        logMap.put(METHOD, request.method());
        logMap.put(REQUEST_BODY, request.body() == null ? null :
                request.charset() == null ? null : new String(request.body(), request.charset()));
        logContext.set(logMap);
    }
    @Override
    protected Response logAndRebufferResponse(
            String configKey, Level logLevel, Response response, long elapsedTime) throws IOException {
        Map<String, String> requetParam = logContext.get();
        StringBuilder stringBuilder = new StringBuilder();
        stringBuilder
                .append(requetParam.get(METHOD)).append(" ")
                .append(response.status()).append(" ")
                .append(requetParam.get(PATH)).append(" ")
                .append(elapsedTime);
        if (requetParam.get(REQUEST_BODY) != null) {
            stringBuilder.append(" REQUEST BODY:").append(requetParam.get(REQUEST_BODY));
        }
        logContext.remove();
        // 返回参数
        if (response.body() != null && !(response.status() == 204 || response.status() == 205)) {
            byte[] bodyData = Util.toByteArray(response.body().asInputStream());
            if (bodyData.length > 0) {
                String responseBody = decodeOrDefault(bodyData, UTF_8, "Binary data");
                stringBuilder
                        .append(" RESPONSE BODY:")
                        .append(responseBody.replaceAll("\\s*|\t|\r|\n", ""));
            }
            log.info(stringBuilder.toString());
            return response.toBuilder().body(bodyData).build();
        }
        log.info(stringBuilder.toString());
        return response;
    }
    protected IOException logIOException(String configKey, Level logLevel, IOException ioe, long elapsedTime) {
        Map<String, String> requetParam = logContext.get();
        StringBuilder stringBuilder = new StringBuilder();
        stringBuilder
                .append(requetParam.get(METHOD)).append(" ")
                .append(ioe.getClass().getSimpleName()).append(" ")
                .append(requetParam.get(PATH)).append(" ")
                .append(elapsedTime);
        if (requetParam.get(REQUEST_BODY) != null) {
            stringBuilder.append(" REQUEST BODY:").append(requetParam.get(REQUEST_BODY));
        }
        log.warn(stringBuilder.toString());
        logContext.remove();
        return ioe;
    }
    @Override
    protected void log(String configKey, String format, Object... args) {
        if (log.isInfoEnabled()) {
            log.info(String.format(methodTag(configKey) + format, args));
        }
    }
}

 

step 2.注册FeignLogger

-> 注册FeignLogger, 设置 Logger.Level为FULL

import feign.Logger;  
import org.springframework.context.annotation.Bean;  
import org.springframework.context.annotation.Configuration;  
/**
 * 注册FeignClient请求日志配置
 *
 * @version V1.0
 * @author: mlxnle
 * @date: 2020/04/01
 */  
@Configuration  
public class FeignLoggerConfig {  
    @Bean  
    Logger.Level loggerLevel() {  
        return Logger.Level.FULL;  
    }  
    @Bean  
    Logger feignLogger() {  
        return new FeignLogger(); // 你的继承类 
    }  
}

 

step 3.开始你的请求

-> 没有第三步！ 惊不惊喜