SpringBoot（七）：日志logback使用

一、概述

• 使用spring profile配置多环境下日志级别。
• spring-boot默认配置位于org.springframework.boot.logging.logback包下base.xml。
• 包括mybatis在控制台打印SQL。

参考资料：springboot中使用logback

 

二、流程

1. resources下加入logback-spring.xml：

   <?xml version="1.0" encoding="UTF-8"?>
   <!--
   scan：当此属性设置为true时，配置文件若是发生改变，将会被从新加载，默认值为true。
   scanPeriod：设置监测配置文件是否有修改的时间间隔，若是没有给出时间单位，默认单位是毫秒当scan为true时，此属性生效。默认的时间间隔为1分钟。
   debug：当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。
   -->
   <configuration scan="false" scanPeriod="60 seconds" debug="false">
       <!-- 定义日志的根目录 -->
       <property name="LOG_HOME" value="E:/logs" />
       <!-- 定义日志文件名称 -->
       <property name="appName" value="spring-boot-demos"></property>
       <!-- ch.qos.logback.core.ConsoleAppender 表示控制台输出 -->
       <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
           <!--
           日志输出格式：%d表示日期时间，%thread表示线程名，%-5level：级别从左显示5个字符宽度
           %logger{50} 表示logger名字最长50个字符，不然按照句点分割。 %msg：日志消息，%n是换行符
           -->
           <layout class="ch.qos.logback.classic.PatternLayout">
               <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n</pattern>
           </layout>
       </appender>
   
       <!-- 滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其余文件 -->
       <appender name="fileLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
           <!-- 指定日志文件的名称 -->
           <file>${LOG_HOME}/${appName}.log</file>
           <!--
           当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名
           TimeBasedRollingPolicy： 最经常使用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。
           -->
           <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
               <!--
               滚动时产生的文件的存放位置及文件名称 %d{yyyy-MM-dd}：按天进行日志滚动
               %i：当文件大小超过maxFileSize时，按照i进行文件滚动
               -->
               <fileNamePattern>${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
               <!--
               可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置天天滚动，
               且maxHistory是365，则只保存最近365天的文件，删除以前的旧文件。注意，删除旧文件是，
               那些为了归档而建立的目录也会被删除。
               -->
               <MaxHistory>365</MaxHistory>
               <!--
               当日志文件超过maxFileSize指定的大小是，根据上面提到的%i进行日志文件滚动 注意此处配置SizeBasedTriggeringPolicy是没法实现按文件大小进行滚动的，必须配置timeBasedFileNamingAndTriggeringPolicy
               -->
               <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                   <maxFileSize>50MB</maxFileSize>
               </timeBasedFileNamingAndTriggeringPolicy>
           </rollingPolicy>
           <!--
           日志输出格式：%d表示日期时间，%thread表示线程名，%-5level：级别从左显示5个字符宽度 %logger{50} 表示logger名字最长50个字符，不然按照句点分割。 %msg：日志消息，%n是换行符
           -->
           <layout class="ch.qos.logback.classic.PatternLayout">
               <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n</pattern>
           </layout>
       </appender>
   
   
       <!--开发、测试环境日志输出级别-->
       <springProfile name="dev,test">
           <root level="INFO">
               <appender-ref ref="console" />
               <appender-ref ref="fileLogAppender" />
           </root>
   
           <!--用于mybatis打印SQL-->
           <logger name="com.ss.quickStart.dao" level="DEBUG" additivity="false">
               <appender-ref ref="console" />
           </logger>
       </springProfile>
   
       <!--生产环境日志输出级别-->
       <springProfile name="pro">
           <root level="WARN">
               <appender-ref ref="console" />
               <appender-ref ref="fileLogAppender" />
           </root>
       </springProfile>
   </configuration>

2. application.properties:设置项目环境

spring.profiles.active=dev

 

三、测试

package com.ss.quickStart.web;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class LoggerController  {
    private static final Logger LOGGER = LoggerFactory.getLogger(LoggerController.class);
    @RequestMapping("log")
    public Boolean log(){
        LOGGER.trace("trace日志记录");
        LOGGER.debug("debug日志记录");
        LOGGER.info("info日志记录");
        LOGGER.warn("warn日志记录");
        LOGGER.error("error日志记录");
        return true;
    }
}

http://localhost:8080/log

使用项目环境配置为dev时，日志为info级别，控制台输出：

2017-08-28 17:58:19.348 [ http-nio-8080-exec-5 ] - [ INFO  ] [ com.ss.quickStart.web.LoggerController : 15 ] - info日志记录
2017-08-28 17:58:19.349 [ http-nio-8080-exec-5 ] - [ WARN  ] [ com.ss.quickStart.web.LoggerController : 16 ] - warn日志记录
2017-08-28 17:58:19.349 [ http-nio-8080-exec-5 ] - [ ERROR ] [ com.ss.quickStart.web.LoggerController : 17 ] - error日志记录

 

http://localhost:8080/user/qryUserOrders.do?userId=1

2017-08-28 18:01:19.598 [ http-nio-8080-exec-7 ] - [ DEBUG ] [ c.ss.quickStart.dao.UserMapper.selectByPrimaryKey : 145 ] - ==>  Preparing: SELECT id,name,sex FROM user WHERE id = ? 
2017-08-28 18:01:19.600 [ http-nio-8080-exec-7 ] - [ DEBUG ] [ c.ss.quickStart.dao.UserMapper.selectByPrimaryKey : 145 ] - ==> Parameters: 1(Long)
2017-08-28 18:01:19.602 [ http-nio-8080-exec-7 ] - [ DEBUG ] [ c.ss.quickStart.dao.UserMapper.selectByPrimaryKey : 145 ] - <==      Total: 1
2017-08-28 18:01:19.605 [ http-nio-8080-exec-7 ] - [ DEBUG ] [ c.s.q.dao.OrderMapper.selectByCondition_COUNT : 145 ] - ==>  Preparing: SELECT count(0) FROM t_order WHERE (user_id = ?) 
2017-08-28 18:01:19.606 [ http-nio-8080-exec-7 ] - [ DEBUG ] [ c.s.q.dao.OrderMapper.selectByCondition_COUNT : 145 ] - ==> Parameters: 1(Long)
2017-08-28 18:01:19.607 [ http-nio-8080-exec-7 ] - [ DEBUG ] [ c.s.q.dao.OrderMapper.selectByCondition_COUNT : 145 ] - <==      Total: 1
2017-08-28 18:01:19.608 [ http-nio-8080-exec-7 ] - [ DEBUG ] [ c.ss.quickStart.dao.OrderMapper.selectByCondition : 145 ] - ==>  Preparing: SELECT id,user_id,order_money,order_time FROM t_order WHERE ( user_id = ? ) order by order_time desc LIMIT 2 
2017-08-28 18:01:19.608 [ http-nio-8080-exec-7 ] - [ DEBUG ] [ c.ss.quickStart.dao.OrderMapper.selectByCondition : 145 ] - ==> Parameters: 1(Long)
2017-08-28 18:01:19.610 [ http-nio-8080-exec-7 ] - [ DEBUG ] [ c.ss.quickStart.dao.OrderMapper.selectByCondition : 145 ] - <==      Total: 2

mybatis在打印SQL配置说明

<logger name="com.ss.quickStart.dao" level="DEBUG" additivity="false">
    <appender-ref ref="console" />
</logger>

name:对应工程mapper所在包路径

level:级别为debug

additivity：做用在于children-logger是否使用 rootLogger配置的appender进行输出，false：表示只用当前logger的appender-ref，true：表示当前logger的appender-ref和rootLogger的appender-ref都有效。未配置的状况日志下会输出两次。