2. 程式人生 > >SpringBoot日誌框架的選擇及使用原理

SpringBoot日誌框架的選擇及使用原理

阿新 • • 發佈：2018-11-23

1 日誌框架介紹

對於我們日常開發日誌是經常使用的，當然以前的我們可能還傻傻的各種System.out.println("重要資料")在控制檯輸出各種重要資料呢，投入生產的時候再註釋掉。到現在為止呢，已經有很多日誌可供選擇了，而市面上常見的日誌框架有很多，比如：JCL、SLF4J、Jboss-logging、jUL、log4j、log4j2、logback等等，我們該如何選擇呢？
市面上的日誌框架；

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

左邊選一個抽象層、右邊來選一個實現；類似與我們經常使用的JDBC一樣，選擇不同的資料庫驅動。

  • 下面我們先看看日誌的抽象層：JCL大家應該很熟悉，Commons Logging，spring中常用的框架最後一次更新2014年~~~；jboss-logging使用的場景太少了；就剩下SLF4j了也是我們springboot中使用的日誌抽象層。
  • 日誌實現：大家應該看著都很熟悉把Log4j大家應該用的挺多的，Logback是Log4j的升級版本出至於同一個人開發的，考慮到以後的升級使用等問題，又寫出了SLF4j的日誌抽象層使用起來更加靈活。JUL（java.util.logging）一看就知道是java util包下的；Log4j2 咋一看像是Log4j的升級版本，其實並不是，它是apache下生產的日誌框架。
    SpringBoot選用 SLF4j和logback

2 SLF4j使用原理

SL4j官網
在使用手冊中給我們寫了一個著名的Hello world

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");
}
}

下面我們看一張圖到底如何使用：
在這裡插入圖片描述

我們現在已經知道了springboot中使用的是 SLF4j和logback，但是如果我們想使用log4j該怎麼辦呢，從上面的圖示中我們可以看出想要使用log4j我們肯定還是要使用 SLF4j作為抽象層，但是中間給我們加入了一層適配層（Adaptation layer）然後使用log4j進行實現，那麼我們需要匯入圖示中的jar包即可，其他的也是一樣了。所以說，以後開發的時候，日誌記錄方法的呼叫，不應該來直接呼叫日誌的實現類，而是呼叫日誌抽象層裡面的方法； 每一個日誌的實現框架都有自己的配置檔案。使用slf4j以後，配置檔案還是做成日誌實現框架自己本身的配置檔案；

  • 可能存在的問題
    現在開發中我麼想使用slf4j+logback，但是對於一些遺留專案中例如Spring（commons-logging）、Hibernate（jboss-logging）…等等，如何去做到日誌同一呢？
    你想到的問題SLF4j能想不到嗎？答案是可以的，我們看看下面的圖就明白了
    官方地址
    在這裡插入圖片描述

如何讓系統中所有的日誌都統一到slf4j；

1、將系統中其他日誌框架先排除出去；

2、用中間包來替換原有的日誌框架；

3、我們匯入slf4j其他的實現

其實通過idea我們建立一個springboot專案也可以檢視日誌依賴（擷取其中部分）：
SpringBoot使用它來做日誌功能：

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

在這裡插入圖片描述

SpringBoot能自動適配所有的日誌，而且底層使用slf4j+logback的方式記錄日誌，引入其他框架的時候，只需要把這個框架依賴的日誌框架排除掉即可；

  • 例如
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-core</artifactId>
<exclusions>
<exclusion>
<groupId>commons-logging</groupId>
<artifactId>commons-logging</artifactId>
</exclusion>
</exclusions>
</dependency>

3 SpringBoot日誌的預設配置

package cn.zhangyu;

import org.junit.Test;
import org.junit.runner.RunWith;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

import java.applet.AppletContext;

@RunWith(SpringRunner.class)
@SpringBootTest
public class Springboot1ApplicationTests {
//記錄器
Log log = LogFactory.getLog(Springboot1ApplicationTests.class);

@Test
public void test(){
//日誌的級別；
//由低到高 trace<debug<info<warn<error
//可以調整輸出的日誌級別；日誌就只會在這個級別以以後的高級別生效
log.trace("trace級別的日誌");
log.debug("debug級別的日誌");
//SpringBoot預設給我們使用的是info級別的，沒有指定級別的就用SpringBoot預設規定的級別；root級別
log.info("info級別的日誌");
log.warn("warn級別的日誌");
log.error("error級別的日誌");

}
}
  • 其他配置
#修改日誌的級別，預設root是info
#logging.level.root=trace

# 不指定路徑在當前專案下生成springboot.log日誌
#logging.file=springboot.log
# 可以指定完整的路徑；
logging.file=d://springboot.log

# 在當前磁碟的根路徑下建立spring資料夾和裡面的log資料夾；使用spring.log 作為預設檔案
logging.path=/spring/log

