SpringBoot日志框架使用指南

市面上常见的日志框架有很多,比如:JCL、SLF4J、Jboss-logging、jUL、log4j、log4j2、logback等等
通常情况下,日志是由一个抽象层+实现层组合使用的

抽象层实现层
JCL、SLF4J、jboss-loggingjul、log4j、log4j2、logback

Spring默认使用 JCL,所以以前的项目大多要依赖 commons-logging.jar
有一位牛人定义了日志抽象层 SLF4J,也对抽象进行了实现,它就是 log4j,后面再次改进了实现层,命名为logback

SpringBoot默认使用 slf4j + logback的方式记录日志,slf4j的官网地址:http://www.slf4j.org/ ,里面有文档,以及和其他日志框架统一整合的使用方法

1.创建SpringBoot项目,引入web和logging依赖
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-logging</artifactId>
</dependency>

通过idea右侧maven展开,spring-boot-starter-logging可以看到里面依赖了 slf4j + logback
在这里插入图片描述
此时启动项目就能看到控制台打印的日志

可以在 application.properties 中配置日志等级参数来控制输出的日志信息,如:
# 那么只有info 、warn、error这3种等级的日志才会输出
logging.level=info

# 或者通过设置指定package下的日志等级
# 如指定 com.zypcy.controller 下的日志等级是info
logging.level.com.zypcy.controller=info
还可以根据application-test.yml、application-prod.yml 不同配置文件设置不同的日志输出等级,来控制开发、测试环境打印日志,,生成环境只答应error日志

 

2.把日志写到本地目录

在项目 resources 目录下添加 logback.xml 或 logback-spring.xml ,推荐使用 logback-spring.xml,内容如下,异步输出日志,批量打包压缩都是提高日志记录性能的关键:

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false" scan="false">
    <springProperty scop="context" name="spring.application.name" source="spring.application.name" defaultValue=""/>
    <!-- 日志路径,当前项目 logs/ 下-->
    <property name="log.path" value="logs/${spring.application.name}" />
    <!-- 日志等级 -->
    <property name="log.level" value="INFO"/>

    <!-- 控制台日志输出 -->
    <!-- 彩色日志格式 -->
    <property name="CONSOLE_LOG_PATTERN"
              value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}" />
    <!-- 彩色日志依赖的渲染类 -->
    <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" />
    <conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" />
    <conversionRule conversionWord="wEx" converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" />
    <!-- 控制台日志输出 -->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${CONSOLE_LOG_PATTERN}</pattern>
            <charset>utf8</charset>
        </encoder>
    </appender>

    <!-- Log file info output -->
    <appender name="info" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${log.path}/info.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>${log.path}/%d{yyyy-MM-dd}/info/info-%d{yyyy-MM-dd}-%i.log.gz</fileNamePattern>
            <maxFileSize>50MB</maxFileSize>
            <maxHistory>30</maxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>%date [%thread] %-5level [%logger{50}] %file:%line - %msg%n</pattern>
        </encoder>
    </appender>

    <!-- Log file error output -->
    <appender name="error" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${log.path}/error.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>${log.path}/%d{yyyy-MM-dd}/error/error-%d{yyyy-MM-dd}-%i.log.gz</fileNamePattern>
            <maxFileSize>50MB</maxFileSize>
            <maxHistory>30</maxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>%date [%thread] %-5level [%logger{50}] %file:%line - %msg%n</pattern>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>ERROR</level>
        </filter>
    </appender>


    <!-- 异步输出,异步的log片段必须在同步段后面,否则不起作用 -->
    <appender name="FILE-INFO-ASYNC" class="ch.qos.logback.classic.AsyncAppender">
        <discardingThreshold>0</discardingThreshold>
        <queueSize>10000</queueSize>
        <appender-ref ref="info"/>
    </appender>
    <appender name="FILE-ERROR-ASYNC" class="ch.qos.logback.classic.AsyncAppender">
        <discardingThreshold>0</discardingThreshold>
        <queueSize>512</queueSize>
        <appender-ref ref="error"/>
    </appender>


    <!-- Level: FATAL 0  ERROR 3  WARN 4  INFO 6  DEBUG 7 -->
    <root level="${log.level}">
        <appender-ref ref="console"/>
        <appender-ref ref="FILE-INFO-ASYNC"/>
        <appender-ref ref="FILE-ERROR-ASYNC"/>
    </root>
</configuration>

再次运行项目后,可以在项目下看到 logs 文件夹和其中的日志文件
在这里插入图片描述

已标记关键词 清除标记
相关推荐
©️2020 CSDN 皮肤主题: Age of Ai 设计师:meimeiellie 返回首页