Java Logger 使用總結

Java Logger 使用總結

• logger 背景知識
  • logback取代 log4j的理由: http://www.cnblogs.com/lixuwu/p/5804793.html
  • logback、log4j、log4j2三種日志框架性能檢測——為什么用log4j2 ： https://blog.csdn.net/qq_32250495/article/details/82382052
  • Log4j2的性能為什么這么好？：https://mp.weixin.qq.com/s/ZOkKxYAmRy950lsUcf9RuA
• Spring Boot 日志
  • Spring Boot 默認使用Logback作為日志記錄工具。日志默認輸出到控制台但也能輸出到文件中。我們通過spring-boot-starter-logging 加入Logback依賴，其實只要我們加入任意的Spring Boot starter 都會默認引入spring-boot-starter-logging，因此 我們不需要分開加入他們
  • 
  •  我們可以在application.properties或者application.yml中設置日志的級別、輸出的文件名、輸出路徑、定義console, file 中logging的樣式等。

logging.level.root= WARN
logging.level.org.springframework.security= DEBUG
logging.level.org.springframework.web= ERROR
logging.level.org.hibernate= DEBUG

logging.file = mylogfile.log 

logging.path = concretepage/logs  

logging.pattern.console= %d{yyyy-MMM-dd HH:mm:ss.SSS} %-5level [%thread] %logger{15} - %msg%n
logging.pattern.file= %d{yyyy-MMM-dd HH:mm:ss.SSS} %-5level [%thread] %logger{15} - %msg%n

• • 如果想使用XML配置Logback，則需要在 resources 路徑下創建 logback-spring.xml文件，如果Spring Boot使用了Log4j2 ，則需要創建 log4j2-spring.xml 。
  • Spring Boot 想使用Log4j2 ，則需要修改 Maven 依賴

<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-web</artifactId>
   <!--使用下面這個和上面排除spring-boot-starter-logging是一樣的效果-->
   <exclusions>
      <exclusion>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-logging</artifactId>
      </exclusion>
   </exclusions>
</dependency>
<!-- log4j2日志 -->
<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

使用 logstash-logback-encoder jar 包， 將 logback 日志傳給 logstash

<dependency>
  <groupId>net.logstash.logback</groupId>
  <artifactId>logstash-logback-encoder</artifactId>
  <version>4.11</version>
</dependency>

    <!-- logstash -->
    <appender name="stash" class="net.logstash.logback.appender.LogstashTcpSocketAppender">
        <destination>logstash.rongziidc.com:5046</destination>
        <!-- encoder is required -->
        <encoder class="net.logstash.logback.encoder.LogstashEncoder" >
            <customFields>{"project":"com.rongziidc.creditorv2","type":"javaLog"}</customFields>
            <timeZone>UTC+8</timeZone>
            <timestampPattern>yyyy-MM-dd HH:mm:ss.SSS</timestampPattern>
        </encoder>
        <connectionStrategy>
            <roundRobin>
                <connectionTTL>5 minutes</connectionTTL>
            </roundRobin>
        </connectionStrategy>
    </appender>

logback中動態獲取application中配置項 :

<springProperty scope="context" name="LOG_HOME" source="logback.file"/>

log4j 的使用

• 添加 Maven依賴 , 最新上傳 2012年5月

<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
</dependency>

