SpringBoot使用logback示例

向右看齐 2022-05-17 00:40 178阅读 0赞

SpringBoot会默认使用logback作为日志框架。

SpringBoot会默认加载classpath:logback-spring.xml或者classpath:logback-spring.groovy文件作为日志配置文件。

注:也可以在系统配置文件中指定SpringBoot加载哪一个文件作为日志配置文件: 在application.properties文件中增加：

logging.config=classpath:xxx.xml 即可指定xxx.xml为日志配置文件。

注:如果是SpringBoot的项目的话，直接把logback-spring.xml配置文件放在src/main/resources文件夹下即可，如:

![70][]

# SpringBoot使用logback的基本步骤 #

### 第一步:在pom.xml中引入SpringBoot的基本依赖 ###

注:只要引入了spring-boot-starter-parent依赖，那么其会自动引入logback的相关依赖。

### 第二步:新建logback-spring.xml文件，放在classpath路径下(我们一般把其放在项目中的src/main/resources文件夹,该文件夹也对应classpath路径)即可 ###

注:logback-spring.xml如何配置，见下文。

# logback-spring.xml配置说明 #

声明:下面的配置较基本，如果实际运用时，感觉下述配置不满足需求，那么请查阅相关文档了解更多。

logback-spring.xml配置示例

<?xml version="1.0" encoding="UTF-8"?> 
       
        
       <configuration scan="true"> 
       
        
       <property name="logFilePositionDir" 
       value= "C:/Users/dengshuai.ASPIRE/Desktop/log" /> 
       
        
        
       <appender name="consoleAppender" 
       class= "ch.qos.logback.core.ConsoleAppender"> 
       <encoder> 
       <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36}:%L- %msg%n 
       </pattern> 
       </encoder> 
       </appender> 
       
        
       <appender name="fileAppender" 
       class= "ch.qos.logback.core.rolling.RollingFileAppender"> 
        
       <file>log/logFile.log </file> 
        
        
        
        
       <rollingPolicy 
       class= "ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> 
        
        
       <fileNamePattern>log/logFile.%d{yyyy-MM-dd}.%i.log 
       </fileNamePattern> 
        
        
        
       <MaxHistory> 
       7 
       </MaxHistory> 
        
       <timeBasedFileNamingAndTriggeringPolicy 
       class= "ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"> 
       <maxFileSize>10KB </maxFileSize> 
       </timeBasedFileNamingAndTriggeringPolicy> 
       </rollingPolicy> 
       <encoder> 
       <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36}:%L- %msg%n 
       </pattern> 
       </encoder> 
       </appender> 
       
        
        
        
       <logger name="com" level="trace"> 
        
       <appender-ref ref="fileAppender" /> 
       </logger> 
       
        
        
       <root level="info"> 
       <appender-ref ref="consoleAppender" /> 
       </root> 
       </configuration>

给出上述配置在指定文件夹位置生成的log文件示例:

![70 1][]

注:最新的日志，都在logFile.log文件中。

注:虽然我们限制了单个log文件的大小，但是其并不是严格的，即:一般会在超过界限大小不多后，进行日志文件的拆分。

注:上述配置有两个“淘汰”，第一个是“非当天的日志，淘汰”;第二个是“超过了指定大小的日志，淘汰”;由于本人测试时间的原因，这里只体现了第二个;其实第一个也是有效的。

代码中使用logback的示例

import org.junit.Test; 
       import org.junit.runner.RunWith; 
       import org.slf4j.Logger; 
       import org.slf4j.LoggerFactory; 
       import org.springframework.beans.factory.annotation.Autowired; 
       import org.springframework.boot.test.context.SpringBootTest; 
       import org.springframework.test.context.junit4.SpringRunner; 
       
       import com.alibaba.fastjson.JSON; 
       import com.aspire.mapper.JavaAnnotationMapper; 
       import com.aspire.model.Employee; 
       import com.aspire.util.ExceptionUtil; 
       
       @RunWith(SpringRunner.class) 
       @SpringBootTest(classes = { AbcLogbackDemoApplication.class }) 
       public class AbcLogbackDemoApplicationTests { 
       
       /** 自动装配 */ 
       @Autowired 
       JavaAnnotationMapper javaAnnotationMapper; 
       
       /** Logger实例 */ 
       static final Logger logger = LoggerFactory.getLogger(AbcLogbackDemoApplicationTests.class); 
       
       /** 
       * logback测试 
       * 
       * @date 2018年7月26日 下午4:12:56 
       */ 
       @Test 
       public void logbackTest() { 
       logger.info( "进入logbackTest方法了！"); 
       try { 
       Employee employee = new Employee( "邓某", 24, "男"); 
       logger.info( "employee对象的相应参数为:" + JSON.toJSONString(employee)); 
       javaAnnotationMapper.singleInsertAutoGetKey(employee); 
       Integer id = employee.getId(); 
       logger.info( "向表中插入employee对象的数据后,自动获取到的主键为:" + id); 
       // System.out.println(1 / 0); 
       } catch (Exception e) { 
       logger.error( "出错咯！错误信息:" + e.getMessage(), e.getCause()); 
       // 打印出错误堆栈信息 
       e.printStackTrace(); 
       } 
       logger.info( "SpringBoot使用logback示例。"); 
       logger.info( "logbackTest方法执行完毕!"); 
       } 
       
       }

注:SpringBoot中使用logback时，e.printStackTrace();既能将错误栈信息输出到console,又能将错误信息输出到logback中。

注:如果有的日志框架不能将e.printStackTrace()的信息打印到日志文件中，那么我们可以使用下面这个工具类，将错误栈信息转化为字符串，然后手动打印到日志文件中。

给出将e.printStackTrace()的信息转化为字符串的工具类

import java.io.IOException; 
       import java.io.PrintWriter; 
       import java.io.StringWriter; 
       
       /** 
       * 异常工具类 
       * 
       * @author JustryDeng 
       * @date 2018年7月27日 上午1:32:44 
       */ 
       public class ExceptionUtil { 
       
       /** 
       * 将异常堆栈 信息 转换为字符串 
       * 
       * @param e 
       * 异常 
       * @return 该异常的错误堆栈信息 
       * @date 2018年7月27日 上午1:35:27 
       */ 
       public static String getStackTraceMessage(Exception e) { 
       StringWriter sw = null; 
       PrintWriter pw = null; 
       try { 
       sw = new StringWriter(); 
       pw = new PrintWriter(sw); 
       // 将异常的的堆栈信息输出到printWriter中 
       e.printStackTrace(pw); 
       pw.flush(); 
       sw.flush(); 
       } finally { 
       if (sw != null) { 
       try { 
       sw.close(); 
       } catch (IOException e1) { 
       e1.printStackTrace(); 
       } 
       } 
       if (pw != null) { 
       pw.close(); 
       } 
       } 
       return sw.toString(); 
       } 
       }

[70]: /images/20220517/5503ab9ec8ab4b37a0cb364281cee5d7.png
[70 1]: /images/20220517/4ae6daa35bb041efb2167cff9fcee48e.png