spring_cloud_feign_log

2024-08-22 07:18
文章标签 java spring cloud feign log

本文主要是介绍spring_cloud_feign_log，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

这篇主要介绍一下spring cloud feign log的相关知识点。

下面以一个项目中的具体例子来说明：

下面是一个接口，在a服务中通过feign去调用b服务的generateBizNo接口，最后返回b服务的generateBizNo所返回的响应。

@FeignClient(value = "serviceName", url = "serviceUrl", fallbackFactory = FeignFallbackFactory.class,configuration = FeignLogConfiguration.class
)
public interface IOuterXXService extends BaseFeignClient {@RequestMapping(value = "/xx/yy", method = RequestMethod.POST)ResultBase<String> generateBizNo(XXX var1);
}

那么，如何来打印出这个feign调用的接口的相关日志呢？

  • 使用log去该接口的实现类的方法调用开始和结束打印日志？
  • 使用切面去打印日志？
  • 还有其他？？？

这里我介绍的是使用spring cloud 的feign log来打印feign接口调用日志，效果图如下：

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-siEil36M-1602235194448)(/Users/yongyongli/msad_document/documents/image-20201009164140207.png)]

通过上图我们可以看到feign log的日志输出有如下的信息：

  • 接口调用的方法及域名
  • http协议
  • 请求的头信息content-type以及content-length
  • 入参报文和相应报文，都是json格式
  • 请求耗时以及响应的状态码
  • 请求应用的名称以及端口号

下面是关于spring cloud feign log的相关知识点和如何才可以做出上面的效果：

首先，需要增加一个配置类：

package com.xxx.xxx.xxx.spi.configuration;import feign.Logger;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;/*** @author lee* @date 2020/10/9***/
@Configuration
public class FeignLogConfiguration {@BeanLogger.Level feignLoggerLevel(){// 设置feign打印的log级别，此处的full代表的是信息全部打印，此log level非彼log levelreturn Logger.Level.FULL;}
}

第二步，在你使用@FeignClient的注解的时候，里面新增属性configuration=FeignLogConfiguration.class

@FeignClient(value = "serviceName", url = "serviceUrl", fallbackFactory = FeignFallbackFactory.class,configuration = FeignLogConfiguration.class
)

第三步，需要进行一些配置，我们使用的是nacos，所以在a服务的配置文件中新增如下的配置信息：

logging:level:com:xxx:yyy: DEBUG

需要注意的是logging和level两个层级是必须配置的，其他层级就是包路径，此处是日志的级别，需要设置为DEBUG，才可以生效。

到这里，基本就可以实现上面的效果了。

接下来说一下相关的知识点：

该Logger是feign包下的一个抽象类，位于

<dependency><groupId>io.github.openfeign</groupId><artifactId>feign-core</artifactId>
</dependency>

存在一个枚举Level，里面四个枚举项：

