热切换Log4j日志级别

前言：

    在项目中用到了kafka、rabbitMQ等MQ，每次接收到信息的时候都将接收信息debug到本地，但是信息太多的时候，希望项目不停的情况下将debug级别切换到INFO，这样可以减少日志的输出，于是研究了两天log4j源码，具体源码笔记可参考笔者的另外两篇文章

https://blog.youkuaiyun.com/qq_26323323/article/details/80886304 

https://blog.youkuaiyun.com/qq_26323323/article/details/80888349 

1.log4j.xml配置

    笔者使用了xml的配置方式，这样Appender和Logger的配置会比较清晰，以下是配置的主要内容：

<?xml version="1.0"  encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration PUBLIC "-//APACHE//DTD LOG4J 1.2//EN" "log4j.dtd">
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">

    <!--若干个appender的定义-->
    <!--org.apache.log4j.ConsoleAppender 输出到控制台-->
    <appender name="myConsole" class="org.apache.log4j.ConsoleAppender">
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern"
                   value="%-d{yyyy-MM-dd HH:mm:ss,SSS} [%c]-[%p] %m%n"/>
        </layout>
    </appender>

    <appender name="kafkaAppender" class="org.apache.log4j.DailyRollingFileAppender">
        <param name="File" value="D:/logs/kafka.log"/>
        <param name="Append" value="true"/>
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern"
                   value="%-d{yyyy-MM-dd HH:mm:ss,SSS} [%c]-[%p] %m%n"/>
        </layout>
    </appender>

    <appender name="rabbitMQAppender" class="org.apache.log4j.RollingFileAppender">
        <param name="File" value="D:/logs/test2.log" />
        <param name="Append" value="true" />
        <param name="MaxFileSize" value="500KB"/>
        <param name="MaxBackupIndex" value="10" />
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="%-d{yyyy-MM-dd HH:mm:ss,SSS} [%c]-[%p] %m%n" />
        </layout>
    </appender>

	<logger name="kafkaLogger">
		<level value="DEBUG"/>
		<appender-ref ref="kafkaAppender"/>
	</logger>
	<logger name="rabbitMQLogger">
		<level value="DEBUG"/>
		<appender-ref ref="rabbitMQAppender"/>
	</logger>
	
    <!-- 根logger的设置-->
    <root>
        <level value="DEBUG"/>
        <!--添加刚才设置的appender-->
        <appender-ref ref="myConsole"/>
    </root>
</log4j:configuration>

    注意：笔者使用的这种方式，Logger级别不是放在Appender里的，而是具体配置在logger中，只有这样，才能保证下面的热切换代码可用

    如果将Logger级别配置在Appender中，这样在热切换代码中操作的就是Appender类了，主动修改Appender的Threshold，这样才能生效

2.热切换日志级别

    1）maven依赖

    笔者使用的是Spring-boot，具体log4j版本，用户可参考使用

<!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-log4j -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j</artifactId>
    <version>1.3.6.RELEASE</version>
</dependency>

     2）Controller层代码

@RestController
@RequestMapping("/log4j")
public class HotChangeLog4jLevel {

	@Autowired
	private Log4jConfig log4jConfig;
	
	/**
	 * 修改日志级别
	 * @param loggerName
	 * @param level
	 * @return
	 */
	@RequestMapping("/update/{loggerName:.+}/{level}")
	public String updateLevel(@PathVariable("loggerName")String loggerName,@PathVariable("level")String level){
		
		log4jConfig.updateLevel(loggerName, level);
		return "success";
	}
	
	/**
	 * 查询日志级别
	 * @param loggerName
	 * @param level
	 * @return
	 */
	@RequestMapping("/query/{loggerName:.+}")
	public String queryLevel(@PathVariable("loggerName")String loggerName){
		
		return log4jConfig.queryLevel(loggerName);
	}
}

    3）Service层代码

import java.util.stream.Stream;

import org.apache.commons.lang3.StringUtils;
import org.apache.log4j.Level;
import org.apache.log4j.LogManager;
import org.apache.log4j.Logger;
import org.springframework.stereotype.Component;

@Component
public class Log4jConfig {

	/**
	 * 修改Logger的日志级别
	 * @param loggerName
	 * @param level
	 */
	public void updateLevel(String loggerName, String level){
		if(StringUtils.isNotBlank(level)){
			final String levelUpper = level.toUpperCase();// 转换为大写进行比较
			
			// 获取Logger对象，修改Logger对象的Level
			Logger logger = loggerName.equalsIgnoreCase("ROOT") ? LogManager.getRootLogger() : LogManager.getLogger(loggerName);
			if(null != logger && null != logger.getLevel()){
				Stream.of(LogLevel.values()).forEach(logLevel -> {
					if(levelUpper.equals(logLevel.levelInfo)){
						logger.setLevel(logLevel.level);// 主要就是这里
					}
				});
			}
		}
	}
	
	/**
	 * 查看Logger的日志级别
	 * @param loggerName
	 * @return
	 */
	public String queryLevel(String loggerName){
	
		if(StringUtils.isNoneBlank(loggerName)){
			Logger logger = loggerName.equalsIgnoreCase("ROOT") ? LogManager.getRootLogger() : LogManager.getLogger(loggerName);
			if(null != logger && null != logger.getLevel()){
				return logger.getLevel().toString();
			}

		}
		return "no_level";
	}
	
	enum LogLevel{
		OFF("OFF",Level.OFF),
		FATAL("FATAL",Level.FATAL),
		ERROR("ERROR",Level.ERROR),
		WARN("WARN",Level.WARN),
		INFO("INFO",Level.INFO),
		DEBUG("DEBUG",Level.DEBUG),
		TRACE("TRACE",Level.TRACE);
		
		String levelInfo;// 日志级别名称
		Level level;// 日志级别
		
		private LogLevel(String levelInfo, Level level) {
			this.levelInfo = levelInfo;
			this.level = level;
		}
	}
}

    注意：由以上可知，主要就是从LogManager中获取Logger对象，然后对Logger对象进行操作即可

    所以，可知，必须要保证在配置的时候手动配置了logger，并设置logger的级别，否则根据loggername是查不到对应的Logger对象的

    这样，用户就可以通过HTTP请求Controller层的接口，热切换对应logger的日志级别了