logback與Spring、SpringMVC結合使用教程

時間 2019-11-20

標籤 logback spring springmvc 結合使用教程欄目 Spring 简体版

原文原文鏈接

摘要：本文主要介紹瞭如何在spring、springMVC中使用logback java

1、logback與Spirng結合使用

一、maven添加引用： mysql

<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>${log4j.version}</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>${slf4j.version}</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.1.2</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-core</artifactId>
<version>1.1.2</version>
</dependency>
<dependency>
<groupId>org.logback-extensions</groupId>
<artifactId>logback-ext-spring</artifactId>
<version>0.1.1</version>
</dependency>

其中logback-ext-spring這個jar包是爲了和spring一塊兒使用的。

二、src/main/resource添加logback.xml linux

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<property name="log.root.level" value="${log.root.level}" />
<property name="log.other.level" value="${log.other.level}" />
<property name="log.base" value="${log.base}" />
<property name="log.moduleName" value="${log.moduleName}" />
<property name="log.max.size" value="100MB" />
<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<Pattern>%date{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%thread]%logger{56}.%method:%L -%msg%n</Pattern>
</encoder>
</appender>
<appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
<File>${log.base}/${log.moduleName}.log</File>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<FileNamePattern>${log.base}/archive/${log.moduleName}_all_%d{yyyy-MM-dd}.%i.log.zip
</FileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>${log.max.size}</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<layout class="ch.qos.logback.classic.PatternLayout">
<pattern>%date{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%thread]%logger{56}.%method:%L -%msg%n</pattern>
</layout>
</appender>
<logger name="com.lin" additivity="false">
<level value="debug" />
<appender-ref ref="stdout" />
<appender-ref ref="file" />
</logger>
<root level="debug">
<appender-ref ref="stdout" />
<appender-ref ref="file" />
</root>
</configuration>

其中，下面這幾個參數是在pom.xml裏配置的，若是你不想在pom.xml裏來配置，也能夠直接寫死就是 web

<property name="log.root.level" value="${log.root.level}" />
<property name="log.other.level" value="${log.other.level}" />
<property name="log.base" value="${log.base}" />
<property name="log.moduleName" value="${log.moduleName}" />
<property name="log.max.size" value="10kb" /> 正則表達式

參數內容以下： spring

<profiles>
<profile>
<id>dev</id>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<properties>
<jdbc_driverClassName>com.mysql.jdbc.Driver</jdbc_driverClassName>
<jdbc_url>jdbc:mysql://localhost:3306/learning</jdbc_url>
<jdbc_username>root</jdbc_username>
<jdbc_password>christmas258@</jdbc_password>
<log.moduleName>ssm-project</log.moduleName>
<log.base>logs</log.base>
<log.other.level>DEBUG</log.other.level>
<log.root.level>DEBUG</log.root.level>
<log.stdout.ref><![CDATA[<appender-ref ref="stdout" />]]></log.stdout.ref>
</properties>
</profile>
</profiles>

三、若是單獨的跑一個spring項目，不帶web頁面的話，那麼這時跑個單元測試就能夠打印日誌了

看看輸出的文件：

2、logback與spingMVC結合使用

其實與spingMVC只須要在上面的工程中，在web.xml裏添加以下內容便可。

<context-param>
<param-name>logbackConfigLocation</param-name>
<param-value>classpath:logback.xml</param-value>
</context-param>
<listener>
<listener-class>ch.qos.logback.ext.spring.web.LogbackConfigListener</listener-class>
</listener>

而後本地啓動tomcat，把項目加載進來，注意，此時的日誌輸出路徑不會像上面同樣出如今工程所在路徑的logs目錄下，而會放在eclipse安裝目錄下，自動新建一個logs目錄下：

而若是將此war包上傳到linux下的tomcat的webapp目錄後，日誌文件會保存在tomcat/bin/logs目錄下，記得，這個是web項目和非web項目日誌保存路徑的不一樣！

