我们知道,logback是Spring Boot自带的日志库,可以说Spring Boot对logback有着非常完美的支持,而且logback可以在Spring Boot通过配置不同的profile来满足不同环境下日志输出的需求。然而,假如我们并没有使用Spring Boot,只是用Spring与logback集成,该如何实现多profile支持呢?
首先,我们需要依赖包支持。(gradle环境)
清单1 build.gradle
//Log
compile 'org.slf4j:slf4j-api:1.7.21'
compile 'org.slf4j:jcl-over-slf4j:1.7.21'
compile group: 'ch.qos.logback', name: 'logback-classic', version: '1.2.3'
compile group: 'org.logback-extensions', name: 'logback-ext-spring', version: '0.1.4'
现在我们假定有三个环境,分别为dev(开发环境)、test(测试环境)和prod(生产环境),在src/main/resources下存在这三个logback配置文件:
- logback.dev.xml
- logback.test.xml
- logback.prod.xml
在WebApplicationInitializer中,可以通过设置ServletContext的logbackConfigLocation参数来指定配置文件的位置,而在Spring中,可以通过增加JVM参数-Dspring.profiles.active=XXX的方式设定当前激活的profile,所以我们可以通过System.getProperties("spring.profiles.active")的方式获取当前使用的profile。这样的话,我们就可以根据不同的profile拿到对应的logback配置文件。
另外,我们还需要在WebApplicationInitializer配置一个Listener。这个比较简单,一句代码servletContext.addListener(LogbackConfigListener.class)就可以搞定。
最终配置:
清单2 WebApplicationInitializer配置
package org.fhp.logbackdemo.config;
import ch.qos.logback.ext.spring.web.LogbackConfigListener;
import org.springframework.core.annotation.Order;
import org.springframework.util.StringUtils;
import org.springframework.web.WebApplicationInitializer;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
@Order(1)
public class BasicWebInitializer implements WebApplicationInitializer {
private static final String LOGCONFIG_PATH_PATTERN = "classpath:logback.%s.xml";
@Override
public void onStartup(ServletContext servletContext) throws ServletException {
/**
* 指定logback配置文件配置
*/
String springProfile = System.getProperty("spring.profiles.active");
if(StringUtils.isEmpty(springProfile)) {
springProfile = "test";
}
String logConfigPath = String.format(LOGCONFIG_PATH_PATTERN, springProfile);
System.out.println("Using logback config: " + logConfigPath);
servletContext.setInitParameter("logbackConfigLocation", logConfigPath);
/**
* 配置logback监听器
*/
servletContext.addListener(LogbackConfigListener.class);
}
}
本文为多profile配置的暴力流解决方案,还有一个相对优雅一点的方法( http://blog.youkuaiyun.com/u014527058/article/details/76824415),有兴趣的可以看看。