# 在控制檯輸出的日誌的格式
logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
# 指定檔案中日誌輸出的格式
logging.pattern.file=%d{yyyy-MM-dd} === [%thread] === %-5level === %logger{50} ==== %msg%n

日誌輸出格式：
%d表示日期時間，
%thread表示執行緒名，
%-5level：級別從左顯示5個字元寬度
%logger{50} 表示logger名字最長50個字元，否則按照句點分割。 
%msg：日誌訊息，
%n是換行符

4 SpringBoot指定日誌檔案

給類路徑下放上每個日誌框架自己的配置檔案即可；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：如果使用logback-spring.xml，日誌框架就不直接載入日誌的配置項，需要加上springProfile標籤由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]

5 切換日誌框架

可以按照idea中maven的關係圖，進行相關的切換；

slf4j+log4j的方式；（不推薦，只是教大家如何切換）

  • pom.xml
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>

	<groupId>cn.zhangyu</groupId>
	<artifactId>springboot-1</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<packaging>jar</packaging>

	<name>springboot-1</name>
	<description>Demo project for Spring Boot</description>

	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.0.5.RELEASE</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>

	<properties>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
		<java.version>1.8</java.version>
	</properties>

	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter</artifactId>
			<exclusions>
				<exclusion>
					<artifactId>log4j-to-slf4j</artifactId>
					<groupId>org.apache.logging.log4j</groupId>
				</exclusion>
				<exclusion>
					<artifactId>logback-classic</artifactId>
					<groupId>ch.qos.logback</groupId>
				</exclusion>
			</exclusions>
		</dependency>

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

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

		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-configuration</artifactId>
			<optional>true</optional>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>

	</dependencies>

	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
			</plugin>
		</plugins>
	</build>


</project>
  • 在resource目錄下新增log4j.properties
### set log levels ###
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 =  %d{ABSOLUTE} ===== %5p %c{ 1 }:%L - %m%n

#### 輸出到日誌檔案 ###
#log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
#log4j.appender.D.File = logs/log.log
#log4j.appender.D.Append = true
#log4j.appender.D.Threshold = DEBUG ## 輸出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
#
#### 儲存異常資訊到單獨檔案 ###
#log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
#log4j.appender.D.File = logs/error.log ## 異常日誌檔名
#log4j.appender.D.Append = true
#log4j.appender.D.Threshold = ERROR ## 只輸出ERROR級別以上的日誌!!!
#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
  • 修改為log4j2
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>

	<groupId>cn.zhangyu</groupId>
	<artifactId>springboot-1</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<packaging>jar</packaging>

	<name>springboot-1</name>
	<description>Demo project for Spring Boot</description>

	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.0.5.RELEASE</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>

	<properties>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
		<java.version>1.8</java.version>
	</properties>

	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter</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>

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

		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-configuration</artifactId>
			<optional>true</optional>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>

	</dependencies>

	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
			</plugin>
		</plugins>
	</build>
</project>

相關推薦

SpringBoot日誌框架的選擇及使用原理

1 日誌框架介紹 對於我們日常開發日誌是經常使用的，當然以前的我們可能還傻傻的各種System.out.println("重要資料")在控制檯輸出各種重要資料呢，投入生產的時候再註釋掉。到現在為止呢，已經有很多日誌可供選擇了，而市面上常見的日誌框架有很多，比如：JCL、SLF4J、J

MOS開關管的選擇及原理應用

1-1 連續 損壞 ack get 模型 每次 我們 能量 一般情況下普遍用於高端驅動的MOS，導通時需要是柵極電壓大於源極電壓。而高端驅動的MOS管導通時源極電壓與漏極電壓（VCC）相同，所以這時柵極電壓要比VCC大4V或10V。如果在同一個系統裏，要得到比VCC大的電壓

Java日誌框架解析及實戰分析

轉載自： https://zhuanlan.zhihu.com/p/24272450 https://zhuanlan.zhihu.com/p/24275518 作為Java程式設計師，幸運的是，Java 擁有功能和效能都非常強大的日誌庫；不幸的是，這樣的日誌庫有不止一個——相信每個人都曾經迷失在JUL(J

Springboot郵件模板選擇及原因

一.Springboot郵件模板可選項 Thymeleaf Freemarker Velocity 二.測試程式碼 1.Thymeleaf模板 模板部分 <!DOCTYPE html> <!-- 使用xmlns宣告為t

SpringBoot 日誌框架

預設的日誌框架 logback SpringBoot使用Logback作為預設的日誌框架。logback 是log4j框架的作者開發的新一代日誌框架，它效率更高、能夠適應諸多的執行環境，同時天然支援SLF4J。spring-boot-starter 其中包含了 spring-boot-starter-log

Java日誌框架研究及常見配置

按照基本的定義，日誌即是對程式執行過程中關鍵事件的記錄；大體日誌分為執行日誌和開發日誌，執行日誌在業務層面記錄一些關鍵事件，為後面的跟蹤執行提供幫助，而開發日誌大多數時候是除錯日誌，根據事件流的輸出來除錯程式；因為開發人員本身的關注領域，執行日誌可能製作的比較少，難以達到

