log4j2扩展⽇志输出功能
有时候⽇志输出可能需要对⽇志信息做额外的处理，拿最简单的例⼦来说，我想把输出的⽇志信息全都转成⼤写，复杂⼀点的要求可能有把⽇志⾥⾯的敏感信息进⾏脱敏处理，例如⼿机号在⽇志⾥⾯打印出131****96，⽽⾮真实的电话号码，这就需要对⽇志输出框架进⾏拓展了，以log4j输出框架为例，创建maven⼯程实现⼀个将⽇志中的信息在输出的时候全部转成⼤写输出，步骤如下：
1、利⽤idea开发⼯具创建⼀个空的Maven⼯程，⼯程名称随便填写，这⾥写为LogExtention
2、选定LogExtention⼯程，右键创建⼀个module，名称记为common,⽤于定义功能类，这些功能类会处理⽇志信息，如下图：
3、创建⽇志输出功能拓展⼯程模块log4j-extend，创建同上，创建结果如下图：
<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&le</groupId>
<artifactId>common</artifactId>
<version>1.0-SNAPSHOT</version>
<scope>compile</scope>
</dependency>
</dependencies>
定义⼀个功能拓展类，需要继承LogEventPatternConverter，具体代码实现如下
d;
import common.fun.CommFun;
import org.apache.LogEvent;
import org.apache.onfig.plugins.Plugin;
import org.apache.pattern.ConverterKeys;
import org.apache.pattern.LogEventPatternConverter;
import org.apache.pattern.PatternConverter;
import org.apache.ssage.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();
String FormattedMessage();
if(msg!=null){
//调⽤我们的功能类，见图1
toAppendTo.vert(msg));
}
}
}
这⾥有⼀个关键性的注解@ConverterKeys，它定义了我们在xml配置⽂件中需要输出的⽇志的变量名，
同时需要定义⼀个newInstance(final String[] options)⽅法，否则xml配置⽂件配置了该类所在
package位置时，运⾏代码会提⽰错误。以上两个module创建好后，log4j2的输出信息处理扩展就完
成了，下⾯试⼀下功能。
4、创建⼀个logTest模块，在pom依赖中添加log4j-extend，将⽇志扩展功能引进来，如下图：
在resources⽂件夹下创建l⽂件，⽂件内容定义如下：
<?xml version="1.0" encoding="UTF-8"?>
<!--Configuration后⾯的status，这个⽤于设置log4j2⾃⾝内部的信息输出，可以不设置，当设置成trace时，
你会看到log4j2内部各种详细输出-->
<!--monitorInterval：Log4j能够⾃动检测修改配置⽂件和重新配置本⾝，设置间隔秒数-->
<configuration monitorInterval="5"
packages="d">
<!--⽇志级别以及优先级排序: 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}_%">
<!--控制台只输出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}_%">
<!--控制台只输出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}_%">
<!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
<ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
<PatternLayout pattern="${LOG_PATTERN}"/>
<Policies>log4j2不打印日志
<!--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="batis" 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="d">，这⾥packages中写的是Log4jExtend扩展
类所在的包位置;<properties>中有⼀些配置定义，⽇志输出格式定义：
<property name="LOG_PATTERN"
value="%extendMsg%n" />
这⾥⾯的value="%extendMsg%就是@ConverterKeys注解中定义的关键字。配置信息⾄此定义完毕，
创建测试类进⾏测试：
st;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.apache.onfig.ConfigurationSource;
import org.apache.onfig.Configurator;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
public class Main {
static Logger logger= Logger(Main.class);
public static void main(String[] args) throws IOException {
ConfigurationSource src;
try{
String filePath = ClassLoader().getResource("l").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);
}
}
这⾥直接读取l配置⽂件中的配置信息，运⾏函数输出内容如下：
msg before processing is hell world
msg after processing is HELL WORLD
⾄此⽇志信息处理扩展功能设计完毕，⼀个很简单的⽰例，如果需要复杂的处理，则需要对common模块中的功能类进⾏扩展。
版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。
发表评论