SpringBoot之logback-spring.xml不生效的解決方法

更新時(shí)間：2018年01月11日 09:04:17 作者：加多

這篇文章主要介紹了SpringBoot之logback-spring.xml不生效的解決方法，小編覺(jué)得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧

一、前言

做新應(yīng)用就是這樣，會(huì)遇到各種問(wèn)題，昨天剛解決了加載某一個(gè)類(lèi)時(shí)候拋出了 class is not visible from class loader 的問(wèn)題，今天就有遇到了日志文件找不到的問(wèn)題，還是和二方庫(kù)有關(guān)的，下面就一一道來(lái)。

二、問(wèn)題產(chǎn)生

正常情況下在 src/main/resources 目錄放下 logback-spring.xml 的配置文件（使用logback日志系統(tǒng)），如下圖

application.properties里面設(shè)置 spring.application.name=spring-boot-demo-application

引入了一個(gè)二方包，二方包里面有 logback.xml

按照上面配置，運(yùn)行后正常情況下我們希望在 user.home/spring-boot-demo-application/logs 目錄應(yīng)該有 applicaiton.log 日志文件，然而并沒(méi)有，連 spring-boot-demo-application 這個(gè)文件夾都沒(méi)有生成。

三、問(wèn)題分析

那么我們就去看看日志系統(tǒng)是如何查找并解析日志配置文件的，SpringBoot中是使用LoggingApplicationListener這個(gè)類(lèi)來(lái)進(jìn)行日志系統(tǒng)的初始化的。LoggingApplicationListener實(shí)現(xiàn)了ApplicationListener接口，那么我們通過(guò)時(shí)序圖看LoggingApplicationListener的onApplicationEvent方法做了啥：

代碼（8）查找標(biāo)準(zhǔn)日志配置文件，什么是標(biāo)準(zhǔn)那，那么就看代碼（9）的代碼：

protected String[] getStandardConfigLocations() {
  return new String[] { "logback-test.groovy", "logback-test.xml", "logback.groovy",
    "logback.xml" };
 }

像 "logback-test.groovy", "logback-test.xml", "logback.groovy","logback.xml" 這些是標(biāo)準(zhǔn)的。

那么具體怎么查找那，要看代碼（10):

private String findConfig(String[] locations) {
  for (String location : locations) {
   ClassPathResource resource = new ClassPathResource(location,
     this.classLoader);
   if (resource.exists()) {
    return "classpath:" + location;
   }
  }
  return null;
 }

可知使用ClassPathResource類(lèi)去查找，下面看ClassPathResource的exists方法：

public boolean exists() {
  return (resolveURL() != null);
 }

 
 protected URL resolveURL() {
  if (this.clazz != null) {
   return this.clazz.getResource(this.path);
  }
  else if (this.classLoader != null) {
   return this.classLoader.getResource(this.path);
  }
  else {
   return ClassLoader.getSystemResource(this.path);
  }
 }

可知是使用 this.classLoader.getResource(this.path); 去查找這里classLoader為AppClassloader。

如果代碼（8）沒(méi)有查找到配置，則執(zhí)行點(diǎn)（12），代碼12邏輯和代碼（8）類(lèi)似只是查找文件名字不一樣，下面看下：

protected String[] getSpringConfigLocations() {
  String[] locations = getStandardConfigLocations();
  for (int i = 0; i < locations.length; i++) {
   String extension = StringUtils.getFilenameExtension(locations[i]);
   locations[i] = locations[i].substring(0,
     locations[i].length() - extension.length() - 1) + "-spring."
     + extension;
  }
  return locations;
 }

可知是在getStandardConfigLocations的文件名上拼接spring，拼接后的文件名為：

“` “l(fā)ogback-test-spring.groovy”, “l(fā)ogback-test-spring.xml”, “l(fā)ogback-spring.groovy”,”logback-spring.xml” “

綜上所述SpringBoot首先去查找標(biāo)準(zhǔn)的日志配置文件，如果找不到在去找拼接Spring的配置的文件。

那么上面我們說(shuō)了應(yīng)用中是引入了一個(gè)含有l(wèi)ogback.xml的jar包，而這個(gè)jar包也是使用appclassloader加載的，所以在執(zhí)行步驟（8）的時(shí)候找到了jar包里面的logback.xml，所以就不會(huì)再去執(zhí)行步驟（12）來(lái)找我們自定義的logback-spring.xml了。