SpringBoot定製錯誤頁面及原理

一、SpringBoot預設的錯誤處理機制 1）、瀏覽器返回的預設錯誤頁面如下：             ☞ 瀏覽器傳送請求的請求頭資訊如下：text/html會在後面的原始碼分析中說到

SpringBoot日誌框架logback

簡單日誌配置 logback的介紹及配置 logback的使用 logback.xml配置示例 #####一.簡單日誌配置 spring boot內部使用Commons Logging來記錄日誌，但也保留外部介面可以讓一些日誌框架來進行實現，例如J

常見的日誌框架以及日誌框架選擇

日誌門面採取的就是facade設計模式設計的一組介面應用。 日誌實現當然是介面的實現了。 我們先從日誌實現分析下手， JUL（java.util.logger）直接放棄使用，設計簡單，不足以支撐

springboot 日誌的呼叫及日誌檔案路徑的設定

springboot 開箱即用，已經包含日誌的配置，下面介紹呼叫方法及日誌檔案的路徑設定。 （1）呼叫 第一步，先在Controller 裡面設定log屬性，把controller的類名作為引數 @RestController public class ErrorCon

springMVC框架介紹及原理

Spring 框架提供了構建 Web 應用程式的全功能 MVC 模組。使用 Spring 可插入的 MVC 架構，可以選擇是使用內建的 Spring Web 框架還是 Struts 這樣的 Web 框架。通過策略介面，Spring 框架是高度可配置的，而且包含多種檢視技術，例如 JavaServer Pag

深入理解Logger日誌——框架繫結原理

深入理解Logger日誌——框架繫結原理  　　說到Logger日誌的動態繫結，主要歸功與Slf4j，在之前的文章也說過，Slf4j是類似於Apache Common-Logging，英文為Simple Logging Facade，是一個簡單的日誌門面介面卡，所有的日誌程式碼都可以用slf4j方式

SpringBoot日誌及原理

一、SpringBoot日誌：選用SLF4j（介面）和logback（實現類），除了上述日誌框架，市場上還存在JUL(java.util.logging)、JCL(Apache Commons Logging)、Log4j、Log4j2、SLF4j、jboss-logging

Spring-Boot 日+SLF4j使用+SLF4j原理+統一日誌記錄+SpringBoot日誌關係+引入其他框架+框架切換+日誌使用

1SLF4j使用（和以前使用log4j一樣） import org.slf4j.Logger; import org.slf4j.LoggerFactory; public class HelloWorld { public static void main(Strin

MyBatis框架中Mapper映射配置的使用及原理解析(二) 配置篇 SqlSessionFactoryBuilder，XMLConfigBuilder

.cn 創建 ron 子節點 homepage 解析 調用 sco title 在 <MyBatis框架中Mapper映射配置的使用及原理解析(一) 配置與使用> 的demo中看到了SessionFactory的創建過程： SqlSessionFactory

熱備份路由選擇協議（HSRP）配置命令及原理

ndb vrrp 恢復 命令 time conf eem 路由協議 調整 熱備份路由選擇協議（HSRP）HSRP是Cisco私有協議HSRP組成員：（1）活躍路由器（2）備份路由器（3）虛擬路由器（4）其他路由器HSRP消息：HSRP中的所有路由器都發送或接收HSRP消息U

Java日誌框架：slf4j作用及其實現原理

sof cat 打開 系統 aging .get matching ade you 簡單回顧門面模式 slf4j是門面模式的典型應用，因此在講slf4j前，我們先簡單回顧一下門面模式， 門面模式，其核心為外部與一個子系統的通信必須通過一個統一的外觀對象進行，使得子系統更易於

SpringBoot日記——日誌框架篇

add 多日誌 center 先來 resource ole style CA ring 在項目的開發中，日誌是必不可少的一個記錄事件的組件，所以也會相應的在項目中實現和構建我們所需要的日誌框架。 而市面上常見的日誌框架有很多，比如：JCL、SLF4J、Jboss-logg

MySQL binlog日誌三種模式選擇及配置

ble 文件 eve 圖解 nag 一行 人的 三種模式 jpg 在講解binlog日誌三種模式前，先了解一下解析binlog日誌的命令工mysqlbinlog。mysqlbinlog工具的作用是解析mysql的二進制binlog日誌內容，把二進制日誌解析成可以在MySQL

打造一個簡單的TXT文本操作及日誌框架

默認值 pos 簡單 rst arch rap ++ 項目實現 spa 首先先介紹一下這個項目，該項目實現了文本寫入及讀取，日誌寫入指定文件夾或默認文件夾，日誌數量控制，單個日誌大小控制，通過約定的參數讓用戶可以用更少的代碼解決問題。 1.讀取文本文件方法 使用：JIYUW