logback与Spring、SpringMVC结合使用教程

客官°小女子只卖身不卖艺 2021-09-10 19:18 257阅读 0赞

林炳文Evankaka原创作品。转载请注明出处[http://blog.csdn.net/evankaka][http_blog.csdn.net_evankaka]

摘要：本文主要介绍了如何在spring、springMVC中使用logback

## 一、logback与Spirng结合使用 ##

1、maven添加引用：

<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一起使用的。

2、src/main/resource添加logback.xml

其中，下面这几个参数 是在pom.xml里配置的，如果你不想在pom.xml里来配置，也可以直接写死就是

参数内容如下：

<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>

3、如果单独的跑一个spring项目，不带web页面的话，那么这时跑个单元测试就可以打印日志了

![20160205144328469][]

看看输出的文件：

![20160205144538952][]

## 二、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目录 下：**

![20160205145038847][]

**而如果将此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>
    		
    		<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>
    
        
        <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>
    	
        
        <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>
             
            <filter class="ch.qos.logback.classic.filter.LevelFilter"> 
                <level>INFO</level>
                <onMatch>ACCEPT</onMatch>  
        		<onMismatch>DENY</onMismatch>
            </filter>
        </appender>
    
        	
        <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>
        
        <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>
    
        
        <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>
    	
        
        <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 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>
    
    	
    
        
        
        
        <logger name="jdbc.sqltiming" level="DEBUG" addtivity="false">
            <appender-ref ref="rootConsole"/>
            <appender-ref ref="rootRollingSql"/>
        </logger>
        
        
        
    	
        <logger name="com" level="DEBUG" addtivity="true">
            <appender-ref ref="businessRollingDebug"/>
        </logger> 
    	
    	<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>里面的转换符说明：

<table> 
 <tbody> 
  <tr> 
   <th>转换符</th> 
   <th>作用</th> 
  </tr> 
  <tr> 
   <td style="border-color:#C0C0C0;">c&nbsp;{length&nbsp;}&nbsp;<br> lo&nbsp;{length&nbsp;}&nbsp;<br> logger&nbsp;{length&nbsp;}&nbsp;</td> 
   <td style="border-color:#C0C0C0;">输出日志的logger名，可有一个整形参数，功能是缩短logger名，设置为0表示只输入logger最右边点符号之后的字符串。 
    <table> 
     <tbody> 
      <tr> 
       <th>Conversion specifier</th> 
       <th>Logger name</th> 
       <th>Result</th> 
      </tr> 
      <tr> 
       <td style="border-color:#C0C0C0;">%logger</td> 
       <td style="border-color:#C0C0C0;">mainPackage.sub.sample.Bar</td> 
       <td style="border-color:#C0C0C0;">mainPackage.sub.sample.Bar</td> 
      </tr> 
      <tr> 
       <td style="border-color:#C0C0C0;">%logger{0}</td> 
       <td style="border-color:#C0C0C0;">mainPackage.sub.sample.Bar</td> 
       <td style="border-color:#C0C0C0;">Bar</td> 
      </tr> 
      <tr> 
       <td style="border-color:#C0C0C0;">%logger{5}</td> 
       <td style="border-color:#C0C0C0;">mainPackage.sub.sample.Bar</td> 
       <td style="border-color:#C0C0C0;">m.s.s.Bar</td> 
      </tr> 
      <tr> 
       <td style="border-color:#C0C0C0;">%logger{10}</td> 
       <td style="border-color:#C0C0C0;">mainPackage.sub.sample.Bar</td> 
       <td style="border-color:#C0C0C0;">m.s.s.Bar</td> 
      </tr> 
      <tr> 
       <td style="border-color:#C0C0C0;">%logger{15}</td> 
       <td style="border-color:#C0C0C0;">mainPackage.sub.sample.Bar</td> 
       <td style="border-color:#C0C0C0;">m.s.sample.Bar</td> 
      </tr> 
      <tr> 
       <td style="border-color:#C0C0C0;">%logger{16}</td> 
       <td style="border-color:#C0C0C0;">mainPackage.sub.sample.Bar</td> 
       <td style="border-color:#C0C0C0;">m.sub.sample.Bar</td> 
      </tr> 
      <tr> 
       <td style="border-color:#C0C0C0;">%logger{26}</td> 
       <td style="border-color:#C0C0C0;">mainPackage.sub.sample.Bar</td> 
       <td style="border-color:#C0C0C0;">mainPackage.sub.sample.Bar</td> 
      </tr> 
     </tbody> 
    </table><p>&nbsp;</p> </td> 
  </tr> 
  <tr> 
   <td style="border-color:#C0C0C0;">C&nbsp;{length&nbsp;}&nbsp;<br> class&nbsp;{length&nbsp;}&nbsp;</td> 
   <td style="border-color:#C0C0C0;">输出执行记录请求的调用者的全限定名。参数与上面的一样。尽量避免使用，除非执行速度不造成任何问题。</td> 
  </tr> 
  <tr> 
   <td style="border-color:#C0C0C0;">contextName&nbsp;<br> cn&nbsp;</td> 
   <td style="border-color:#C0C0C0;">输出上下文名称。</td> 
  </tr> 
  <tr> 
   <td style="border-color:#C0C0C0;">d&nbsp;{pattern&nbsp;}&nbsp;<br> date&nbsp;{pattern&nbsp;}&nbsp;</td> 
   <td style="border-color:#C0C0C0;">输出日志的打印日志，模式语法与java.text.SimpleDateFormat&nbsp;兼容。 
    <table> 
     <tbody> 
      <tr> 
       <th>Conversion Pattern</th> 
       <th>Result</th> 
      </tr> 
      <tr> 
       <td style="border-color:#C0C0C0;">%d</td> 
       <td style="border-color:#C0C0C0;">2006-10-20 14:06:49,812</td> 
      </tr> 
      <tr> 
       <td style="border-color:#C0C0C0;">%date</td> 
       <td style="border-color:#C0C0C0;">2006-10-20 14:06:49,812</td> 
      </tr> 
      <tr> 
       <td style="border-color:#C0C0C0;">%date{ISO8601}</td> 
       <td style="border-color:#C0C0C0;">2006-10-20 14:06:49,812</td> 
      </tr> 
      <tr> 
       <td style="border-color:#C0C0C0;">%date{HH:mm:ss.SSS}</td> 
       <td style="border-color:#C0C0C0;">14:06:49.812</td> 
      </tr> 
      <tr> 
       <td style="border-color:#C0C0C0;">%date{dd&nbsp;MMM&nbsp;yyyy&nbsp;;HH:mm:ss.SSS}</td> 
       <td style="border-color:#C0C0C0;">20 oct. 2006;14:06:49.812</td> 
      </tr> 
     </tbody> 
    </table></td> 
  </tr> 
  <tr> 
   <td style="border-color:#C0C0C0;">F / file</td> 
   <td style="border-color:#C0C0C0;">输出执行记录请求的java源文件名。尽量避免使用，除非执行速度不造成任何问题。</td> 
  </tr> 
  <tr> 
   <td style="border-color:#C0C0C0;">caller{depth}caller{depth, evaluator-1, ... evaluator-n}</td> 
   <td style="border-color:#C0C0C0;">输出生成日志的调用者的位置信息，整数选项表示输出信息深度。 <p>例如，&nbsp;%caller{2}&nbsp;&nbsp; 输出为：</p> <pre><code>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)</code></pre> <p>例如，&nbsp;%caller{3}&nbsp;&nbsp; 输出为：</p> <pre><code>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)</code></pre> </td> 
  </tr> 
  <tr> 
   <td style="border-color:#C0C0C0;">L / line</td> 
   <td style="border-color:#C0C0C0;">输出执行日志请求的行号。尽量避免使用，除非执行速度不造成任何问题。</td> 
  </tr> 
  <tr> 
   <td style="border-color:#C0C0C0;">m / msg / message</td> 
   <td style="border-color:#C0C0C0;"> <p>输出应用程序提供的信息。</p> </td> 
  </tr> 
  <tr> 
   <td style="border-color:#C0C0C0;">M / method</td> 
   <td style="border-color:#C0C0C0;">输出执行日志请求的方法名。尽量避免使用，除非执行速度不造成任何问题。</td> 
  </tr> 
  <tr> 
   <td style="border-color:#C0C0C0;">n</td> 
   <td style="border-color:#C0C0C0;">输出平台先关的分行符“\n”或者“\r\n”。</td> 
  </tr> 
  <tr> 
   <td style="border-color:#C0C0C0;">p / le / level</td> 
   <td style="border-color:#C0C0C0;">输出日志级别。</td> 
  </tr> 
  <tr> 
   <td style="border-color:#C0C0C0;">r / relative</td> 
   <td style="border-color:#C0C0C0;">输出从程序启动到创建日志记录的时间，单位是毫秒</td> 
  </tr> 
  <tr> 
   <td style="border-color:#C0C0C0;">t / thread</td> 
   <td style="border-color:#C0C0C0;">输出产生日志的线程名。</td> 
  </tr> 
  <tr> 
   <td style="border-color:#C0C0C0;">replace(p&nbsp;){r, t}</td> 
   <td style="border-color:#C0C0C0;"> <p>p&nbsp;为日志内容，r&nbsp;是正则表达式，将p&nbsp;中符合r&nbsp;的内容替换为t&nbsp;。</p> <p>例如， "%replace(%msg){'\s', ''}"</p> </td> 
  </tr> 
 </tbody> 
</table>

更多技术请关注笔者微信技术公众号"单例模式"

![70][]

[http_blog.csdn.net_evankaka]: http://blog.csdn.net/evankaka
[20160205144328469]: /images/20210811/5fb810f009ed4ad2b231eee3229e4447.png
[20160205144538952]: /images/20210811/2e97832d38bb425481df1cb2dee19787.png
[20160205145038847]: /images/20210811/c55f54783b99468196f2394e45d5cc6f.png
[70]: /images/20210811/f3106e368649465e9ea4beffae3d72f0.png