下面這一個是配置比較複雜的，大的工程更多的是以這種方式來配置的，針對不一樣的包，不一樣級別的日誌來分別打印，以下：

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<property name="log.root.level" value="${log.root.level}" />
<property name="log.other.level" value="${log.other.level}" />
<property name="log.base" value="${log.base}" />
<property name="log.moduleName" value="${log.moduleName}" />
<property name="log.max.size" value="100MB" />
<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<Pattern>%date{yyyy-MM-dd HH:mm:ss.SSS} %-5level[%thread]%logger{56}.%method:%L -%msg%n</Pattern>
</encoder>
</appender>
<appender name="file.all" class="ch.qos.logback.core.rolling.RollingFileAppender">
<File>${log.base}/${log.moduleName}.log</File><!-- 設置日誌不超過${log.max.size}時的保存路徑，注意若是
是web項目會保存到Tomcat的bin目錄下 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<FileNamePattern>${log.base}/archive/${log.moduleName}_all_%d{yyyy-MM-dd}.%i.log.zip
</FileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy
class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>${log.max.size}</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<layout class="ch.qos.logback.classic.PatternLayout">
<pattern>%date{yyyy-MM-dd HH:mm:ss.SSS} %-5level[%thread]%logger{56}.%method:%L -%msg%n</pattern>
</layout>
</appender>
<appender name="file.all.other" class="ch.qos.logback.core.rolling.RollingFileAppender">
<File>${log.base}/${log.moduleName}_other.log</File>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<FileNamePattern>${log.base}/archive/${log.moduleName}_other_%d{yyyy-MM-dd}.%i.log.zip
</FileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy
class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>${log.max.size}</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<layout class="ch.qos.logback.classic.PatternLayout">
<pattern>%date{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%thread] %logger{56}.%method:%L -%msg%n</pattern>
</layout>
</appender>
<appender name="file.error"
class="ch.qos.logback.core.rolling.RollingFileAppender">
<File>${log.base}/${log.moduleName}_err.log</File>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<FileNamePattern>${log.base}/archive/${log.moduleName}_err_%d{yyyy-MM-dd}.%i.log.zip
</FileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy
class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>${log.max.size}</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<layout class="ch.qos.logback.classic.PatternLayout">
<pattern>%date{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%thread] %logger{56}.%method:%L - %msg%n</pattern>
</layout>
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>ERROR</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<appender name="file.async" class="ch.qos.logback.classic.AsyncAppender">
<discardingThreshold>0</discardingThreshold>
<queueSize>256</queueSize>
<includeCallerData>true</includeCallerData>
<appender-ref ref="file.all" />
</appender>
<appender name="file.async.other" class="ch.qos.logback.classic.AsyncAppender">
<discardingThreshold>0</discardingThreshold>
<queueSize>256</queueSize>
<includeCallerData>true</includeCallerData>
<appender-ref ref="file.all.other" />
</appender>
<logger name="com.lin" additivity="false">
<level value="${log.root.level}" />
<appender-ref ref="stdout" />
<appender-ref ref="file.async" />
<appender-ref ref="file.error" />
</logger>
<root level="${log.root.level}">
<appender-ref ref="stdout" />
<appender-ref ref="file.async.other" />
<appender-ref ref="file.error" />
</root>
</configuration>

