如何使用伪装拦截器/解码器记录请求-自定义格式的响应?

时间:2019-07-11 20:06:30

标签: spring-boot spring-cloud-feign feign

我正在为springboot开发一个自定义的日志记录框架,以记录其余模板的请求和响应,并且运行良好。我正在尝试为“ Feign-Client”实施相同的功能,并且遇到了一些问题。

  1. 对于请求日志记录,它利用FeignRequestInterceptor并运行良好,这里唯一的问题是我无法收回完整的请求URL。 下面的方法只给我相对URL。

requestTemplate.url()

  1. 要记录响应,我唯一能找到的方法就是ResponseDecoder。在那里,我可以检索除有效载荷以外的所有内容。从
  2. 访问有效负载时
  String payload = new String(IOUtils.toByteArray(is));

上面的方法可以工作,但是由于记录正常,原始流已关闭,但是客户端在返回响应时抛出异常。

“尝试打开封闭的流”

如果在Feign中有类似于Spring Rest-Template的更好的记录请求响应的方法,我想提出建议。或者,如果我采用的方法很好,请帮助我解决上述问题。

2 个答案:

答案 0 :(得分:0)

您可以配置一个自定义feign.Logger实例来处理此问题。有两个内置的,JavaLogger使用java.util.loggingSlf4JLogger使用slf4j。您可以通过扩展feign.Logger并将其注册为@Bean来创建自己的记录器实现。

该记录器应由Spring拿起并在您的FeignClient中注册。这是Logger基类,可以帮助您入门:

protected abstract void log(String configKey, String format, Object... args);

创建您自己的实例,实现此方法,它将在请求之前和返回响应之后被调用。无需更新拦截器或创建响应解码器。

答案 1 :(得分:0)

在RestConfiguration中,您需要提高日志记录feignClient的默认级别,并通过@Bean feignLogger进行覆盖,例如:

@Configuration(proxyBeanMethods = false)
@EnableCircuitBreaker
@EnableFeignClients(basePackageClasses = [Application::class])
class RestConfiguration: WebMvcConfigurer {

    @Bean
    fun feignLoggerLevel(): Logger.Level {
        return Logger.Level.FULL
    }

    @Bean
    fun feignLogger(): Logger {
        return FeignClientLogger()
    }
}

并实现您的记录器(日志格式):

import feign.Logger
import feign.Request
import feign.Response
import feign.Util.*
import org.slf4j.LoggerFactory

class FeignClientLogger : Logger() {
    private val log = LoggerFactory.getLogger(this::class.java)

    override fun logRequest(configKey: String?, logLevel: Level?, request: Request?) {
        if (request == null)
            return

        val feignRequest = FeignRequest()
        feignRequest.method = request.httpMethod().name
        feignRequest.url = request.url()
        for (field in request.headers().keys) {
            for (value in valuesOrEmpty(request.headers(), field)) {
                feignRequest.addHeader(field, value)
            }
        }

        if (request.requestBody() != null) {
            feignRequest.body = request.requestBody().asString()
        }

        log.trace(feignRequest.toString())
    }

    override fun logAndRebufferResponse(
        configKey: String?,
        logLevel: Level?,
        response: Response?,
        elapsedTime: Long
    ): Response? {
        if (response == null)
            return response

        val feignResponse = FeignResponse()
        val status = response.status()
        feignResponse.status = response.status()
        feignResponse.reason =
            (if (response.reason() != null && logLevel!! > Level.NONE) " " + response.reason() else "")
        feignResponse.duration = elapsedTime

        if (logLevel!!.ordinal >= Level.HEADERS.ordinal) {
            for (field in response.headers().keys) {
                for (value in valuesOrEmpty(response.headers(), field)) {
                    feignResponse.addHeader(field, value)
                }
            }

            if (response.body() != null && !(status == 204 || status == 205)) {
                val bodyData: ByteArray = toByteArray(response.body().asInputStream())
                if (logLevel.ordinal >= Level.FULL.ordinal && bodyData.isNotEmpty()) {
                    feignResponse.body = decodeOrDefault(bodyData, UTF_8, "Binary data")
                }
                log.trace(feignResponse.toString())

                return response.toBuilder().body(bodyData).build()
            } else {
                log.trace(feignResponse.toString())
            }
        }
        return response
    }

    override fun log(p0: String?, p1: String?, vararg p2: Any?) {}
}

class FeignResponse {
    var status = 0
    var reason: String? = null
    var duration: Long = 0
    private val headers: MutableList<String> = mutableListOf()
    var body: String? = null

    fun addHeader(key: String?, value: String?) {
        headers.add("$key: $value")
    }

    override fun toString() =
        """{"type":"response","status":"$status","duration":"$duration","headers":$headers,"body":$body,"reason":"$reason"}"""
}

class FeignRequest {
    var method: String? = null
    var url: String? = null
    private val headers: MutableList<String> = mutableListOf()
    var body: String? = null

    fun addHeader(key: String?, value: String?) {
        headers.add("$key: $value")
    }

    override fun toString() =
        """{"type":"request","method":"$method","url":"$url","headers":$headers,"body":$body}"""
}
相关问题