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都有效。未配置的狀況日誌下會輸出兩次。