【SpringBoot】项目集成logback实现服务器日志文件输出

【SpringBoot】项目集成logback实现服务器日志文件输出

参考文档：【SpringBoot】【log】自定义logback日志配置

常规配置

对于SpringBoot项目，可以通过集成 logback ，来实现对日志分级的输入。

• 对日志分类、分级别输出到不同的日志文件
• 对日志实现智能分割输出，按时间、大小进行切割，避免一个文件无限制增大

参考：附件-logback-spring.xml

mybatis-plus

配置日志实现类

mybatis-plus在对sql日志打印的时候，需要配置日志级别为DEBUG才能正常打印，不同的日志实现类，
实现的结果不同：

• org.apache.ibatis.logging.stdout.StdOutImpl：只在控制台打印，核心使用的是System.out()
• org.apache.ibatis.logging.slf4j.Slf4jImpl: 使用 slf4j框架，可以在输出到日志文件中

# mybatis
mybatis:
  mapper-locations: classpath:mybatis/*/*.xml,mybatis/*.xml
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

# mybatis-plus
mybatis-plus:
  mapper-locations: classpath:mybatis/*/*.xml,mybatis/*.xml
  configuration:
    # 在控制台打印
#    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
    # 在日志文件中打印
    log-impl: org.apache.ibatis.logging.slf4j.Slf4jImpl

配置日志级别

# 日志配置
logging:
  level:
    web: INFO
    root: INFO
    sql: DEBUG
    # 配置Mapper所在包日志级别为 DEBUG
    com:
        baomidou：
            mybatisplus：DEBUG
        xxx:
            mapper: DEBUG

附件

logback-spring.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!-- 环境配置 -->
    <!-- root日志级别-->
    <springProperty scope="context" name="rootLevel" source="logging.level.root" defaultValue="INFO"/>
    <!-- sql日志级别-->
    <springProperty scope="context" name="sqlLevel" source="logging.level.sql" defaultValue="INFO"/>

    <!--用来定义变量值的标签-->
    <!-- 日志文件名称 -->
    <property name="APP_NAME" value="sharedGreen"/>
    <!-- 日志跟目录 -->
    <property name="LOG_HOME" value="./logs"/>
    <!-- 日志文件编码 -->
    <property name="encoding" value="UTF-8"/>
    <!-- 文件大小，默认为10MB-->
    <property name="maxFileSize" value="64MB"/>
    <!-- 配置日志的滚动时间，保存时间为60天-->
    <property name="maxHistory" value="60"/>
    <!--用来指定日志文件的上限大小，超过这个上限，开始删除旧日志-->
    <property name="totalSizeCap" value="16GB"/>


    <!-- 彩色日志依赖的渲染类 -->
    <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"/>

    <!--彩色日志输出格式-->
    <property name="CONSOLE_LOG_PATTERN"
              value="%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(%level){blue} %clr(${PID}){magenta} %clr([%thread]){orange} %clr(%logger){cyan} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}"/>

    <!--控制台输出格式：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
    <property name="console-pattern"
              value="%clr(%d{${LOG_DATEFORMAT_PATTERN:-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}"/>

    <!--非彩色日志输出格式:%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度；%M:%L是方法和行号；%msg是日志消息；%n是换行符-->
    <property name="normal-pattern"
              value="%d{yyyy-MM-dd HH:mm:ss.SSS}|%X{localIp}|%X{requestId}|%X{requestSeq}|%X{country}|%X{deviceType}|%X{deviceId}|%X{userId}|^_^|[%t] %-5level %logger{50} %line - %m%n"/>
    <property name="logger-pattern"
              value="%d{yyyy-MM-dd HH:mm:ss} [%-5level] [%-5thread] [%X{request.url}] %logger{36} - %msg%n"/>
    <property name="jdbc-pattern"
              value="%d{yyyy-MM-dd HH:mm:ss} [%-5level] [%-5thread] [%X{request.url}] %logger{36} - %msg%n"/>


    <!--控制台输出-->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出-->
            <pattern>${console-pattern}</pattern>
        </encoder>
    </appender>

    <!-- 按照每天生成日志文件 -->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--日志文件输出的文件名-->
        <file>${LOG_HOME}/${APP_NAME}_stdout.log</file>
        <Append>true</Append>
        <prudent>false</prudent>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${logger-pattern}</pattern>
            <charset>${encoding}</charset>
        </encoder>
        <!--按时间和大小分割-->
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <!--文件名称-->
            <fileNamePattern>${LOG_HOME}/${APP_NAME}_stdout_%d{yyyy-MM-dd}_%i.log</fileNamePattern>
            <!--单个文件大小-->
            <maxFileSize>${maxFileSize}</maxFileSize>
            <!--最大保留天数-->
            <maxHistory>${maxHistory}</maxHistory>
            <!--用来指定日志文件的上限大小，超过这个上限，开始删除旧日志-->
            <totalSizeCap>${totalSizeCap}</totalSizeCap>
        </rollingPolicy>
    </appender>

    <!-- log file error -->
    <appender name="FILE-ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>ERROR</level>
        </filter>
        <file>${LOG_HOME}/${APP_NAME}_stderr.log</file>
        <prudent>false</prudent>
        <Append>true</Append>
        <encoder>
            <pattern>${logger-pattern}</pattern>
            <charset>${encoding}</charset>
        </encoder>
        <!--根据时间和大小来输出日志-->
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <!--文件名称-->
            <fileNamePattern>${LOG_HOME}/${APP_NAME}_stderr_%d{yyyy-MM-dd}_%i.log</fileNamePattern>
            <!--单个文件大小-->
            <maxFileSize>${maxFileSize}</maxFileSize>
            <!--最大保留天数-->
            <maxHistory>${maxHistory}</maxHistory>
            <!--用来指定日志文件的上限大小，超过这个上限，开始删除旧日志-->
            <totalSizeCap>${totalSizeCap}</totalSizeCap>
        </rollingPolicy>
    </appender>

    <!-- 默认jdbc日志输出文件 -->
    <appender name="FILE-JDBC" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 集群部署日志名建议加上ip和port -->
        <File>${LOG_HOME}/${APP_NAME}_jdbc.log</File>
        <!--<File>${LOG_HOME}/${APP_NAME}_jdbc_${IP}_${PORT}.log</File>-->
        <encoder>
            <pattern>${jdbc-pattern}</pattern>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>${sqlLevel}</level>
        </filter>
        <append>true</append>
        <!--根据时间来输出日志-->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--文件名称-->
            <fileNamePattern>${LOG_HOME}/${APP_NAME}_jdbc_%d{yyyy-MM-dd}.log</fileNamePattern>
            <!--<fileNamePattern>${LOG_HOME}/${APP_NAME}_jdbc_%d{yyyy-MM-dd}_${IP}_${PORT}.log</fileNamePattern>-->
            <maxHistory>30</maxHistory>
        </rollingPolicy>
    </appender>


    <!-- rest template logger-->
    <logger name="org.springframework.web.client.RestTemplate" level="DEBUG"/>
    <logger name="org.springframework" level="DEBUG"/>


    <!-- jdbc-->
    <logger name="jdbc.sqltiming" level="DEBUG"/>
    <logger name="org.mybatis" level="DEBUG"/>

    <!-- show parameters for ibatis sql 专为 ibatis 定制 -->
    <logger name="com.ibatis" level="DEBUG"/>
    <logger name="com.ibatis.common.jdbc.SimpleDataSource" level="DEBUG"/>
    <logger name="com.ibatis.common.jdbc.ScriptRunner" level="DEBUG"/>
    <logger name="com.ibatis.sqlmap.engine.impl.SqlMapClientDelegate" level="DEBUG"/>
    <logger name="java.sql.Connection" level="DEBUG"/>
    <logger name="java.sql.Statement" level="DEBUG"/>
    <logger name="java.sql.PreparedStatement" level="DEBUG"/>
    <logger name="java.sql.ResultSet" level="DEBUG"/>

 	<!-- 指定 mapper 日志级别，DEBUG才会输出到日志文件中 -->
    <logger name="com.qingyan.sharedgreen.bussiness.mapper" level="${sqlLevel}">
        <appender-ref ref="FILE-JDBC"/>
    </logger>

    <!-- 项目日志 -->
    <logger name="com.qingyan" level="${rootLevel}"/>

    <!--开发环境:打印控制台-->
    <springProfile name="dev">
        <!-- 日志输出级别 -->
        <root leve="${rootLevel}">
            <appender-ref ref="STDOUT"/>
            <appender-ref ref="FILE"/>
            <appender-ref ref="FILE-ERROR"/>
        </root>
    </springProfile>

    <!--生产环境:输出到文件-->
    <springProfile name="pro">
        <!-- 日志输出级别 -->
        <root leve="${rootLevel}">
            <appender-ref ref="FILE"/>
            <appender-ref ref="FILE-ERROR"/>
        </root>
    </springProfile>

</configuration>