发布于 由admin

JAVA Feign 请求日志不输出？Logger.Level 配置与日志实现机制讲解

Feign 请求日志不输出？Logger.Level 配置与日志实现机制深度剖析

大家好，今天我们来深入探讨一个在使用 Feign 进行微服务调用时，经常会遇到的问题：Feign 请求日志不输出。这个问题看似简单，但背后涉及 Feign 的配置、Logger 的 Level 设置，以及底层的日志实现机制等多个方面。我们将从问题的表象入手，逐步深入到问题的本质，并提供一系列的解决方案。

问题的表象：Feign 调用，日志寂静无声

在使用 Feign 进行微服务调用时，我们期望能够看到 Feign 框架输出的请求和响应日志，以便于调试和排错。然而，有时我们会发现，尽管配置了相关的日志选项，Feign 仍然保持沉默，没有任何日志输出。

例如，我们可能会在 Feign 客户端接口上添加 @RequestLine 注解，并在配置文件中设置 logging.level.com.example.feign.client = DEBUG，但仍然无法看到 Feign 的请求和响应信息。

// Feign 客户端接口
@FeignClient(name = "example-service")
public interface ExampleClient {

    @RequestLine("GET /api/data/{id}")
    String getData(@Param("id") String id);
}

// application.properties
logging.level.com.example.feign.client = DEBUG

这种情况下，我们需要仔细检查配置，理解 Feign 的日志机制，并排查可能导致日志无法输出的原因。

Feign 的 Logger.Level 配置：控制日志输出的阀门

Feign 提供了 Logger.Level 枚举，用于控制日志输出的详细程度。这个枚举定义了以下几个级别：

Level 描述
NONE 不记录任何日志（默认值）
BASIC 仅记录请求方法、URL 以及响应状态码和执行时间
HEADERS 在 BASIC 的基础上，记录请求和响应的 header 信息
FULL 记录完整的请求和响应数据，包括 body

要启用 Feign 的日志功能，我们需要在 Feign 的配置类中，配置一个 Logger.Level 的 Bean。

import feign.Logger;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class FeignConfiguration {

    @Bean
    Logger.Level feignLoggerLevel() {
        return Logger.Level.FULL; // 可以根据需要选择不同的 Level
    }
}

这个配置告诉 Feign，使用 FULL 级别的日志输出。但是，仅仅配置 Logger.Level 并不足以保证日志能够输出。我们还需要确保日志框架正确配置，并且 Feign 客户端的日志级别也被正确设置。

日志框架的配置：底层支撑，决定日志的最终去向

Feign 默认使用 Java Util Logging (JUL) 作为日志框架。虽然 JUL 是 Java 自带的日志框架，但在实际应用中，我们通常会使用更强大的日志框架，例如 Logback 或者 Log4j2。

如果我们在项目中使用了 Logback 或者 Log4j2，我们需要将 Feign 的日志输出重定向到这些框架。这通常需要使用 SLF4J (Simple Logging Facade for Java) 作为日志门面。

使用 SLF4J 作为日志门面

SLF4J 允许我们在不修改代码的情况下，切换底层的日志实现。要使用 SLF4J，我们需要添加 SLF4J API 的依赖，并选择一个 SLF4J 的绑定。

<!-- Maven 依赖 -->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.36</version>
</dependency>

<!-- Logback 绑定 -->
<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>1.2.11</version>
    <scope>runtime</scope>
</dependency>

<!-- Log4j2 绑定 -->
<!--
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-slf4j-impl</artifactId>
    <version>2.17.1</version>
    <scope>runtime</scope>
</dependency>
-->

添加了 SLF4J 和 Logback (或者 Log4j2) 的依赖后，Feign 就可以通过 SLF4J 将日志输出到 Logback (或者 Log4j2)。

配置 Logback 或 Log4j2

接下来，我们需要配置 Logback 或者 Log4j2，以确保 Feign 的日志能够被正确地输出。

Logback 配置 (logback.xml)
<configuration>
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <logger name="com.example.feign.client" level="DEBUG" additivity="false">
        <appender-ref ref="CONSOLE"/>
    </logger>

    <root level="INFO">
        <appender-ref ref="CONSOLE"/>
    </root>
</configuration>
Log4j2 配置 (log4j2.xml)
<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
        </Console>
    </Appenders>
    <Loggers>
        <Logger name="com.example.feign.client" level="DEBUG" additivity="false">
            <AppenderRef ref="Console"/>
        </Logger>
        <Root level="INFO">
            <AppenderRef ref="Console"/>
        </Root>
    </Loggers>
</Configuration>

