SpringBoot优雅地配置日志

naodai 发布于1月前
0 条问题

本文主要给大家介绍SpringBoot中如何通过sl4j日志组件优雅地记录日志。其实,我们入门 JAVA 的第一行代码就是一行日志,那你现在还在使用 System.out.println("Hello,小明!") 记录日志吗?

我经历过的日志组件

我最开始接触的日志组件是 Log4j

Log4j作为Apache的一个开放源代码的项目,通过使用 Log4j ,我们可以控制日志信息输送的目的地是控制台、文件等我们期望它输出到的地方;我们也可以控制每一条日志的输出格式;通过定义每一条日志信息的级别,我们能够更加细致地控制日志的生成过程。

我们可以通过一个配置文件来灵活地进行上面的配置,而不需要修改应用的代码。 Log4j 作为当时作为最先比较流行的日志框架,给我们在应用开发和维护带来了很大的便捷。

但是,如今还是慢慢的走下“神坛”呢,逐渐被 Logback 替代,众里寻她千百度,原来 Logback升级版 ,相对 Log4j 而言有了更多的改进,而且开发人员竟然是同班人马(其实就是一个人写的)!

新星Logback

Logback主要有下面的特性:

  1. 更快的执行速度:基于我们先前在 Log4j 上的工作, Logback 重写了内部的实现,在某些特定的场景上面,甚至可以比之前的速度快上10倍。在保证 Logback 的组件更加快速的同时,同时所需的内存更加少;
  2. 充分的测试: Logback 历经了几年,数不清小时数的测试。尽管 Log4j 也是测试过的,但是 Logback 的测试更加充分,跟 Log4j 不在同一个级别。我们认为,这正是人们选择 Logback 而不是 Log4j 的最重要的原因。谁不希望即使在恶劣的条件下,你的日志框架依然稳定而可靠呢?
  • 由三个模块组成
    • logback-core
    • logback-classic
    • logback-access

logback-core 是其它模块的基础设施,其它模块基于它构建,显然, logback-core 提供了一些关键的通用机制。 logback-classic 的地位和作用等同于 Log4J ,它也被认为是 Log4J 的一个改进版,并且它实现了简单日志门面 SLF4J ;而 logback-access 主要作为一个与 Servlet 容器交互的模块,比如说 tomcat 或者 jetty ,提供一些与 HTTP 访问相关的功能。

那Sl4J又是什么?

slf4j:The Simple Logging Facade for Java 即java的简单日志门面

简答的讲就是 slf4j 是一系列的日志接口, slf4j 是作为一个日志的抽象行为存在的,但是并没有提供真正的实现。

slf4j为各种日志框架提供了一个统一的界面,使用户可以用统一的接口记录日志,动态地决定要使用的实现框架,比如 LogbackLog4jcommon-logging 等框架都实现了这些接口。

我是如何配置日志的?

路人皆知, Springboot 默认使用的日志框架是 Logback 。顺势而为,在项目中,我们使用 Logback ,其实只需增加一个配置文件(自定义你的配置)即可。

配置文件详解

配置文件精简结构如下所示

<configuration scan="true" scanPeriod="60 seconds" debug="false">  
         <!-- 属性文件:在properties/yml文件中找到对应的配置项 -->
    <springProperty scope="context" name="logging.path" source="logging.path"/>
    <contextName>程序员小明</contextName> 
    
    <appender>
        //xxxx
    </appender>   
    
    <logger>
        //xxxx
    </logger>
    
    <root>             
       //xxxx
    </root>  
</configuration>

这个文件在springboot中默认叫做 logback-spring.xml ,我们只要新建一个同名文件放在 resources 下面, 配置即可生效。

每个配置的解释如下所示:

contextName

每个 logger 都关联到 logger 上下文,默认上下文名称为 “default” 。但可以使用 contextName 标签设置成其他名字,用于区分不同应用程序的记录

property

用来定义变量值的标签, property 标签有两个属性, name 和 value ;其中 name 的值是变量的名称, value 的值时变量定义的值。通过 property 定义的值会被插入到 logger 上下文中。定义变量后,可以使“${name}”来使用变量。如上面的 xml 所示。

logger

用来设置某一个包或者具体的某一个类的日志打印级别以及指定 appender 。

root

根logger,也是一种logger,且只有一个level属性

appender

负责写日志的组件

appender 的种类

  • ConsoleAppender:把日志添加到控制台
  • FileAppender:把日志添加到文件
  • RollingFileAppender:滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件。它是FileAppender的子类

filter

