使用 `＜springProperty＞` 在 Logback 配置中引用 Spring 应用程序属性

在 Spring Boot 应用程序中，日志配置通常是一个至关重要的任务。使用 Logback 作为日志框架时，能够动态地引用 Spring 应用程序中的属性值是非常有用的。这不仅使日志配置更加灵活，还能确保日志格式与应用程序配置保持一致。本文将介绍 Logback 中的 <springProperty> 标签及其用法。

什么是 <springProperty>？

<springProperty> 标签用于从 Spring 应用程序的上下文中读取属性值，并将其赋值给 Logback 配置中的一个变量。这允许在 Logback 配置中使用 Spring 应用程序的配置值，确保日志格式与应用程序配置保持一致。

<springProperty> 的语法

<springProperty> 标签的基本语法如下：

<springProperty scope="context" name="property_name" source="property_source" [defaultValue="default_value"] />

• scope="context": 表示从 Spring 上下文中读取属性值。
• name: 在 Logback 配置中定义的属性名称。
• source: 指定从 Spring 应用程序配置文件中读取的属性源。
• defaultValue (可选): 如果 Spring 上下文中找不到指定的属性，则使用默认值。

示例配置

假设你的 Spring Boot 应用程序的 application.properties 文件中包含如下配置：

spring.application.name=my-app
server.port=8080
logging.path=/var/logs/myapp

在 Logback 的配置文件 logback.xml 中，你可以使用 <springProperty> 标签来动态引用这些属性值：

<configuration scan="true" scanPeriod="60 seconds" debug="false">

    <!-- 从 Spring 上下文中读取属性值 -->
    <springProperty scope="context" name="spring_application_name" source="spring.application.name" />
    <springProperty scope="context" name="server_port" source="server.port" />
    <springProperty scope="context" name="LOG_HOME" source="logging.path" defaultValue="../logs"/>

    <!-- 定义日志输出格式 -->
    <property name="CONSOLE_LOG_PATTERN" value="%clr(${spring_application_name}){cyan}||%clr(%d{ISO8601}){faint}|%clr(%p)|%X{requestId}|%X{X-B3-TraceId:-}|%X{requestIp}|%X{userIp}|%ip|${server_port}|${PID}|%clr(%t){faint}|%clr(%.40logger{39}){cyan}.%clr(%method){cyan}:%L|%m|%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}"/>
    <property name="FILE_LOG_PATTERN" value="${spring_application_name}||%d{ISO8601}|%p|%X{requestId}|%X{X-B3-TraceId:-}|%X{requestIp}|%X{userIp}|%ip|${server_port}|${PID}|%t|%.40logger{39}.%method:%L|%m|%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}"/>

    <!-- 定义控制台输出 -->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${CONSOLE_LOG_PATTERN}</pattern>
        </encoder>
    </appender>

    <!-- 定义文件输出 -->
    <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${LOG_HOME}/info.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>${LOG_HOME}/backup/info/info.%d{yyyy-MM-dd}.%i.log.gz</fileNamePattern>
            <maxHistory>30</maxHistory>
            <maxFileSize>100MB</maxFileSize>
            <totalSizeCap>5GB</totalSizeCap>
        </rollingPolicy>
        <encoder>
            <pattern>${FILE_LOG_PATTERN}</pattern>
        </encoder>
    </appender>

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

</configuration>

解析配置

1. 属性定义:
   • <springProperty scope="context" name="spring_application_name" source="spring.application.name" />：从 application.properties 文件中读取 spring.application.name 属性，并将其赋值给 spring_application_name。
   • <springProperty scope="context" name="server_port" source="server.port" />：从 application.properties 文件中读取 server.port 属性，并将其赋值给 server_port。
   • <springProperty scope="context" name="LOG_HOME" source="logging.path" defaultValue="../logs"/>：从 application.properties 文件中读取 logging.path 属性，并将其赋值给 LOG_HOME。如果找不到该属性，则使用默认值 ../logs。
2. 使用属性:
   • 在日志格式中，${spring_application_name} 将被替换为 my-app，${server_port} 将被替换为 8080。
   • 日志输出将根据定义的格式生成，例如 my-app||2024-08-16 15:30:22|INFO|12345|User logged in。

总结

通过使用 <springProperty> 标签，你可以在 Logback 配置中动态地引用 Spring 应用程序中的属性值。这使得日志配置更加灵活和动态，能够适应不同的环境配置。确保 Logback 的日志格式与 Spring 应用程序的配置保持一致，提高了日志管理的便利性和一致性。

希望这篇博客对你理解和使用 <springProperty> 标签有所帮助！如果有更多问题，欢迎大家评论区交流！