還有另外一個網上的找的配置文件，筆者沒有使用過，不過，你們能夠參考下來寫：

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="10 seconds" debug="false">
<property name="contextPath" value="/home/logs/valiuser"/>
<property name="logPath" value="${contextPath}"/>
<property name="maxHistory" value="90"/>
<appender name="rootConsole" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36}.%M - %msg%n</pattern>
</encoder>
</appender>
<!--
定義日誌的輸出方式:輸出在文件夾debug/debug.log文件中
配置全部類全部級別的滾動日誌
-->
<appender name="rootRollingDebug" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${logPath}/debug/debug.log</file>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${logPath}/debug/debug.%d{yyyy-MM-dd}.log</fileNamePattern>
<maxHistory>${maxHistory}</maxHistory>
</rollingPolicy>
<encoder>
<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36}.%M - %msg%n</pattern>
<charset>UTF-8</charset>
</encoder>
</appender>
<!--
定義日誌的輸出方式:輸出在文件夾info/root.log文件中
配置全部類INFO級別的滾動日誌
-->
<appender name="rootRollingInfo" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${logPath}/info/info.log</file>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${logPath}/info/info.%d{yyyy-MM-dd}.log</fileNamePattern>
<maxHistory>${maxHistory}</maxHistory>
</rollingPolicy>
<encoder>
<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36}.%M - %msg%n</pattern>
<charset>UTF-8</charset>
</encoder>
<!--
info/root.log文件中的日誌級別是 INFO以上的級別
<filter class="ch.qos.logback.classic.filter.ThresholdFilter"> 和
<filter class="ch.qos.logback.classic.filter.LevelFilter">的區別是什麼呢?
LevelFilter:嚴格限制日誌的輸出級別,使用LevelFilter設置,只會在文件中出現級別爲INFO級別的日誌內容。
-->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>INFO</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!--
定義日誌的輸出方式:輸出在文件夾warn/root.log文件中
配置全部類WARN級別的滾動日誌
-->
<appender name="rootRollingWarn" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${logPath}/warn/warn.log</file>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${logPath}/warn/warn.%d{yyyy-MM-dd}.log</fileNamePattern>
<maxHistory>${maxHistory}</maxHistory>
</rollingPolicy>
<encoder>
<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36}.%M - %msg%n</pattern>
<charset>UTF-8</charset>
</encoder>
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>WARN</level>
</filter>
</appender>
<!--
定義日誌的輸出方式:輸出在文件夾error/root.log文件中
配置全部類ERROR級別的滾動日誌
-->
<appender name="rootRollingError" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${logPath}/error/error.log</file>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${logPath}/error/error.%d{yyyy-MM-dd}.log</fileNamePattern>
<maxHistory>${maxHistory}</maxHistory>
</rollingPolicy>
<encoder>
<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36}.%M - %msg%n</pattern>
<charset>UTF-8</charset>
</encoder>
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>ERROR</level>
</filter>
</appender>
<!--
定義日誌的輸出方式:輸出在文件夾sql/root.log文件中
配置全部類SQL的日誌
-->
<appender name="rootRollingSql" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${logPath}/sql/sql.log</file>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${logPath}/sql/sql.%d{yyyy-MM-dd}.log</fileNamePattern>
<maxHistory>${maxHistory}</maxHistory>
</rollingPolicy>
<encoder>
<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36}.%M - %msg%n</pattern>
<charset>UTF-8</charset>
</encoder>
</appender>
<!--
定義日誌的輸出方式:輸出在文件夾business/rootsql.log文件中
打印業務邏輯級別的日誌到business文件下
-->
<appender name="businessRollingDebug" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${logPath}/business/business.log</file>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${logPath}/business/business.%d{yyyy-MM-dd}.log</fileNamePattern>
<maxHistory>${maxHistory}</maxHistory>
</rollingPolicy>
<encoder>
<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36}.%M - %msg%n</pattern>
<charset>UTF-8</charset>
</encoder>
</appender>
<!--
默認的日誌主線程<root>
定義輸出日誌的級別.DEBUG級別
下面設置的意思是:會將debug級別的日誌輸出在一下這五個appender-ref對應的appender上
-->
<root level="DEBUG">
<appender-ref ref="rootConsole"/>
<appender-ref ref="rootRollingDebug"/>
</root>
<root level="WARN">
<appender-ref ref="rootRollingWarn"/>
</root>
<root level="ERROR">
<appender-ref ref="rootRollingError"/>
</root>
<root level="INFO">
<appender-ref ref="rootRollingInfo"/>
</root>
<!--
除了使用默認的日誌主線程<root>外，還能夠經過<logger>標籤訂製其餘日誌線程如：
其中name指定線程針對的包路徑，level是日誌級別，<appender-ref>定義使用那種appender。
-->
<!--
jdbc.sqlonly不顯示sql執行的時間
jdbc.sqltiming顯示sql執行的時間{executed in 2 msec}
兩者使用一個便可
<logger name="jdbc.sqlonly" level="DEBUG" addtivity="false">
<appender-ref ref="rootConsole"/>
<appender-ref ref="rootRollingSql"/>
</logger>
-->
<logger name="jdbc.sqltiming" level="DEBUG" addtivity="false">
<appender-ref ref="rootConsole"/>
<appender-ref ref="rootRollingSql"/>
</logger>
<!--
打印項目中com包下的日誌到appender-ref指定的appender中打印級別是debug
這裏能夠用來專門打印某一類別的日誌到某一個特定的文件中.
好比:能夠打印全部的業務邏輯到業務邏輯文件中;打印全部的controller請求到指定的文件中.
-->
<logger name="com" level="DEBUG" addtivity="true">
<appender-ref ref="businessRollingDebug"/>
</logger>
<!--
打印具體的某個文件中的日誌到某個文件夾下.
注意:不是打印com.baihui.LogBackTest2文件夾下的日誌,而是LogBackTest2文件的日誌
addtivity="false" 表示打印的日誌不向上傳遞,若是設置成addtivity="true"會怎麼樣呢?沒錯,日誌打印了兩遍
-->
<logger name="com.baihui" level="DEBUG" addtivity="false">
<appender-ref ref="rootConsole"/>
</logger>
<logger name="baihui" level="ERROR" addtivity="false">
<appender-ref ref="rootConsole"/>
</logger>
</configuration>

