log4j2扩展日志输出功能

  有时候日志输出可能需要对日志信息做额外的处理,拿最简单的例子来说,我想把输出的日志信息全都转成大写,

复杂一点的要求可能有把日志里面的敏感信息进行脱敏处理,例如手机号在日志里面打印出131****96,而非真实的

电话号码,这就需要对日志输出框架进行拓展了,以log4j输出框架为例,创建maven工程实现一个将日志中的信息

在输出的时候全部转成大写输出,步骤如下:

1、利用idea开发工具创建一个空的Maven工程,工程名称随便填写,这里写为LogExtention

2、选定LogExtention工程,右键创建一个module,名称记为common,用于定义功能类,这些功能类会处理日志信息,

如下图:

log4j2扩展日志输出功能

 

 

 3、创建日志输出功能拓展工程模块log4j-extend,创建同上,创建结果如下图:

pom.xml 依赖有以下内容:

<dependencies>
<!--log4j2 核心依赖-->
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-core</artifactId>
<version>2.13.3</version>
</dependency>
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-api</artifactId>
<version>2.13.3</version>
</dependency>
<!--日志信息处理功能依赖-->
<dependency>
<groupId>org.example</groupId>
<artifactId>common</artifactId>
<version>1.0-SNAPSHOT</version>
<scope>compile</scope>
</dependency>
</dependencies>

定义一个功能拓展类,需要继承LogEventPatternConverter,具体代码实现如下

package log4j.extend;
import common.fun.CommFun;
import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.config.plugins.Plugin;
import org.apache.logging.log4j.core.pattern.ConverterKeys;
import org.apache.logging.log4j.core.pattern.LogEventPatternConverter;
import org.apache.logging.log4j.core.pattern.PatternConverter;
import org.apache.logging.log4j.message.Message;

@Plugin(name = "Log4j2DesensitizationMessagePatternConverter", category = PatternConverter.CATEGORY)
@ConverterKeys({"extendMsg"})
public class Log4jExtend extends LogEventPatternConverter {

/**
* Constructs an instance of LoggingEventPatternConverter.
*
* @param name name of converter.
* @param style CSS style for output.
*/
protected Log4jExtend(String name, String style) {
super(name, style);
}

public static Log4jExtend newInstance(final String[] options) {
return new Log4jExtend("extendMsg","extendMsg");
}

@Override
public void format(LogEvent event, StringBuilder toAppendTo) {
Message message=event.getMessage();
String msg=message.getFormattedMessage();
if(msg!=null){
       //调用我们的功能类,见图1
toAppendTo.append(CommFun.convert(msg));
}
}
}
这里有一个关键性的注解@ConverterKeys,它定义了我们在xml配置文件中需要输出的日志的变量名,
同时需要定义一个newInstance(final String[] options)方法,否则xml配置文件配置了该类所在
package位置时,运行代码会提示错误。以上两个module创建好后,log4j2的输出信息处理扩展就完
成了,下面试一下功能。
4、创建一个logTest模块,在pom依赖中添加log4j-extend,将日志扩展功能引进来,如下图:
log4j2扩展日志输出功能

 在resources文件夹下创建log4j.xml文件,文件内容定义如下:

<?xml version="1.0" encoding="UTF-8"?>
<!--Configuration后面的status,这个用于设置log4j2自身内部的信息输出,可以不设置,当设置成trace时,
你会看到log4j2内部各种详细输出-->
<!--monitorInterval:Log4j能够自动检测修改配置 文件和重新配置本身,设置间隔秒数-->
<configuration monitorInterval="5"
packages="log4j.extend">
<!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->

<!--变量配置-->
<Properties>
<!-- 格式化输出:%date表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度 %msg:日志消息,%n是换行符-->
<!-- %logger{36} 表示 Logger 名字最长36个字符 -->
<property name="LOG_PATTERN"
value="%extendMsg%n" />
<!-- 定义日志存储的路径 -->
<property name="FILE_PATH" value="../log" />
<!--项目名称-->
<property name="FILE_NAME" value="log4j2" />
</Properties>

<appenders>

<console name="Console" target="SYSTEM_OUT">
<!--输出日志的格式-->
<PatternLayout pattern="${LOG_PATTERN}"/>
<!--控制台只输出level及其以上级别的信息(onMatch),其他的直接拒绝(onMismatch)-->
<ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
</console>

<!--文件会打印出所有信息,这个log每次运行程序会自动清空,由append属性决定,适合临时测试用-->
<File name="Filelog" fileName="${FILE_PATH}/test.log" append="false">
<PatternLayout pattern="${LOG_PATTERN}"/>
</File>

<!-- 这个会打印出所有的info及以下级别的信息,每次大小超过size,
则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩,作为存档-->
<RollingFile name="RollingFileInfo"
fileName="${FILE_PATH}/${FILE_NAME}/info.log"
filePattern="${FILE_PATH}/${FILE_NAME}-INFO-%d{yyyy-MM-dd}_%i.log.gz">
<!--控制台只输出level及以上级别的信息(onMatch),其他的直接拒绝(onMismatch)-->
<ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
<PatternLayout pattern="${LOG_PATTERN}"/>
<Policies>
<!--interval属性用来指定多久滚动一次,默认是1 hour-->
<TimeBasedTriggeringPolicy interval="1"/>
<SizeBasedTriggeringPolicy size="10MB"/>
</Policies>
<!-- DefaultRolloverStrategy属性如不设置,则默认为最多同一文件夹下7个文件开始覆盖-->
<DefaultRolloverStrategy max="15"/>
</RollingFile>

