Spring Boot Logback 日志简单使用

1,612 阅读2分钟

相逢便是缘,路过点个赞

源码:https://github.com/yulc-coding/java-note/tree/master/logback

相关文章: Spring Boot Log4j2 日志简单使用

功能点

  • 按日志级别生成文件

  • 自定义生成日志文件:

    1. 定时任务等需要独立分析的日志存放独立文件
    2. 将指定包或者类的日志生成独立的文件
  • 按日期生成文件

  • 设定日志文件大小

  • 设定日志文件过期时间


开始

  • Spring Boot 默认使用了Logback作为日志框架,所以不需要引入其他jar包
  • 在 src/main/resources 下新建XML文件 logback-spring.xml

基本结构

<configuration>

  <!-- 定义变量  通过 ${name} 来使用 -->
  <property name="", value =""></property>

  <!-- 日志相关配置 -->
  <appender></appender>

  <!-- 设置具体的打印,并引用appender -->
  <logger></logger>

 <!-- 功能同logger, 是所有logger的上级节点 -->
  <root></root>

</configuration>
property

配置自定义变量

<!-- 定义日志文件的存储地址 -->
<property name="LOG_HOME" value="./logs"/>

<!-- 定义日志打印格式 -->
<property name="LOG_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%X{user}]-[%X{args}] [%thread] %-5level %logger{50} - %msg%n"/>
appender

日志的组件,name指定appender名称,供 和 引用。class指定appender的输出方式

  1. ch.qos.logback.core.ConsoleAppender :
    在控制台打印
    <!-- Console 控制台输出设置 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <withJansi>true</withJansi>
        <!-- 对日志进行格式化 -->
        <encoder>
            <!-- 控制台彩色打印 -->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %blue([%X{user}]-[%X{args}]) %green([%thread]) %highlight(%-5level) %boldMagenta(%logger{50}) - %cyan(%msg%n)</pattern>
            <charset>utf8</charset>
        </encoder>
    </appender>
  1. ch.qos.logback.core.FileAppender :
    把日志添加到文件,一直累加一个文件,导致文件过大,查看不方便,不推荐使用

  2. ch.qos.logback.core.rolling.RollingFileAppender :
    滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件,比如:超过单个文件设定的大小,按天归档日志

<!-- 定时任务类设置单独日志文件 -->
    <appender name="SCHEDULE-APPENDER" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 当前日志文件的名字 -->
        <File>${LOG_HOME}/schedule.log</File>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 归档日志文件输出的文件名 -->
            <FileNamePattern>${LOG_HOME}/schedule.%d{yyyy-MM-dd}.%i.log</FileNamePattern>
            <!-- 日志文件保留天数 -->
            <MaxHistory>7</MaxHistory>
            <!-- 单个日志文件最大的大小 -->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>5MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <!-- 对日志进行格式化 -->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${LOG_PATTERN}</pattern>
        </encoder>
        <!-- 打印INFO及以上日志-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>INFO</level>
        </filter>
    </appender>

以上表示每天生成一个新的日志文件,单个文件超过5M生成一个新的文件,保留最近7天的日志文件

logger

单独日志打印:
name 属性: 1、name属性和LoggerFactory.getLogger("schedule") 中的属性一样 2、name属性为指定的包或者类路径 level: 指定日志级别 additivity:内容是否向上传递,如果为true,否则会同时显示在root配置的认日志中

    <!--这里的name和业务类中的getLogger中的字符串是一样的-->
    <logger name="schedule" level="INFO" additivity="false">
        <appender-ref ref="SCHEDULE-APPENDER"/>
    </logger>
    <!-- org.ylc.note.logback.service 包下的所有日志独立打印 (也可以指定到类上)-->
    <logger name="org.ylc.note.logback.service" level="INFO" additivity="false">
        <appender-ref ref="SERVICE-APPENDER"/>
    </logger>
root

根loger,所有的 logger 的上级,设置需要打印的日志组件


单元测试
@SpringBootTest
class LogbackApplicationTests {

    /**
     * 普通类日志
     */
    private final Logger normalLogger = LoggerFactory.getLogger(LogbackApplicationTests.class);

    /**
     * 定时任务类日志,这里的name必须和XML中logger 的name一致,这里为 schedule
     */
    private final Logger scheduleLogger = LoggerFactory.getLogger("schedule");

    @Autowired
    private MyService myService;

    /**
     * 普通日志测试
     */
    @Test
    void normalLogTest() {
        normalLogger.info("this is a info log with out args");
        normalLogger.error("this is a error log with out args");
    }

    /**
     * 带参数的日志测试
     */
    @Test
    void argsLogTest() {
        MDC.put("user", "鱼大仙");
        MDC.put("args", "参数");
        normalLogger.info("this is a info log with args");
        normalLogger.error("this is a error log with args");
    }

    /**
     * 独立日志测试
     * 1、指定日志名称
     * 2、指定包或者类
     */
    @Test
    void independentLogTest() {
        // 指定名称
        scheduleLogger.info("this is a schedule info log");
        scheduleLogger.error("this is a schedule error log");
        // 指定包或者类
        myService.myLog();
    }

}

求关注