日志框架

日志框架就是為了更好的記錄日志使用的，記錄日志是為了我們在工作中可以更好的查找相對應的問題，也算是以中留痕操作！

以前我們剛開始學習的時候都是用System.out.println()去在控制臺記錄，怎么說呢？這種方式伴隨著我們很長時間，之后我們就遇到了斷點調試的方式，逐漸不在使用System.out.println()進行調試，但是你別忘記，那是一種記錄不管是否有用，你都應該去記錄！

市面上的日志框架；JUL、JCL、Jboss-logging、logback、log4j、log4j2、slf4j....

日志門面（日志的抽象層）	日志實現
~~JCL（Jakarta Commons Logging）~~ SLF4j（Simple Logging Facade for Java） ~~jboss-logging~~	Log4j JUL（java.util.logging） Log4j2 Logback

SpringBoot：底層是Spring框架，Spring框架默認是用JCL；‘

? <==SpringBoot選用 SLF4j和logback；==>

1.SLF4j使用

1.1 如何在系統中使用SLF4j

SLF4J的官方網站手冊

以后開發的時候，日志記錄方法的調用，不應該來直接調用日志的實現類，而是調用日志抽象層里面的方法；

給系統里面導入slf4j的jar和 logback的實現jar

使用方式如下：

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

public class HelloWorld {
  public static void main(String[] args) {
    Logger logger = LoggerFactory.getLogger(HelloWorld.class);
    logger.info("Hello World");
  }
}

官方提供

每一個日志的實現框架都有自己的配置文件。使用slf4j以后，配置文件還是做成日志實現框架自己本身的配置文件；

1.2 歷史遺留問題

我們接觸過的框架使用的日志框架都有所不同，因此，統一日志記錄，即使是別的框架和我一起統一使用slf4j進行輸出？

官方提供

1.3 slf4j統一“天下”

將系統中其他日志框架先排除出去；
用中間包來替換原有的日志框架；
我們導入slf4j其他的實現；

2. Spring Boot 日志配置

SpringBoot使用它來做日志功能:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-logging</artifactId>
</dependency>

底層的依賴關系

SpringBoot底層也是使用slf4j+logback的方式進行日志記錄
SpringBoot也把其他的日志都替換成了slf4j

中間替換包？

@SuppressWarnings("rawtypes")
public abstract class LogFactory {

    static String UNSUPPORTED_OPERATION_IN_JCL_OVER_SLF4J = "http://www.slf4j.org/codes.html#unsupported_operation_in_jcl_over_slf4j";

    static LogFactory logFactory = new SLF4JLogFactory();

如果我們要引入其他框架？一定要把這個框架的默認日志依賴移除掉

示例：Spring框架用的是commons-logging；
```
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-core</artifactId>
    <exclusions>
        <exclusion>
            <groupId>commons-logging</groupId>
            <artifactId>commons-logging</artifactId>
        </exclusion>
    </exclusions>
</dependency>
```
pringBoot能自動適配所有的日志，而且底層使用slf4j+logback的方式記錄日志，引入其他框架的時候，只需要把這個框架依賴的日志框架排除掉即可；

3. 日志的使用

Spring Boot 默認給我們已經配置好了日志，測試如下：

//記錄器
Logger logger = LoggerFactory.getLogger(getClass());
@Test
public void contextLoads() {
    //System.out.println();

    //日志的級別；
    //由低到高   trace<debug<info<warn<error
    //可以調整輸出的日志級別；日志就只會在這個級別以以后的高級別生效
    logger.trace("這是trace日志...");
    logger.debug("這是debug日志...");
    //SpringBoot默認給我們使用的是info級別的，沒有指定級別的就用SpringBoot默認規定的級別；root級別
    logger.info("這是info日志...");
    logger.warn("這是warn日志...");
    logger.error("這是error日志...");
}

3.1 日志格式說明

