配置日志 - logback

一. 添加 Maven 依赖

<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
</dependency>

<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>jcl-over-slf4j</artifactId>
</dependency>

二. 方法1:在 src\main\resources 路径下创建logback.xml配置文件(线上liunx部署error,本地demo可用)

<?xml version="1.0" encoding="UTF-8"?>
<configuration>

    <!--定义日志文件的存储地址 勿在 LogBack的配置中使用相对路径 -->
    <property name="LOG_HOME" value="D:/logs/" />

    <!-- 控制台输出 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{30} - %msg%n</pattern>
        </encoder>
    </appender>

    <!-- 按照每天生成日志文件 -->
    <appender name="FILE"
              class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <FileNamePattern>${LOG_HOME}spring_boot_demo_%d{yyyy-MM-dd}.log</FileNamePattern>
            <!--日志文件保留天数 -->
            <MaxHistory>30</MaxHistory>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度%msg:日志消息,%n是换行符 -->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{30} - %msg%n</pattern>
        </encoder>
        <!--日志文件最大的大小 -->
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <MaxFileSize>10MB</MaxFileSize>
        </triggeringPolicy>
    </appender>

    <!-- 日志输出级别 -->
    <root level="INFO">
        <appender-ref ref="STDOUT" />
        <appender-ref ref="FILE" />
    </root>

    <!-- 定义各个包的详细路径,继承root的值 -->
    <logger name="com.hry.spring.log" level="INFO" />
    <logger name="com.hry.spring" level="TRACE" />

    <!-- 此值由 application.properties的spring.profiles.active=dev指定-->
    <springProfile name="dev">
        <property name="LOG_HOME" value="D:/tmp/log" />
        <logger name="org.springboot.sample" level="DEBUG" />
    </springProfile>

    <springProfile name="pro">
        <property name="LOG_HOME" value="D:/home" />
        <logger name="org.springboot.sample2" level="INFO" />
    </springProfile>

</configuration>

encoder 格式概念:

  • %d{HH:mm:ss.SSS}——日志输出时间
  • %thread——输出日志的进程名字,这在Web应用以及异步任务处理中很有用
  • %-5level——日志级别,并且使用5个字符靠左对齐
  • %logger{36}——日志输出者的名字
  • %msg——日志消息
  • %n——平台的换行符

二. 方法2:在 src\main\resources 路径下创建logback.xml配置文件

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!-- %m输出的信息,%p日志级别,%t线程名,%d日期,%c类的全名,%i索引【从数字0开始递增】,,, -->
    <!-- appender是configuration的子节点,是负责写日志的组件。 -->
    <!-- ConsoleAppender:把日志输出到控制台 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d %p (%file:%line\)- %m%n</pattern>
            <!-- 控制台也要使用UTF-8,不要使用GBK,否则会中文乱码 -->
            <charset>UTF-8</charset>
        </encoder>
    </appender>
    <!-- RollingFileAppender:滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件 -->
    <!-- 以下的大概意思是:1.先按日期存日志,日期变了,将前一天的日志文件名重命名为XXX%日期%索引,新的日志仍然是demo.log -->
    <!--             2.如果日期没有发生变化,但是当前日志的文件大小超过20MB时,对当前日志进行分割 重命名-->
    <appender name="PROJECT_LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <File>log/moji_service.log</File>
        <!-- rollingPolicy:当发生滚动时,决定 RollingFileAppender 的行为,涉及文件移动和重命名。 -->
        <!-- TimeBasedRollingPolicy: 最常用的滚动策略,它根据时间来制定滚动策略,既负责滚动也负责出发滚动 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 活动文件的名字会根据fileNamePattern的值,每隔一段时间改变一次 -->
            <!-- 文件名:log/ltc.2017-12-05.0.log -->
            <fileNamePattern>log/moji.%d.%i.log</fileNamePattern>
            <!-- 每产生一个日志文件,该日志文件的保存期限为30天 -->
            <maxHistory>30</maxHistory>
            <timeBasedFileNamingAndTriggeringPolicy  class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- maxFileSize:这是活动文件的大小,默认值是10MB,测试时可改成1KB看效果 -->
                <maxFileSize>20MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <encoder>
            <!-- pattern节点,用来设置日志的输入格式 -->
            <pattern>
                %d %p (%file:%line\)- %m%n
            </pattern>
            <!-- 记录日志的编码:此处设置字符集 - -->
            <charset>UTF-8</charset>
        </encoder>
    </appender>
    <!-- 控制台输出日志级别 -->
    <root level="debug">
        <appender-ref ref="STDOUT" />
        <appender-ref ref="PROJECT_LOG" />
    </root>
    <!-- 指定项目中某个包,当有日志操作行为时的日志记录级别 -->
    <!-- com.liyan为根包,也就是只要是发生在这个根包下面的所有日志操作行为的权限都是DEBUG -->
    <!-- 级别依次为【从高到低】:FATAL > ERROR > WARN > INFO > DEBUG > TRACE  -->
    <logger name="com.mapper.ding">
        <appender-ref ref="STDOUT" />
    </logger>
