springboot【18】日志管理之log4j

Spring Boot默认配置的是Logback日志工具，但是对于log4j，Spring Boot依然可以很好的支持，只是需要做一些小小的配置功能。

本文主要介绍如何在spring boot中引入log4j，以及一些基础用法，对于更多log4j的用法，还请参考log4j官方网站

引入log4j依赖

在创建Spring Boot工程时，我们引入了spring-boot-starter，其中包含了spring-boot-starter-logging，该依赖内容就是Spring Boot默认的日志框架Logback，所以我们在引入log4j之前，需要先排除该包的依赖，再引入log4j的依赖：

<!-- springboot 基础包 -->
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter</artifactId>
	<exclusions>
		<exclusion>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-logging</artifactId>
		</exclusion>
	</exclusions>
</dependency>

<!-- 日志管理 log4j -->
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-log4j</artifactId>
</dependency>

配置log4j.properties

在引入了log4j依赖之后，只需要在src/main/resources目录下加入log4j.properties配置文件，就可以开始对应用的日志进行配置使用。

控制台输出

通过如下配置，设定root日志的输出级别为INFO，appender为控制台输出stdout

# LOG4J配置
log4j.rootCategory=INFO, stdout
# 控制台输出
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss,SSS} %5p %c{1}:%L - %m%n

输出到文件

在开发环境，我们只是输出到控制台没有问题，但是到了生产或测试环境，或许持久化日志内容，方便追溯问题原因。可以通过添加如下的appender内容，按天输出到不同的文件中去，同时还需要为log4j.rootCategory添加名为file的appender，这样root日志就可以输出到logs/all.log文件中了。

log4j.rootCategory=INFO, stdout, file
# root日志输出
log4j.appender.file=org.apache.log4j.DailyRollingFileAppender
log4j.appender.file.file=logs/all.log
log4j.appender.file.DatePattern='.'yyyy-MM-dd
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss,SSS} %5p %c{1}:%L - %m%n

分类输出

当我们日志量较多的时候，查找问题会非常困难，常用的手段就是对日志进行分类，比如：

• 可以按不同package进行输出。通过定义输出到logs/my.log的appender，并对com.lyd包下的日志级别设定为DEBUG级别、appender设置为输出到logs/my.log的名为didifile的appender。

# com.didispace包下的日志配置
log4j.category.com.lyd=DEBUG, lydfile
# com.didispace下的日志输出
log4j.appender.lydfile=org.apache.log4j.DailyRollingFileAppender
log4j.appender.lydfile.file=logs/my.log
log4j.appender.lydfile.DatePattern='.'yyyy-MM-dd
log4j.appender.lydfile.layout=org.apache.log4j.PatternLayout
log4j.appender.lydfile.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss,SSS} %5p %c{1}:%L ---- %m%n

• 可以对不同级别进行分类，比如对ERROR级别输出到特定的日志文件中，具体配置可以如下。

log4j.logger.error=errorfile
# error日志输出
log4j.appender.errorfile=org.apache.log4j.DailyRollingFileAppender
log4j.appender.errorfile.file=logs/error.log
log4j.appender.errorfile.DatePattern='.'yyyy-MM-dd
log4j.appender.errorfile.Threshold = ERROR
log4j.appender.errorfile.layout=org.apache.log4j.PatternLayout
log4j.appender.errorfile.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss,SSS} %5p %c{1}:%L - %m%n

通过运行单元测试来观察对不同内容的分类记录情况。

package com.lyd;

import org.apache.log4j.Logger;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.boot.test.SpringApplicationConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;

@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(Application.class)
public class ApplicationTest {

	private Logger logger = Logger.getLogger(getClass());
	
	@Test
	public void test(){
		logger.info("输出info");
		logger.debug("输出debug");
		logger.error("输出error");
	}
}

打印出日志：

2017-08-14 09:36:11,053  INFO ApplicationTest:17 - 输出info
2017-08-14 09:36:11,055 ERROR ApplicationTest:19 - 输出error

对log4j进行多环境不同日志级别的控制

        能我们在开发环境大部分模块需要采用DEBUG级别，在测试环境可能需要小部分采用DEBUG级别，而在生产环境时我们又希望采用INFO级别。这个时候，我们要自己手工编辑log4j.properties文件来调整日志级别，不论在版本库中默认保存哪个环境的级别设定，都会增加其他环境使用人员的工作量，而且手工修改源码很容易出错。所以进行多环境配置log4j。

• 创建多环境配置文件
  • application-dev.properties：开发环境
  • application-test.properties：测试环境
  • application-prod.properties：生产环境
• application.properties中添加属性：spring.profiles.active=dev（默认激活application-dev.properties配置）
• application-dev.properties和application-test.properties配置文件中添加日志级别定义：logging.level.com.didispace=DEBUG
• application-prod.properties配置文件中添加日志级别定义：logging.level.com.didispace=INFO

通过上面的定义，根据logging.level.com.lyd在不同环境的配置文件中定义了不同的级别，但是我们已经把日志交给了log4j管理，看看我们log4j.properties中对com.lyd包下的日志定义是这样的，固定定义了DEBUG级别，并输出到名为lydfile定义的appender中。

# LOG4J配置
log4j.category.com.lyd=DEBUG, lydfile

# com.lyd下的日志输出
log4j.appender.lydfile=org.apache.log4j.DailyRollingFileAppender
log4j.appender.lydfile.file=logs/my.log
log4j.appender.lydfile.DatePattern='.'yyyy-MM-dd
log4j.appender.lydfile.layout=org.apache.log4j.PatternLayout
log4j.appender.lydfile.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss,SSS} %5p %c{1}:%L ---- %m%n

那么，要如何动态的改变这个DEBUG级别呢？需要将DEBUG替换成application-{profile}.properties配置文件中定义logging.level.com.lyd即可，所以配置变为如下内容：

# LOG4J配置
log4j.category.com.lyd=${logging.level.com.lyd}, didifile

# com.lyd下的日志输出
log4j.appender.lydfile=org.apache.log4j.DailyRollingFileAppender
log4j.appender.lydfile.file=logs/my.log
log4j.appender.lydfile.DatePattern='.'yyyy-MM-dd
log4j.appender.lydfile.layout=org.apache.log4j.PatternLayout
log4j.appender.lydfile.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss,SSS} %5p %c{1}:%L ---- %m%n

运行单元测试，然后看my.log文件中输出的日志内容。通过修改默认的application-dev.properties配置的日志级别为INFO，再运行单元测试的DEBUG内容是否被输出到了my.log中验证参数是否被正确引用了。

对于不同环境的使用人员不需要改变代码或打包文件，只需要通过执行命令中加参数即可，比如想采用生产环境的级别，可以这样运行应用：

java -jar xxx.jar --spring.profiles.active=prod

下面是完整项目结构：