 日志輸出格式：
     %d表示日期時間，
     %thread表示線程名，
     %-5level：級別從左顯示5個字符寬度
     %logger{50} 表示logger名字最長50個字符，否則按照句點分割。 
     %msg：日志消息，
     %n是換行符
 -->
 %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n

SpringBoot修改日志的默認配置

logging.level.com.hanpang=trace
# com.hanpang是說明的包名

#logging.path=
# 不指定路徑在當前項目下生成springboot.log日志
# 可以指定完整的路徑；
#logging.file=G:/springboot.log

# 在當前磁盤的根路徑下創建spring文件夾和里面的log文件夾；使用 spring.log 作為默認文件
logging.path=/spring/log

#  在控制臺輸出的日志的格式
logging.pattern.console=%d{yyyy-MM-dd} [%thread] %-5level %logger{50} - %msg%n
# 指定文件中日志輸出的格式
logging.pattern.file=%d{yyyy-MM-dd} === [%thread] === %-5level === %logger{50} ==== %msg%n

logging.file	logging.path	Example	Description
(none)	(none)		只在控制臺輸出
指定文件名	(none)	my.log	輸出日志到my.log文件
(none)	指定目錄	/var/log	輸出到指定目錄的 spring.log 文件中

3.2 指定配置

給類路徑下放上每個日志框架自己的配置文件即可，SpringBoot就不使用他默認配置的了

Logging System	Customization
Logback	`logback-spring.xml`, `logback-spring.groovy`, `logback.xml` or `logback.groovy`
Log4j2	`log4j2-spring.xml` or `log4j2.xml`
JDK (Java Util Logging)	`logging.properties`

logback.xml：直接就被日志框架識別了；一般情況不推薦

（推薦）logback-spring.xml：日志框架就不直接加載日志的配置項，由SpringBoot解析日志配置，可以使用SpringBoot的高級Profile功能

<springProfile name="staging">
    <!-- configuration to be enabled when the "staging" profile is active -->
      可以指定某段配置只在某個環境下生效
</springProfile>

示例代碼

<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
        <!--
        日志輸出格式：
          %d表示日期時間，
          %thread表示線程名，
          %-5level：級別從左顯示5個字符寬度
          %logger{50} 表示logger名字最長50個字符，否則按照句點分割。 
          %msg：日志消息，
          %n是換行符
        -->
        <layout class="ch.qos.logback.classic.PatternLayout">
            <springProfile name="dev">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ----> [%thread] ---> %-5level %logger{50} - %msg%n</pattern>
            </springProfile>
            <springProfile name="!dev">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ==== [%thread] ==== %-5level %logger{50} - %msg%n</pattern>
            </springProfile>
        </layout>
    </appender>

如果使用logback.xml作為日志配置文件，還要使用profile功能，會有以下錯誤:

no applicable action for [springProfile]

4. 切換日志框架

可以按照slf4j的日志適配圖，進行相關的切換；

slf4j+log4j的方式，pom.xml配置如下:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <exclusions>
        <exclusion>
            <artifactId>logback-classic</artifactId>
            <groupId>ch.qos.logback</groupId>
        </exclusion>
        <exclusion>
            <artifactId>log4j-over-slf4j</artifactId>
            <groupId>org.slf4j</groupId>
        </exclusion>
    </exclusions>
</dependency>

<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-log4j12</artifactId>
</dependency>

如果切換為log4j2，pom.xml配置如下：

log4j2配置的參考文章

log4j2的配置說明

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <exclusions>
        <exclusion>
            <artifactId>spring-boot-starter-logging</artifactId>
            <groupId>org.springframework.boot</groupId>
        </exclusion>
    </exclusions>
</dependency>

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

5.“坑”

logging.path和logging.file不可以同時配置,同時配置也只有logging.file起效
配置logging.path將會在指定文件夾下面生成spring.log文件,文件名字無法控制
配置logging.file,如果只是文件名如:demo.log只會在項目的根目錄下生成指定文件名的日志文件,,如果想控制日志路徑,可以選擇完整路徑，如:E:\demo\demo.log

接下來看看自定義配置文件,這個就要方便很多了,還是喜歡自定義配置文件的方式

在src/main/resources下面新建文件logback.xml這個也是spring boot默認的配置文件名,
如果需要自定義文件名,如:logback-test.xml需要在application.properties添加配置
================但是，我們習慣使用logback-spring.xml==========================
logging.config=classpath:logback-test.xml
spring boot默認載入的相關配置文件,詳見jar包;spring-boot-1.*.*.RELEASE.jar下面
org/springframework/boot/logging/logback/
詳細文件:

base.xml                //基礎包,引用了下面所有的配置文件
console-appender.xml    //控制臺輸出配置
defaults.xml            //默認的日志文件配置
file-appender.xml       //文件輸出配置

附錄

logback-spring.xml 配置說明

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    
    <!--定義日志文件的存儲地址 勿在 LogBack的配置中使用相對路徑 -->
    <property name="LOG_HOME" value="/tmp/log" />
 
