日誌框架學習

code 發表於 2022-01-28
框架

一、日誌框架介紹

1、概述

對於一個應用程式來說日誌記錄是必不可少的一部分,線上問題追蹤,基於日誌的業務邏輯統計分析等都離不日誌記錄。

2、常見日誌框架

  • Log4j:Apache Log4j是一個基於Java的日誌記錄工具。它是由Ceki Gülcü首創的,現在是apache軟體基金會的一個專案。
  • Log4j2:Apache Log4j 2是apache開發的一款Log4j的升級產品。
  • Logback:當前比較流行的日誌框架,出自log4j作者,比log4j效能有顯著提高。
  • JUL:Java Util Logging,自Java1.4以來的官方日誌實現。
  • Slf4j:Simple Logging Facade for Java,是一套簡易Java日誌門面,本身並無日誌的實現。
  • Commons Logging:apache基金會所屬的專案,是一套Java日誌介面,之前叫Jakarta Commons Logging,後更名為Commons Logging。

3、日誌框架劃分

日誌門面:Slf4j、JCL(Commons Logging)
日誌實現:Log4j、Log4j2、Logback、JUL

二、SLF4j簡單使用

以Slf4j+Logback為例。

1、依賴

<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.21</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>

2、配置

logback.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!--定義日誌檔案的儲存地址 勿在 LogBack 的配置中使用相對路徑 -->
    <property name="LOG_HOME" value="/logs" />
    <!-- 控制檯輸出 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化輸出:%d表示日期,%thread表示執行緒名,%-5level:級別從左顯示5個字元寬度%msg:日誌訊息,%n是換行符 -->
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{50} -%msg%n</pattern>
        </encoder>
    </appender>
    <!-- 按照每天生成日誌檔案 -->
    <appender name="FILE"
              class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日誌檔案輸出的檔名 -->
            <FileNamePattern>${LOG_HOME}/mallweb.log.%d{yyyy-MM-dd}.log</FileNamePattern>
            <!--日誌檔案保留天數 -->
            <MaxHistory>30</MaxHistory>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化輸出:%d表示日期,%thread表示執行緒名,%-5level:級別從左顯示5個字元寬度%msg:日誌訊息,%n是換行符 -->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} -
                %msg%n</pattern>
        </encoder>
        <!--日誌檔案最大的大小 -->
        <triggeringPolicy
                class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <MaxFileSize>10MB</MaxFileSize>
        </triggeringPolicy>
    </appender>


    <logger name="com.xwtech.mnoframework" level="debug" />
    <logger name="org.springframework" level="INFO" />
    <logger name="com.alibaba.druid" level="INFO" />


    <!--myibatis log configure -->
    <logger name="org.apache.ibatis" level="debug" />
    <logger name="java.sql.Connection" level="INFO" />
    <logger name="java.sql.Statement" level="INFO" />
    <logger name="java.sql.PreparedStatement" level="INFO" />


    <logger name="log4j.logger.net" level="ERROR"/>
    <logger name="log4j.logger.net.spy.memcached.transcoders.SerializingTranscoder" level="ERROR"/>


    <!-- 日誌輸出級別 -->
    <root level="INFO">
        <appender-ref ref="STDOUT" />
        <appender-ref ref="FILE" />
    </root>
</configurati

3、測試

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations = {"classpath:applicationContext.xml"})
public class LogTest {

    private static Logger logger = LoggerFactory.getLogger(LogTest.class);

    @Test
    public void test() {
        logger.error("error");
        logger.debug("debug");
        logger.info("info");
        logger.trace("trace");
        logger.warn("warn");
    } 
}

三、SLF4j與常見日誌框架的整合

image

        <!-- 整合其它日誌框架-->
        <!-- slf4j + log4j -->
        <!-- 其中包含了log4j實現,可以不用再引入實現 -->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-log4j12</artifactId>
            <version>1.7.21</version>
        </dependency>


        <!-- log4j -->
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.16</version>
        </dependency>


        <!-- slf4j + log4j2 -->
        <!-- log42 -->
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-core</artifactId>
            <version>2.12.1</version>
        </dependency>
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-api</artifactId>
            <version>2.12.1</version>
        </dependency>


        <!-- slf4j + java.util.logging -->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-jdk14</artifactId>
            <version>1.7.21</version>
        </dependency>


        <!-- slf4j + jboss-logging -->
        <dependency>
            <groupId>org.jboss.slf4j</groupId>
            <artifactId>slf4j-jboss-logging</artifactId>
            <version>1.2.0.Final</version>
        </dependency>


        <!-- slf4j + logback -->
        <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>
        </dependen

四、如何做到統一使用SLF4j進行日誌輸出

image

        <!-- 統一日誌輸出 -->
        <!-- log4j委託給slf4j -->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>log4j-over-slf4j</artifactId>
            <version>1.7.21</version>
        </dependency>


        <!-- log4j2委託給slf4j -->
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-to-slf4j</artifactId>
            <version>2.9.1</version>
        </dependency>


        <!-- java.util.logging委託給slf4j -->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>jul-to-slf4j</artifactId>
            <version>1.7.21</version>
        </dependency>


        <!-- 替換org.apache.commons.logging,門面交給slf4j -->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>jcl-over-slf4j</artifactId>
            <version>1.7.21</version>
        </dependenc

五、常見問題

1、沒有日誌實現

image

2、多日誌實現

image

3、棧溢位

如果clappsth中既有橋接器也有介面卡,日誌會被踢來踢去,陷入死迴圈
image

六、開發手冊中日誌規約

image