SpringBoot 日誌框架

時間  2019-11-17
標籤 springboot 日誌 框架 欄目 Spring 简体版
原文   原文鏈接

日誌框架

日誌框架就是爲了更好的記錄日誌使用的，記錄日誌是爲了咱們在工做中能夠更好的查找相對應的問題，也算是以中留痕操做！php

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

**市面上的日誌框架；**JUL、JCL、Jboss-logging、logback、log4j、log4j二、slf4j....java

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

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

​ <==SpringBoot選用 SLF4j和logback；==>spring

1.SLF4j使用

1.1 如何在系統中使用SLF4j

SLF4J的官方網站手冊sql

之後開發的時候，日誌記錄方法的調用，不該該來直接調用日誌的實現類，而是調用日誌抽象層裏面的方法；apache

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

使用方式以下：app

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>
複製代碼

這裏說明一下：

  1. 引入的base.xml是Spring Boot的日誌系統預先定義了一些系統變量的基礎配置文件

  2. 在application.properties中設置環境爲prod，則只會打印error級別日誌

  3. 若是在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>
複製代碼
相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程