配置log4j ， log4j.xml 配置詳解

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log4j:configuration PUBLIC "-//log4j/log4j Configuration//EN" "log4j.dtd">
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
    <!-- 日志輸出到控制台 -->
    <appender name="console" class="org.apache.log4j.ConsoleAppender">
        <!-- 日志輸出格式 -->
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="[%p][%d{yyyy-MM-dd HH:mm:ss SSS}][%c]-[%m]%n"/>
        </layout>
        <!--過濾器設置輸出的級別-->
        <filter class="org.apache.log4j.varia.LevelRangeFilter">
            <!-- 設置日志輸出的最小級別 -->
            <param name="levelMin" value="INFO"/>
            <!-- 設置日志輸出的最大級別 -->
            <param name="levelMax" value="ERROR"/>
        </filter>
    </appender>

    <!-- 輸出日志到文件 -->
    <appender name="fileAppender" class="org.apache.log4j.FileAppender">
        <!-- 輸出文件全路徑名-->
        <param name="File" value="/data/applogs/own/fileAppender.log"/>
        <!--是否在已存在的文件追加寫：默認時true，若為false則每次啟動都會刪除並重新新建文件-->
        <param name="Append" value="false"/>
        <param name="Threshold" value="INFO"/>
        <!--是否啟用緩存，默認false-->
        <param name="BufferedIO" value="false"/>
        <!--緩存大小，依賴上一個參數(bufferedIO), 默認緩存大小8K  -->
        <param name="BufferSize" value="512"/>
        <!-- 日志輸出格式 -->
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="[%p][%d{yyyy-MM-dd HH:mm:ss SSS}][%c]-[%m]%n"/>
        </layout>
    </appender>

    <!-- 輸出日志到文件，當文件大小達到一定閾值時，自動備份, FileAppender子類 -->
    <appender name="rollingAppender" class="org.apache.log4j.RollingFileAppender">
        <!-- 日志文件全路徑名 -->
        <param name="File" value="/data/applogs/RollingFileAppender.log" />
        <!--是否在已存在的文件追加寫：默認時true，若為false則每次啟動都會刪除並重新新建文件-->
        <param name="Append" value="true" />
        <!-- 保存備份日志的最大個數，默認值是：1  -->
        <param name="MaxBackupIndex" value="10" />
        <!-- 設置當日志文件達到此閾值的時候自動回滾，單位可以是KB，MB，GB，默認單位是KB，默認值是：10MB -->
        <param name="MaxFileSize" value="10KB" />
        <!-- 設置日志輸出的樣式 -->`
        <layout class="org.apache.log4j.PatternLayout">
            <!-- 日志輸出格式 -->
            <param name="ConversionPattern" value="[%d{yyyy-MM-dd HH:mm:ss:SSS}] [%-5p] [method:%l]%n%m%n%n" />
        </layout>
    </appender>

    <!-- 日志輸出到文件，可以配置多久產生一個新的日志信息文件 -->
    <appender name="dailyRollingAppender" class="org.apache.log4j.DailyRollingFileAppender">
        <!-- 文件文件全路徑名 -->
        <param name="File" value="/data/applogs/own/dailyRollingAppender.log"/>
        <param name="Append" value="true" />
        <!-- 設置日志備份頻率，默認：為每天一個日志文件 -->
        <param name="DatePattern" value="'.'yyyy-MM-dd'.log'" />
        <!--每分鍾一個備份-->
        <!--<param name="DatePattern" value="'.'yyyy-MM-dd-HH-mm'.log'" />-->
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="[%p][%d{HH:mm:ss SSS}][%c]-[%m]%n"/>
        </layout>
    </appender>

    <!--
        1. 指定logger的設置，additivity是否遵循缺省的繼承機制
        2. 當additivity="false"時，root中的配置就失靈了，不遵循缺省的繼承機制
        3. 代碼中使用Logger.getLogger("logTest")獲得此輸出器，且不會使用根輸出器
    -->
    <logger name="logTest" additivity="false">
        <level value ="INFO"/>
        <appender-ref ref="dailyRollingAppender"/>
    </logger>

    <!-- 根logger的設置，若代碼中未找到指定的logger，則會根據繼承機制，使用根logger-->
    <root>
        <appender-ref ref="console"/>
        <appender-ref ref="fileAppender"/>
        <appender-ref ref="rollingAppender"/>
        <appender-ref ref="dailyRollingAppender"/>
    </root>
</log4j:configuration>

使用 log4j

import org.apache.log4j.Logger;
import org.junit.Test;

public class Test {
    private static Logger log = Logger.getLogger("logTest");
    @Test
    public void testLog(){
        log.debug("debug");
        log.error("error");
    }
}

log4j2 的使用

• 添加 Maven 依賴

<dependency>
  <groupId>org.apache.logging.log4j</groupId>
  <artifactId>log4j-core</artifactId>
  <version>2.13.0</version>
</dependency>
<dependency>
  <groupId>org.apache.logging.log4j</groupId>
  <artifactId>log4j-api</artifactId>
  <version>2.13.0</version>
</dependency>

配置log4j2 ，log4j2.xml 配置詳解

<?xml version="1.0" encoding="UTF-8"?>

<!--日志級別以及優先級排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
<!--Configuration后面的status，這個用於設置log4j2自身內部的信息輸出，可以不設置，當設置成trace時，你會看到log4j2內部各種詳細輸出-->
<!--monitorInterval：Log4j能夠自動檢測修改配置 文件和重新配置本身，設置間隔秒數-->
<configuration status="WARN" monitorInterval="30">
    <!--Appenders節點，常見的有三種子節點:Console、RollingFile、File -->
    <appenders>
        <!--這個輸出控制台的配置-->
        <console name="Console" target="SYSTEM_OUT">
                 <!--輸出日志的格式-->
            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
        </console>

        <!--文件會打印出所有信息，這個log每次運行程序會自動清空，由append屬性決定，這個也挺有用的，適合臨時測試用-->
        <File name="log" fileName="log/test.log" append="false">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>
        </File>

        <!-- 這個會打印出所有的info及以下級別的信息，每次大小超過size，則這size大小的日志會自動存入按年份-月份建立的文件夾下面並進行壓縮，作為存檔-->
        <RollingFile name="RollingFileInfo" fileName="${sys:user.home}/logs/info.log" filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log">
            <!--控制台只輸出level及以上級別的信息（onMatch），其他的直接拒絕（onMismatch）-->       
            <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
            <Policies>
                 <TimeBasedTriggeringPolicy/>
                 <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
        </RollingFile>

        <RollingFile name="RollingFileWarn" fileName="${sys:user.home}/logs/warn.log" filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log">
            <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
            <Policies>
                 <TimeBasedTriggeringPolicy/>
                 <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
            <!-- DefaultRolloverStrategy屬性如不設置，則默認為最多同一文件夾下7個文件 -->
            <DefaultRolloverStrategy max="20"/>
        </RollingFile>

        <RollingFile name="RollingFileError" fileName="${sys:user.home}/logs/error.log" filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log">
            <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
            <Policies>
                 <TimeBasedTriggeringPolicy/>
                 <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
        </RollingFile>
     </appenders>

     <!--Loggers節點，常見的有兩種:Root和Logger.-->
     <!--然后定義logger，只有定義了logger並引入的appender，appender才會生效-->
     <loggers>
         <!--Logger節點用來單獨指定日志的形式，比如要為指定包下的class指定不同的日志級別等-->
         <logger name="org.springframework" level="INFO"></logger>
         <logger name="org.mybatis" level="INFO"></logger>
         <!--Root節點用來指定項目的根日志，如果沒有指定Logger，那么就會默認使用該Root日志輸出-->
         <root level="all">
             <appender-ref ref="Console"/>
             <appender-ref ref="RollingFileInfo"/>
             <appender-ref ref="RollingFileWarn"/>
             <appender-ref ref="RollingFileError"/>
         </root>
     </loggers>
</configuration>

使用 log4j2

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

private static Logger logger_ = LogManager.getLogger(DateUtils2Joda.class);

logback

• 添加 Maven依賴，logback-classic本身實現了SLF4J API

    <dependency>
        <groupId>ch.qos.logback</groupId>
        <artifactId>logback-classic</artifactId>
        <version>1.2.3</version>
    </dependency>

配置 logback ， logback.xml詳解

<?xml version="1.0" encoding="UTF-8"?>
<configuration>  
  <!-- 彩色日志 , 彩色日志依賴的渲染類 -->
  <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="${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} %replace(%caller{1}){'\t|Caller.{1}0|\r\n', ''} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}" />
  
  <property name="PROJECT_NAME" value="missyou_app_api"/>
    <property name="LOG_HOME" value="/mnt/logs/" />
  
  <!-- 控制台打印日志的相關配置 --> 
  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> 
    <!-- 日志格式 -->
    <encoder>
            <pattern>${CONSOLE_LOG_PATTERN}</pattern>
        <!--解決亂碼問題 -->
        <charset>utf8</charset>
    </encoder>
  </appender>

    <appender name="infoLogFile" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 過濾掉ERROR日志 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>DENY</onMatch>
            <onMismatch>ACCEPT</onMismatch>
        </filter>
        <encoder>
            <charset>UTF-8</charset>
            <pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%thread] %-5level %logger{36}: %msg%n</pattern>
        </encoder>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_HOME}/info.%d{yyyy-MM-dd}.log</fileNamePattern>
            <maxHistory>30</maxHistory><!--保存最近30天的日志 -->
        </rollingPolicy>
    </appender>
 
    <appender name="errorLogFile" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- ThresholdFilter:臨界值過濾器，過濾掉 TRACE 和 DEBUG 級別的日志 -->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>error</level>
        </filter>
        <encoder>
            <charset>UTF-8</charset>
            <pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%thread] %-5level %logger{36}: %msg%n</pattern>
        </encoder>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_HOME}/error.%d{yyyy-MM-dd}.log
            </fileNamePattern>
            <maxHistory>30</maxHistory><!--保存最近30天的日志 -->
        </rollingPolicy>
    </appender>

  <logger name="org.hibernate.SQL" level="DEBUG" />
  <!--SpringBoot去掉CONDITIONS EVALUATION REPORT https://blog.csdn.net/YooFale/article/details/84871618-->
  <logger name="org.springframework.boot.autoconfigure" level="error"/>
  
  <!-- 基於dubug處理日志：具體控制台或者文件對日志級別的處理還要看所在appender配置的filter，如果沒有配置filter，則使用root配置 -->
  <root level="info">
    <appender-ref ref="STDOUT" />
    <appender-ref ref="infoLogFile" />
    <appender-ref ref="errorLogFile" />
  </root>
</configuration>

使用 logback

private static Logger logging = LoggerFactory.getLogger(TestController.class);
 
@RequestMapping("/testLogger")
public void testLogger(int id, String name) {
    logging.info("id:{}, name:{}",id,name);
}

slf4j （Simple Logging Facade for Java）

slf4j 背景知識 官方文檔 ， github

slf4j 主要是為了給Java日志提供一個標准、規范的API，意義在於提供接口，具體實現交由其他日志框架
slf4j 使得應用程序可以在運行時選擇綁定到一個特定的日志框架（如：java.util.logging、Log4j、 Logback），這通過在應用程序的類路徑中添加對應的日志框架來實現。如果在類路徑中配置的日志框架不可用，抽象層就會立刻取消調用日志的相應邏輯
阿里巴巴Java開發手冊中提出：應用中不可直接使用日志系統（Log4j、Logback）中的 API，而應依賴SLF4J 中的 API，使用門面模式的日志框架，有利於維護和各個類的日志處理方式統一
添加 Maven 依賴

<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.2</version>
</dependency>
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-log4j12</artifactId>
    <version>1.7.2</version>
</dependency>

配置log4j ，xml配置，可以參見log4j 部分

### 設置###
log4j.rootLogger = debug,stdout,D,E

### 輸出信息到控制抬 ###
log4j.appender.stdout = org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target = System.out
log4j.appender.stdout.layout = org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern = [%-5p] %d{yyyy-MM-dd HH:mm:ss,SSS} method:%l%n%m%n

### 輸出DEBUG 級別以上的日志到=E://logs/error.log ###
log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
log4j.appender.D.File = D://logs/log.log
log4j.appender.D.Append = true
log4j.appender.D.Threshold = DEBUG
log4j.appender.D.layout = org.apache.log4j.PatternLayout
log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

### 輸出ERROR 級別以上的日志到=E://logs/error.log ###
log4j.appender.E = org.apache.log4j.DailyRollingFileAppender
log4j.appender.E.File =D://logs/error.log
log4j.appender.E.Append = true
log4j.appender.E.Threshold = ERROR
log4j.appender.E.layout = org.apache.log4j.PatternLayout
log4j.appender.E.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

ava測試類 : 直接使用的是 org.slf4j.Logger ，而不是log4j

package test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class Log4jTestDemo {
    private static Logger logger = LoggerFactory.getLogger(Log4jTestDemo.class);

    public static void main(String[] args) {
        // 記錄debug級別的信息
        logger.debug("This is debug message.");
        // 記錄info級別的信息
        logger.info("This is info message.");
        // 記錄error級別的信息
        logger.error("This is error message.");
    }
}