<!-- 这个会打印出所有的warn及以下级别的信息,每次大小超过size,
则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩,作为存档-->
<RollingFile name="RollingFileWarn"
fileName="${FILE_PATH}/${FILE_NAME}/warn.log"
filePattern="${FILE_PATH}/${FILE_NAME}-WARN-%d{yyyy-MM-dd}_%i.log.gz">
<!--控制台只输出level及以上级别的信息(onMatch),其他的直接拒绝(onMismatch)-->
<ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
<PatternLayout pattern="${LOG_PATTERN}"/>
<Policies>
<!--interval属性用来指定多久滚动一次,默认是1 hour-->
<TimeBasedTriggeringPolicy interval="1"/>
<SizeBasedTriggeringPolicy size="10MB"/>
</Policies>
<!-- DefaultRolloverStrategy属性如不设置,则默认为最多同一文件夹下7个文件开始覆盖-->
<DefaultRolloverStrategy max="15"/>
</RollingFile>

<!-- 这个会打印出所有的error及以下级别的信息,每次大小超过size,
则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩,作为存档-->
<RollingFile name="RollingFileError"
fileName="${FILE_PATH}/${FILE_NAME}/error.log"
filePattern="${FILE_PATH}/${FILE_NAME}-ERROR-%d{yyyy-MM-dd}_%i.log.gz">
<!--控制台只输出level及以上级别的信息(onMatch),其他的直接拒绝(onMismatch)-->
<ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
<PatternLayout pattern="${LOG_PATTERN}"/>
<Policies>
<!--interval属性用来指定多久滚动一次,默认是1 hour-->
<TimeBasedTriggeringPolicy interval="1"/>
<SizeBasedTriggeringPolicy size="10MB"/>
</Policies>
<!-- DefaultRolloverStrategy属性如不设置,则默认为最多同一文件夹下7个文件开始覆盖-->
<DefaultRolloverStrategy max="15"/>
</RollingFile>

</appenders>

<!--Logger节点用来单独指定日志的形式,比如要为指定包下的class指定不同的日志级别等。-->
<!--然后定义loggers,只有定义了logger并引入的appender,appender才会生效-->
<loggers>

<!--过滤掉spring和mybatis的一些无用的DEBUG信息-->
<logger name="org.mybatis" level="info" additivity="false">
<AppenderRef ref="Console"/>
</logger>
<!--监控系统信息-->
<!--若是additivity设为false,则 子Logger 只会在自己的appender里输出,
而不会在 父Logger 的appender里输出。-->
<Logger name="org.springframework" level="info" additivity="false">
<AppenderRef ref="Console"/>
</Logger>
<!-- 异步日志输出 -->
<!-- <AsyncRoot level="info">-->
<!-- <appender-ref ref="Console"/>-->
<!-- <appender-ref ref="Filelog"/>-->
<!-- <appender-ref ref="RollingFileInfo"/>-->
<!-- <appender-ref ref="RollingFileWarn"/>-->
<!-- <appender-ref ref="RollingFileError"/>-->
<!-- </AsyncRoot>-->
<!-- 同步日志输出 -->
<root level="info">
<appender-ref ref="Console"/>
<appender-ref ref="Filelog"/>
<appender-ref ref="RollingFileInfo"/>
<appender-ref ref="RollingFileWarn"/>
<appender-ref ref="RollingFileError"/>
</root>
</loggers>
</configuration>
注意上面的<configuration packages="log4j.extend">,这里packages中写的是Log4jExtend扩展
类所在的包位置;<properties>中有一些配置定义,日志输出格式定义:
<property name="LOG_PATTERN"
value="%extendMsg%n" />

这里面的value="%extendMsg%就是@ConverterKeys注解中定义的关键字。配置信息至此定义完毕,
创建测试类进行测试:
package log.test;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.core.config.ConfigurationSource;
import org.apache.logging.log4j.core.config.Configurator;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;

public class Main {
static Logger logger= LogManager.getLogger(Main.class);
public static void main(String[] args) throws IOException {
ConfigurationSource src;
try{
String filePath = Main.class.getClassLoader().getResource("log4j2.xml").getFile();
src=new ConfigurationSource(new FileInputStream(new File(filePath)));
Configurator.initialize(null,src);
}catch (Exception e){
e.printStackTrace();
}
String msg="hello world";
System.out.println("msg before processing is "+msg);
logger.info(msg);
}
}

这里直接读取log4j2.xml配置文件中的配置信息,运行函数输出内容如下:

  msg before processing is hell world
  msg after processing is HELL WORLD

 

至此日志信息处理扩展功能设计完毕,一个很简单的示例,如果需要复杂的处理,则需要对common模块

中的功能类进行扩展。

 

上一篇:spring boot 集成log4jdbc 查看完整sql


下一篇:log4j2日志配置