    <!-- 控制臺輸出 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{30} - %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}/logs/smsismp.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{30} - %msg%n</pattern>
        </encoder>
        <!--日志文件最大的大小 -->
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <MaxFileSize>10MB</MaxFileSize>
        </triggeringPolicy>
    </appender>
     
    <!-- 日志輸出級別 -->
    <root level="INFO">
        <appender-ref ref="STDOUT" />
        <appender-ref ref="FILE" />
    </root>
 
    <!-- 定義各個包的詳細路徑，繼承root寶的值 -->
    <logger name="com.hry.spring.log" level="INFO" />
    <logger name="com.hry.spring" level="TRACE" />
    
    <!-- 此值由 application.properties的spring.profiles.active=dev指定-->
    <springProfile name="dev">
        <!--定義日志文件的存儲地址 勿在 LogBack 的配置中使用相對路徑 -->
        <property name="LOG_HOME" value="/tmp/log" />
        <logger name="org.springboot.sample" level="DEBUG" />
    </springProfile>
 
    <springProfile name="pro">
        <!--定義日志文件的存儲地址 勿在 LogBack 的配置中使用相對路徑 -->
        <property name="LOG_HOME" value="/home" />
        <logger name="org.springboot.sample2" level="INFO" />
    </springProfile>
    
</configuration>

部分說明

appender name="STDOUT": 日志打印到控制臺

appender name="FILE"： 日志按日打印到文件中，最多保留MaxHistory天，每個文件大水為MaxFileSize

encoder：定義輸出格式

<root level="INFO">： 定義根logger，通過appender-ref指定前方定義的appender

<logger name="com.hry.spring.log" level="INFO" />：在繼承root的logger上對com.hry.spring.log包日志作特殊處理

<springProfile name="dev">： 定義profile的值，只有特定profile的情況下，此間定義的內容才啟作用
application.properties 啟動dev配置信息 
    server.port=8080
    spring.profiles.active=dev
spring.profiles.active指定本次啟動的active的值是什么。本次是dev，則logback-spring.xml里<springProfile name="dev">的內容啟作用

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
 
@SpringBootApplication
public class LogApplication {
    private static final Logger log = LoggerFactory.getLogger(LogApplication.class);
    public static void main(String[] args) {
        String str1 = "string1";
        String str2 = "string2";
        log.info("Begin Start {}...{}", str1, str2);
        SpringApplication.run(LogApplication.class, args);
        log.info("Stop ...");
    }
}

logback-spring.xml 其他的寫法


<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <include resource="org/springframework/boot/logging/logback/base.xml" />
    <logger name="org.springframework.web" level="INFO"/>
    <logger name="org.springboot.sample" level="TRACE" />
   
    <!-- 測試環境+開發環境. 多個使用逗號隔開. -->
     <springProfile name="test,dev">
        <logger name="org.springframework.web" level="DEBUG"/>
        <logger name="org.springboot.sample" level="DEBUG" />
        <logger name="com.example" level="DEBUG" />
    </springProfile>
 
   
    <!-- 生產環境. -->
    <springProfile name="prod">
        <logger name="org.springframework.web" level="ERROR"/>
        <logger name="org.springboot.sample" level="ERROR" />
        <logger name="com.example" level="ERROR" />
    </springProfile>
