1. 程式人生 > 其它 >IDEA專案搭建——使用slf4j和logback進行日誌記錄

IDEA專案搭建——使用slf4j和logback進行日誌記錄

技術標籤:javalogbackweb

一、簡介

java裡面日誌分為兩部分一個門面、一個實現,我們所熟知的SLF4j、Log4j、Log4j2、Logback的日誌元件slf4j是門面提供的統一的入口,具體實現由log4j、log4j2、logback來實現

log4j由於太老作者自己也不打算重構了所以放棄

log4j2是apach的一個專案很好,但支援上面略有欠缺所以放棄

logback是之前log4j的作者自己開源的一個新的log元件,做了大量的調整及優化,效能及使用性上都有很大的提高,再加上沉澱了很多年又完全實現了slf4j,所以被我們選中使用更多瞭解可以去它的官網http://logback.qos.ch

二、接入Log

在這裡插入圖片描述
修改pom.xml檔案,增加對slf4j和logback的引用,此處如果是引用了spring boot則不需要再引一下的jar包了,spring boot中已集成了這些包

<dependencies>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>1.7.25</version>
</dependency> <dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-core</artifactId> <version>1.2.3</version> </dependency> <dependency> <groupId>
ch.qos.logback</groupId> <artifactId>logback-classic</artifactId> <version>1.2.3</version> </dependency> </dependencies>

直接寫個main()函式作為啟動入口,建立resources資料夾存放靜態檔案

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class TestLog {
    static Logger logger = LoggerFactory.getLogger(TestLog.class);
    public static void main(String[] arge){
        logger.debug("taiyonghai debug");
        logger.info("taiyonghai info");
        logger.error("taiyonghai error");
        logger.warn("taiyonghai warn");
    }
}

新增一個application.yml或application.properties配置檔案均可,新增以下配置指明logback的配置xml路徑

logging:
 config = classpath:logback.xml

新增logback.xml檔案,用於做log的相關配置

<?xml version="1.0"?>

<!-- 屬性描述 scan:性設定為true時,配置檔案如果發生改變,將會被重新載入,預設值為true scanPeriod:設定監測配置檔案是否有修改的時間間隔,如果沒有給出時間單位,
預設單位是毫秒。當scan為true時,此屬性生效。預設的時間間隔為1分鐘。debug:當此屬性設定為true時,將打印出logback內部日誌資訊,實時檢視logback執行狀態。預設值為false。 -->
<configuration scan="true" scanPeriod="60 seconds" debug="false">
  <!-- 定義日誌檔案 輸入位置 -->
  <property name="logPath" value="D:/EMS/EMSServer/EMSServerLogs"/>
  <!-- 日誌最大的歷史 60天 -->
  <property name="maxHistory" value="60"/>

  <!-- 配置項, 通過此節點配置日誌輸出位置(控制檯、檔案、資料庫)、輸出格式等-->
  <!-- ConsoleAppender代表輸出到控制檯 -->
  <appender name="consoleLog" class="ch.qos.logback.core.ConsoleAppender">
      <!-- layout代表輸出格式 -->
      <layout class="ch.qos.logback.classic.PatternLayout">
          <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger -%msg%n</pattern>
      </layout>
  </appender>

  <!-- 日誌輸出檔案 -->
  <appender name="fileInfoLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
      <encoder>
          <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger -%msg%n</pattern>
      </encoder>
      <!-- 滾動記錄檔案,先將日誌記錄到指定檔案,當符合某個條件時,將日誌記錄到其他檔案 RollingFileAppender-->
      <!-- 滾動策略,它根據時間來制定滾動策略.既負責滾動也負責觸發滾動 -->
      <!--<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
           輸出路徑
          <fileNamePattern>${logPath}/info/%d.log</fileNamePattern>
          可選節點,控制保留的歸檔檔案的最大數量,超出數量就刪除舊檔案假設設定每個月滾動,且<maxHistory>是6,
          則只儲存最近6個月的檔案,刪除之前的舊檔案。注意,刪除舊檔案是,那些為了歸檔而建立的目錄也會被刪除
          <maxHistory>${maxHistory}</maxHistory>
      </rollingPolicy>-->
      <!--若要使用FixedWindowRollingPolicy,file屬性必需要有並且需要提前設定-->
      <file>${logPath}/EmsServer.log</file>
      <!-- 按照固定視窗模式生成日誌檔案,當檔案大於50MB時,生成新的日誌檔案。視窗大小是1到10,當儲存了10個歸檔檔案後,將覆蓋最早的日誌。   -->
      <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
          <fileNamePattern>${logPath}/EmsServers.%i.log.zip</fileNamePattern>
          <minIndex>1</minIndex>
          <maxIndex>10</maxIndex>
      </rollingPolicy>
      <!-- 檢視當前活動檔案的大小,如果超過指定大小會告知RollingFileAppender 觸發當前活動檔案滾動   -->
      <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
          <maxFileSize>5MB</maxFileSize>
      </triggeringPolicy>
  </appender>
  <!-- 特殊記錄Error日誌 -->
  <appender name="fileErrorLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
      <!-- 只記錄ERROR級別日誌,新增範圍過濾,可以將該型別的日誌特殊記錄到某個位置 -->
      <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
          <level>ERROR</level>
      </filter>
      <encoder>
          <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger -%msg%n</pattern>
      </encoder>
      <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
          <fileNamePattern>${logPath}/error/%d.log</fileNamePattern>
          <!-- 日誌最大的歷史 60天 -->
          <maxHistory>60</maxHistory>
      </rollingPolicy>
  </appender>

  <!-- 根節點,表名基本的日誌級別,裡面可以由多個appender規則 -->
  <!-- level="info"代表基礎日誌級別為info -->
  <root level="info">
      <!-- 引入控制檯輸出規則 -->
      <appender-ref ref="consoleLog"/>
      <appender-ref ref="fileInfoLog"/>
      <appender-ref ref="fileErrorLog"/>
  </root>

</configuration> 

執行就可以看到日誌輸出到控制檯及檔案中了
在這裡插入圖片描述在這裡插入圖片描述

發現沒有了debug日誌的輸出,那是因為root節點中我們記錄的日誌級別是info,他就只會記錄等於或高於info級別的日誌,其他的都忽略避免生產環境產生過多日誌,這裡只是快速上手,還有很多配置翻看文件吧

注:本文中使用的FixedWindowRollingPolicy標籤需要配置file屬性,若無file屬性會報錯:
The File name property must be set before using this rolling policy.

logback更多資訊檢視:http://logback.qos.ch/codes.html

本文參考:IDEA專案搭建十——使用slf4j和logback進行日誌記錄