filter其实是appender里面的子元素。它作为过滤器存在,执行一个过滤器会有返回DENY,NEUTRAL,ACCEPT三个枚举值中的一个。

  • DENY:日志将立即被抛弃不再经过其他过滤器

  • NEUTRAL:有序列表里的下个过滤器过接着处理日志

  • ACCEPT:日志会被立即处理,不再经过剩余过滤器

    有以下几种过滤器

    ThresholdFilter

    临界值过滤器,过滤掉低于指定临界值的日志。当日志级别等于或高于临界值时,过滤器返回 NEUTRAL ;当日志级别低于临界值时,日志会被拒绝。

    <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
        <level>INFO</level>
    </filter>

    LevelFilter

    级别过滤器,根据日志级别进行过滤。如果日志级别等于配置级别,过滤器会根据 onMath (用于配置符合过滤条件的操作) 和 onMismatch (用于配置不符合过滤条件的操作)接收或拒绝日志。

    <filter class="ch.qos.logback.classic.filter.LevelFilter">   
      <level>INFO</level>   
      <onMatch>ACCEPT</onMatch>   
      <onMismatch>DENY</onMismatch>   
    </filter>

项目实例

准备

一个简单正常的Springboot项目

配置文件

application.yml

有关日志的简单配置,我们可以直接在 application.yml 中进行简单的配置,比如指明日志的打印级别和日志的输出位置

logging:
  level:
    root: info
  path: ./logs

也可以根据分环境配置指明使用的配置文件,缺省为 logback-spring.xml

logging:
  level:
    root: info
  path: ./logs
  config: classpath:/logback-dev.xml

logback-spring.xml

resources 目录下新建 logback-spring.xml 文件,举例一个简单的需求,如果在项目中我们如果需要指定日志的输出格式以及根据日志级别输出到不同的文件,可以配置如下:

<?xml version="1.0" encoding="UTF-8" ?>
<configuration>
    <!-- 属性文件:在properties文件中找到对应的配置项 -->
    <springProperty scope="context" name="logging.path" source="logging.path"/>
    <contextName>xiaoming</contextName>
    <appender name="consoleLog" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出(配色):%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度%msg:日志消息,%n是换行符-->
            <pattern>%yellow(%d{yyyy-MM-dd HH:mm:ss}) %red([%thread]) %highlight(%-5level) %cyan(%logger{50}) - %magenta(%msg) %n
            </pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!--根据日志级别分离日志,分别输出到不同的文件-->
    <appender name="fileInfoLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>DENY</onMatch>
            <onMismatch>ACCEPT</onMismatch>
        </filter>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>
                %d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} - %msg%n
            </pattern>
            <charset>UTF-8</charset>
        </encoder>
        <!--滚动策略-->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--按时间保存日志 修改格式可以按小时、按天、月来保存-->
            <fileNamePattern>${logging.path}/xiaoming.info.%d{yyyy-MM-dd}.log</fileNamePattern>
            <!--保存时长-->
            <MaxHistory>90</MaxHistory>
            <!--文件大小-->
            <totalSizeCap>1GB</totalSizeCap>
        </rollingPolicy>
    </appender>

    <appender name="fileErrorLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>ERROR</level>
        </filter>
        <encoder>
            <pattern>
                %d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} - %msg%n
            </pattern>
        </encoder>
        <!--滚动策略-->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--路径-->
            <fileNamePattern>${logging.path}/xiaoming.error.%d{yyyy-MM-dd}.log</fileNamePattern>
            <MaxHistory>90</MaxHistory>
        </rollingPolicy>
    </appender>
    <root level="info">
        <appender-ref ref="consoleLog"/>
        <appender-ref ref="fileInfoLog"/>
        <appender-ref ref="fileErrorLog"/>
    </root>
</configuration>

再比如如果粒度再细一些,根据不同的模块,输出到不同的文件,可以如下配置

<!--特殊功能单独appender 例如调度类的日志-->
    <appender name="CLASS-APPENDER" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>INFO</level>
        </filter>
        <encoder>
            <pattern>
                %d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} - %msg%n
            </pattern>
        </encoder>
        <!--滚动策略-->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--路径-->
            <fileNamePattern>${logging.path}/mkc.class.%d{yyyy-MM-dd}.log</fileNamePattern>
            <MaxHistory>90</MaxHistory>
        </rollingPolicy>
    </appender>
    <!--这里的name和业务类中的getLogger中的字符串是一样的-->
    <logger name="xiaoming" level="INFO" additivity="true">
        <appender-ref ref="CLASS-APPENDER" />
    </logger>

正常情况下 xiaoming 是指的

private Logger xiaoming = LoggerFactory.getLogger("xiaoming");

如果我们使用的是 lomok 插件,则 xiaoming 指的是 topic

@Slf4j(topic = "xiaoming")
public class XiaoMingTest {

}

其他

小明目前用到的就这么多啦,更多的日志配置场景,大家可以访问: 看完这个不会配置 logback ,请你吃瓜!

有什么问题,欢迎大家留言~

欢迎关注微信公众号”程序员小明”,获取更多资源。

查看原文: SpringBoot优雅地配置日志

  • greenswan
  • ticklishlion
  • blackfish
需要 登录 后回复方可回复, 如果你还没有账号你可以 注册 一个帐号。