  • NONE:不打印日志
  • BASIC：只打印请求方法和url，以及响应状态码和执行时间
  • FULL：打印头信息，请求体，响应豹纹和元数据
  • HEADERS：打印基本的请求和响应头信息

其中存在一个logRequest的方法用来处理请求，logAndRebufferResponse来处理响应报文。

具体的源码如下所示：

package feign;import java.io.IOException;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.util.logging.FileHandler;
import java.util.logging.LogRecord;
import java.util.logging.SimpleFormatter;import static feign.Util.UTF_8;
import static feign.Util.decodeOrDefault;
import static feign.Util.valuesOrEmpty;/*** Simple logging abstraction for debug messages.  Adapted from {@code retrofit.RestAdapter.Log}.*/
public abstract class Logger {protected static String methodTag(String configKey) {return new StringBuilder().append('[').append(configKey.substring(0, configKey.indexOf('('))).append("] ").toString();}/*** Override to log requests and responses using your own implementation. Messages will be http* request and response text.** @param configKey value of {@link Feign#configKey(Class, java.lang.reflect.Method)}* @param format    {@link java.util.Formatter format string}* @param args      arguments applied to {@code format}*/protected abstract void log(String configKey, String format, Object... args);protected void logRequest(String configKey, Level logLevel, Request request) {log(configKey, "---> %s %s HTTP/1.1", request.method(), request.url());if (logLevel.ordinal() >= Level.HEADERS.ordinal()) {for (String field : request.headers().keySet()) {for (String value : valuesOrEmpty(request.headers(), field)) {log(configKey, "%s: %s", field, value);}}int bodyLength = 0;if (request.body() != null) {bodyLength = request.body().length;if (logLevel.ordinal() >= Level.FULL.ordinal()) {StringbodyText =request.charset() != null ? new String(request.body(), request.charset()) : null;log(configKey, ""); // CRLFlog(configKey, "%s", bodyText != null ? bodyText : "Binary data");}}log(configKey, "---> END HTTP (%s-byte body)", bodyLength);}}protected void logRetry(String configKey, Level logLevel) {log(configKey, "---> RETRYING");}protected Response logAndRebufferResponse(String configKey, Level logLevel, Response response,long elapsedTime) throws IOException {String reason = response.reason() != null && logLevel.compareTo(Level.NONE) > 0 ?" " + response.reason() : "";int status = response.status();log(configKey, "<--- HTTP/1.1 %s%s (%sms)", status, reason, elapsedTime);if (logLevel.ordinal() >= Level.HEADERS.ordinal()) {for (String field : response.headers().keySet()) {for (String value : valuesOrEmpty(response.headers(), field)) {log(configKey, "%s: %s", field, value);}}int bodyLength = 0;if (response.body() != null && !(status == 204 || status == 205)) {// HTTP 204 No Content "...response MUST NOT include a message-body"// HTTP 205 Reset Content "...response MUST NOT include an entity"if (logLevel.ordinal() >= Level.FULL.ordinal()) {log(configKey, ""); // CRLF}byte[] bodyData = Util.toByteArray(response.body().asInputStream());bodyLength = bodyData.length;if (logLevel.ordinal() >= Level.FULL.ordinal() && bodyLength > 0) {log(configKey, "%s", decodeOrDefault(bodyData, UTF_8, "Binary data"));}log(configKey, "<--- END HTTP (%s-byte body)", bodyLength);return response.toBuilder().body(bodyData).build();} else {log(configKey, "<--- END HTTP (%s-byte body)", bodyLength);}}return response;}protected IOException logIOException(String configKey, Level logLevel, IOException ioe, long elapsedTime) {log(configKey, "<--- ERROR %s: %s (%sms)", ioe.getClass().getSimpleName(), ioe.getMessage(),elapsedTime);if (logLevel.ordinal() >= Level.FULL.ordinal()) {StringWriter sw = new StringWriter();ioe.printStackTrace(new PrintWriter(sw));log(configKey, sw.toString());log(configKey, "<--- END ERROR");}return ioe;}/*** Controls the level of logging.*/public enum Level {/*** No logging.*/NONE,/*** Log only the request method and URL and the response status code and execution time.*/BASIC,/*** Log the basic information along with request and response headers.*/HEADERS,/*** Log the headers, body, and metadata for both requests and responses.*/FULL}/*** Logs to System.err.*/public static class ErrorLogger extends Logger {@Overrideprotected void log(String configKey, String format, Object... args) {System.err.printf(methodTag(configKey) + format + "%n", args);}}/*** Logs to the category {@link Logger} at {@link java.util.logging.Level#FINE}, if loggable.*/public static class JavaLogger extends Logger {final java.util.logging.Loggerlogger =java.util.logging.Logger.getLogger(Logger.class.getName());@Overrideprotected void logRequest(String configKey, Level logLevel, Request request) {if (logger.isLoggable(java.util.logging.Level.FINE)) {super.logRequest(configKey, logLevel, request);}}@Overrideprotected Response logAndRebufferResponse(String configKey, Level logLevel, Response response,long elapsedTime) throws IOException {if (logger.isLoggable(java.util.logging.Level.FINE)) {return super.logAndRebufferResponse(configKey, logLevel, response, elapsedTime);}return response;}@Overrideprotected void log(String configKey, String format, Object... args) {if (logger.isLoggable(java.util.logging.Level.FINE)) {logger.fine(String.format(methodTag(configKey) + format, args));}}/*** Helper that configures java.util.logging to sanely log messages at FINE level without additional* formatting.*/public JavaLogger appendToFile(String logfile) {logger.setLevel(java.util.logging.Level.FINE);try {FileHandler handler = new FileHandler(logfile, true);handler.setFormatter(new SimpleFormatter() {@Overridepublic String format(LogRecord record) {return String.format("%s%n", record.getMessage()); // NOPMD}});logger.addHandler(handler);} catch (IOException e) {throw new IllegalStateException("Could not add file handler.", e);}return this;}}public static class NoOpLogger extends Logger {@Overrideprotected void logRequest(String configKey, Level logLevel, Request request) {}@Overrideprotected Response logAndRebufferResponse(String configKey, Level logLevel, Response response,long elapsedTime) throws IOException {return response;}@Overrideprotected void log(String configKey, String format, Object... args) {}}
}

最后说一下整个的调用链路：

在这里插入图片描述

为什么配置log的级别为debug，需要看看Slf4jLogger类对request和response请求响应报文的处理。

关于spring cloud feign log的相关知识介绍到这里，如果本文存在不对之处，麻烦指点批评。

在这里插入图片描述

这篇关于spring_cloud_feign_log的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1095599。

相关文章

JVM 的类初始化机制

JVM 的类初始化机制

前言 当你在 Java 程序中new对象时，有没有考虑过 JVM 是如何把静态的字节码（byte code）转化为运行时对象的呢，这个问题看似简单，但清楚的同学相信也不会太多，这篇文章首先介绍 JVM 类初始化的机制，然后给出几个易出错的实例来分析，帮助大家更好理解这个知识点。 JVM 将字节码转化为运行时对象分为三个阶段，分别是：loading 、Linking、initialization
阅读更多...
Spring Security 基于表达式的权限控制

Spring Security 基于表达式的权限控制

前言 spring security 3.0已经可以使用spring el表达式来控制授权，允许在表达式中使用复杂的布尔逻辑来控制访问的权限。 常见的表达式 Spring Security可用表达式对象的基类是SecurityExpressionRoot。 表达式描述hasRole([role])用户拥有制定的角色时返回true （Spring security默认会带有ROLE_前缀）,去
阅读更多...
浅析Spring Security认证过程

浅析Spring Security认证过程

类图 为了方便理解Spring Security认证流程，特意画了如下的类图，包含相关的核心认证类 概述 核心验证器 AuthenticationManager 该对象提供了认证方法的入口，接收一个Authentiaton对象作为参数; public interface AuthenticationManager {Authentication authenticate(Authenti
阅读更多...
Spring Security--Architecture Overview

Spring Security--Architecture Overview

1 核心组件 这一节主要介绍一些在Spring Security中常见且核心的Java类，它们之间的依赖，构建起了整个框架。想要理解整个架构，最起码得对这些类眼熟。 1.1 SecurityContextHolder SecurityContextHolder用于存储安全上下文（security context）的信息。当前操作的用户是谁，该用户是否已经被认证，他拥有哪些角色权限…这些都被保
阅读更多...
Spring Security基于数据库验证流程详解

Spring Security基于数据库验证流程详解

Spring Security 校验流程图 相关解释说明（认真看哦） AbstractAuthenticationProcessingFilter 抽象类 /*** 调用 #requiresAuthentication(HttpServletRequest, HttpServletResponse) 决定是否需要进行验证操作。* 如果需要验证，则会调用 #attemptAuthentica
阅读更多...
Spring Security 从入门到进阶系列教程

Spring Security 从入门到进阶系列教程

Spring Security 入门系列 《保护 Web 应用的安全》 《Spring-Security-入门（一）：登录与退出》 《Spring-Security-入门（二）：基于数据库验证》 《Spring-Security-入门（三）：密码加密》 《Spring-Security-入门（四）：自定义-Filter》 《Spring-Security-入门（五）：在 Sprin
阅读更多...
Java架构师知识体认识

Java架构师知识体认识

源码分析 常用设计模式 Proxy代理模式Factory工厂模式Singleton单例模式Delegate委派模式Strategy策略模式Prototype原型模式Template模板模式 Spring5 beans 接口实例化代理Bean操作 Context Ioc容器设计原理及高级特性Aop设计原理Factorybean与Beanfactory Transaction 声明式事物
阅读更多...
Java进阶13讲__第12讲_1/2

Java进阶13讲__第12讲_1/2

多线程、线程池 1.  线程概念 1.1  什么是线程 1.2  线程的好处 2.   创建线程的三种方式 注意事项 2.1  继承Thread类 2.1.1 认识  2.1.2  编码实现  package cn.hdc.oop10.Thread;import org.slf4j.Logger;import org.slf4j.LoggerFactory
阅读更多...
JAVA智听未来一站式有声阅读平台听书系统小程序源码

JAVA智听未来一站式有声阅读平台听书系统小程序源码

智听未来，一站式有声阅读平台听书系统 🌟&nbsp;开篇：遇见未来，从“智听”开始 在这个快节奏的时代，你是否渴望在忙碌的间隙，找到一片属于自己的宁静角落？是否梦想着能随时随地，沉浸在知识的海洋，或是故事的奇幻世界里？今天，就让我带你一起探索“智听未来”——这一站式有声阅读平台听书系统，它正悄悄改变着我们的阅读方式，让未来触手可及！ 📚&nbsp;第一站：海量资源，应有尽有 走进“智听
阅读更多...
内核启动时减少log的方式

内核启动时减少log的方式

内核引导选项 内核引导选项大体上可以分为两类：一类与设备无关、另一类与设备有关。与设备有关的引导选项多如牛毛，需要你自己阅读内核中的相应驱动程序源码以获取其能够接受的引导选项。比如，如果你想知道可以向 AHA1542 SCSI 驱动程序传递哪些引导选项，那么就查看 drivers/scsi/aha1542.c 文件，一般在前面 100 行注释里就可以找到所接受的引导选项说明。大多数选项是通过"_
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2