</configuration>

三. application.properties配置

  • 设不设置都可以,如果设置,会直接覆盖logback.xml配置文件中的root输出等级,如果不设置则使用logback.xml的root配置
    # 日志服务
    logging.level.root = info
    

四. 测试

package com.example.controller;

import com.example.utils.RandomUtil;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("test")
public class Test {
    private static final Logger logger = LoggerFactory.getLogger(Test.class);

    @ResponseBody
    @RequestMapping("getName")
    public String getName(){
        logger.info("Current Time: {}", System.currentTimeMillis());
        logger.info("Current Time: " + System.currentTimeMillis());
        logger.info("Current Time: {}", System.currentTimeMillis());
        logger.trace("trace log");
        logger.warn("warn log");
        logger.debug("debug log");
        logger.info("info log");
        logger.error("error log");
        return RandomUtil.queryName();
    }

}

输出:

2021-01-14 20:35:24.664 [http-nio-8080-exec-2] INFO  com.example.controller.Test - Current Time: 1610627724664
2021-01-14 20:35:24.665 [http-nio-8080-exec-2] INFO  com.example.controller.Test - Current Time: 1610627724664
2021-01-14 20:35:24.665 [http-nio-8080-exec-2] INFO  com.example.controller.Test - Current Time: 1610627724665
2021-01-14 20:35:24.665 [http-nio-8080-exec-2] WARN  com.example.controller.Test - warn log
2021-01-14 20:35:24.665 [http-nio-8080-exec-2] INFO  com.example.controller.Test - info log
2021-01-14 20:35:24.665 [http-nio-8080-exec-2] ERROR com.example.controller.Test - error log

五. debug、info、warn、error、fatal的区别

Debug:(尽量不要使用debug,日志输出太多,会减慢服务启动速度,也不利于日志阅读)
  • 级别最低,一般的来说,在系统实际运行过程中,一般都是不输出的,因此这个级别的信息,可以随意的使用,任何觉得有利于在调试时更详细的了解系统运行状态的东东,比如变量的值等等,都输出来看看也无妨,当然,在每一个 Debug 调用之前,一定要加上 If 判断。
Info:(一般用在开发时使用)
  • 这个用来反馈系统的当前状态给最终用户的,所以,在这里输出的信息,对最终用户具有实际意义,从某种角度上说,Info 输出的信息可以看作是软件产品的一部分。
Warn:
  • 警告,应该是这个时候进行一些修复性的工作,应该还可以把系统恢复到正常状态中来,系统应该可以继续运行下去。
Error:(上线后使用)
  • 错误,就是说可以进行一些修复性的工作,但无法确定系统会正常的工作下去,系统在以后的某个阶段,很可能会因为当前的这个问题,导致一个无法修复的错误(例如宕机),但也可能一直工作到停止也不出现严重问题。
Fatal:
  • 严重错误,可以肯定这种错误已经无法修复,并且如果系统继续运行下去的话,可以肯定必然会越来越乱。这时候采取的最好的措施不是试图将系统状态恢复到正常,而是尽可能地保留系统有效数据并停止运行。