附件

<pattern>裏面的轉換符說明： sql

轉換符

做用

c {length }
lo {length }
logger {length }

輸出日誌的logger名，可有一個整形參數，功能是縮短logger名，設置爲0表示只輸入logger最右邊點符號以後的字符串。

Conversion specifier	Logger name	Result
%logger	mainPackage.sub.sample.Bar	mainPackage.sub.sample.Bar
%logger{0}	mainPackage.sub.sample.Bar	Bar
%logger{5}	mainPackage.sub.sample.Bar	m.s.s.Bar
%logger{10}	mainPackage.sub.sample.Bar	m.s.s.Bar
%logger{15}	mainPackage.sub.sample.Bar	m.s.sample.Bar
%logger{16}	mainPackage.sub.sample.Bar	m.sub.sample.Bar
%logger{26}	mainPackage.sub.sample.Bar	mainPackage.sub.sample.Bar

C {length }
class {length }

輸出執行記錄請求的調用者的全限定名。參數與上面的同樣。儘可能避免使用，除非執行速度不形成任何問題。

contextName
cn

輸出上下文名稱。

d {pattern }
date {pattern }

輸出日誌的打印日誌，模式語法與java.text.SimpleDateFormat 兼容。

Conversion Pattern	Result
%d	2006-10-20 14:06:49,812
%date	2006-10-20 14:06:49,812
%date{ISO8601}	2006-10-20 14:06:49,812
%date{HH:mm:ss.SSS}	14:06:49.812
%date{dd MMM yyyy ;HH:mm:ss.SSS}	20 oct. 2006;14:06:49.812

F / file

輸出執行記錄請求的java源文件名。儘可能避免使用，除非執行速度不形成任何問題。

caller{depth}caller{depth, evaluator-1, ... evaluator-n}

輸出生成日誌的調用者的位置信息，整數選項表示輸出信息深度。

例如， %caller{2} 輸出爲：數據庫

0    [main] DEBUG - logging statement 
Caller+0   at mainPackage.sub.sample.Bar.sampleMethodName(Bar.java:22)
Caller+1   at mainPackage.sub.sample.Bar.createLoggingRequest(Bar.java:17)

例如， %caller{3} 輸出爲： api

16   [main] DEBUG - logging statement 
Caller+0   at mainPackage.sub.sample.Bar.sampleMethodName(Bar.java:22)
Caller+1   at mainPackage.sub.sample.Bar.createLoggingRequest(Bar.java:17)
Caller+2   at mainPackage.ConfigTester.main(ConfigTester.java:38)

L / line

輸出執行日誌請求的行號。儘可能避免使用，除非執行速度不形成任何問題。

m / msg / message

輸出應用程序提供的信息。 tomcat

M / method

輸出執行日誌請求的方法名。儘可能避免使用，除非執行速度不形成任何問題。

輸出平臺先關的分行符「\n」或者「\r\n」。

p / le / level

輸出日誌級別。

r / relative

輸出從程序啓動到建立日誌記錄的時間，單位是毫秒

t / thread