</configuration>

這里說明一下：

引入的base.xml是Spring Boot的日志系統預先定義了一些系統變量的基礎配置文件
在application.properties中設置環境為prod，則只會打印error級別日志
如果在application.properties中定義了相同的配置，則application.properties的日志優先級更高

可以在內部進行引用

<?xml version="1.0" encoding="utf-8"?>
<configuration scan="true" scanPeriod="10 seconds">

    <!-- 文件輸出格式 -->
    <property name="pattern" value="%d{yyyy-MM-dd HH:mm:ss.SSS} -%5p ${PID:-} [%15.15t] %-40.40logger{39} : %m%n" />
    <property name="charsetEncoding" value="UTF-8" />
    <!--<PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>-->

    <!--控制臺日志-->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${pattern}</pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <appender name="file" class="ch.qos.logback.core.FileAppender">
        <file>./logback/logfile.log</file>
        <append>true</append>
        <encoder>
            <pattern>${pattern}</pattern>
            <charset>${charsetEncoding}</charset>
        </encoder>
    </appender>

    <appender name="dailyRollingFileAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <File>./logback/log.log</File>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- daily rollover -->
            <FileNamePattern>logback.%d{yyyy-MM-dd_HH}.log</FileNamePattern>
            <!-- keep 30 days' worth of history -->
            <maxHistory>7</maxHistory>
        </rollingPolicy>
        <encoder>
            <Pattern>${pattern}</Pattern>
        </encoder>
    </appender>

    <logger name="org.springframework.web" level="debug"/>
    <!-- show parameters for hibernate sql 專為 Hibernate 定制 -->
    <logger name="org.hibernate.type.descriptor.sql.BasicBinder" level="TRACE" />
    <logger name="org.hibernate.type.descriptor.sql.BasicExtractor" level="DEBUG" />
    <logger name="org.hibernate.SQL" level="DEBUG" />
    <logger name="org.hibernate.engine.QueryParameters" level="DEBUG" />
    <logger name="org.hibernate.engine.query.HQLQueryPlan" level="DEBUG" />

    <!--myibatis log configure-->
    <logger name="com.apache.ibatis" level="TRACE"/>
    <logger name="java.sql.Connection" level="DEBUG"/>
    <logger name="java.sql.Statement" level="DEBUG"/>
    <logger name="java.sql.PreparedStatement" level="DEBUG"/>

    <root level="debug">
        <appender-ref ref="console"/>
        <appender-ref ref="dailyRollingFileAppender"/>
        <appender-ref ref="file"/>
    </root>
</configuration>

三个男躁一个女,国精产品一区一手机的秘密,麦子交换系列最经典十句话,欧美国产综合欧美视频

Spring Boot 日志框架

Spring Boot 日志框架

日志框架

1.SLF4j使用

1.1 如何在系統中使用SLF4j

1.2 歷史遺留問題

1.3 slf4j統一“天下”

2. Spring Boot 日志配置

3. 日志的使用

3.1 日志格式說明

3.2 指定配置

4. 切換日志框架

5.“坑”

附錄

推薦閱讀更多精彩內容

三个男躁一个女,国精产品一区一手机的秘密,麦子交换系列最经典十句话,欧美 国产 综合 欧美 视频

Spring Boot 日志框架

日志框架

1.SLF4j使用

1.1 如何在系統中使用SLF4j

1.2 歷史遺留問題

1.3 slf4j統一“天下”

2. Spring Boot 日志配置

3. 日志的使用

3.1 日志格式說明

3.2 指定配置

4. 切換日志框架

5.“坑”

附錄

推薦閱讀更多精彩內容

三个男躁一个女,国精产品一区一手机的秘密,麦子交换系列最经典十句话,欧美国产综合欧美视频