在 Logback 和 Log4j2 的配置中，我们都配置了一个名为 com.example.feign.client 的 Logger，并将它的级别设置为 DEBUG。这告诉日志框架，输出 com.example.feign.client 包下的所有 DEBUG 级别的日志。

注意: com.example.feign.client 需要替换成你实际的 Feign 客户端接口所在的包名。

Feign 客户端的日志级别：精确定位，控制日志的范围

除了配置 Feign 的 Logger.Level 和日志框架，我们还需要确保 Feign 客户端的日志级别也被正确设置。这可以通过在 application.properties 或者 application.yml 文件中配置 logging.level 属性来实现。

# application.properties
logging.level.com.example.feign.client = DEBUG

或者

# application.yml
logging:
  level:
    com.example.feign.client: DEBUG

这个配置告诉 Spring Boot，将 com.example.feign.client 包下的所有类的日志级别设置为 DEBUG。

注意: com.example.feign.client 需要替换成你实际的 Feign 客户端接口所在的包名。

常见问题排查：细致入微，不放过任何蛛丝马迹

即使配置了 Logger.Level、日志框架和 Feign 客户端的日志级别，Feign 的日志仍然可能无法输出。这时，我们需要仔细排查以下几个常见问题：

  1. 依赖冲突： 检查项目中是否存在多个版本的 SLF4J 或者日志框架的依赖。如果存在依赖冲突，可能会导致日志输出出现问题。可以使用 Maven 的 mvn dependency:tree 命令或者 Gradle 的 gradle dependencies 命令来查看项目的依赖树，并解决依赖冲突。

  2. 配置覆盖： 检查项目中是否存在多个配置文件，例如 application.properties、application.yml 和 bootstrap.properties 等。如果存在多个配置文件，需要确保 Feign 客户端的日志级别配置没有被其他配置覆盖。

  3. AOP 代理： 如果 Feign 客户端被 AOP 代理，可能会导致日志无法输出。可以尝试调整 AOP 的配置，或者禁用 AOP 代理来解决这个问题。

  4. 自定义 Logger： 如果你自定义了 Feign 的 Logger 实现，需要确保你的实现正确地输出了日志。

  5. Feign 版本： 某些 Feign 版本可能存在日志输出的问题。可以尝试升级或者降级 Feign 的版本来解决这个问题。

代码示例：一个完整的 Feign 日志配置示例

下面是一个完整的 Feign 日志配置示例，包括 Feign 客户端接口、Feign 配置类、SLF4J 依赖、Logback 配置和 application.properties 文件。

// Feign 客户端接口
@FeignClient(name = "example-service")
public interface ExampleClient {

    @RequestLine("GET /api/data/{id}")
    String getData(@Param("id") String id);
}

// Feign 配置类
import feign.Logger;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class FeignConfiguration {

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

// Maven 依赖 (pom.xml)
<dependencies>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-openfeign</artifactId>
    </dependency>

    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
        <version>1.7.36</version>
    </dependency>

    <dependency>
        <groupId>ch.qos.logback</groupId>
        <artifactId>logback-classic</artifactId>
        <version>1.2.11</version>
        <scope>runtime</scope>
    </dependency>
</dependencies>

// Logback 配置 (logback.xml)
<configuration>
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <logger name="com.example.feign.client" level="DEBUG" additivity="false">
        <appender-ref ref="CONSOLE"/>
    </logger>

    <root level="INFO">
        <appender-ref ref="CONSOLE"/>
    </root>
</configuration>

// application.properties
logging.level.com.example.feign.client = DEBUG

表格总结：Feign 日志配置的关键要素

关键要素 描述
Feign Logger.Level 控制 Feign 日志输出的详细程度。可以选择 NONE, BASIC, HEADERS, FULL 等级别。
日志框架配置 配置底层的日志框架，例如 Logback 或者 Log4j2。需要使用 SLF4J 作为日志门面，并将 Feign 的日志输出重定向到这些框架。
Feign 客户端日志级别 控制 Feign 客户端的日志级别。可以通过在 application.properties 或者 application.yml 文件中配置 logging.level 属性来实现。
常见问题排查 检查依赖冲突、配置覆盖、AOP 代理、自定义 Logger 和 Feign 版本等问题。

解决日志输出问题：配置是关键，细节需注意

Feign 日志不输出的问题通常是由于配置不当引起的。我们需要仔细检查 Feign 的 Logger.Level 配置、日志框架的配置和 Feign 客户端的日志级别，并排查可能存在的常见问题。通过细致的配置和排查，我们可以解决 Feign 日志不输出的问题，并更好地监控和调试微服务调用。

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注