Log4j自定义Appender

131 阅读 0 评论 87 点赞

我是靠谱客的博主甜蜜鞋子，这篇文章主要介绍Log4j自定义Appender，现在分享给大家，希望可以做个参考。

log4j 环境包括三个主要组件：

logger（日志记录器）: 控制要启用或者禁用哪些日志记录语句。可以对日志记录器制定如下级别：

　　ALL、DEBUG、INFO、WARN、ERROR、FATA、OFF。

layout（布局）：根据用户的愿望格式化日志记录请求。

appender：向目的地发送格式化的输出。log4j自带了还记中appender如下：

ConsoleAppender
FileAppender
SMTPAppender
JDBCAppender
JMSAppender
NTEventAppender
SyslogAppender

也可以创建自定义的Appender

******************************************************华丽的分割丰富********************************************************************************

创建自定义的Appender

1. 继承AppenderSkeleton类，实现三个方法(也可以继承已有的Appender，重写某些方法，实现需要的逻辑)

复制代码

public class SimpleAppender extends AppenderSkeleton {

//在log4j.xml中配置需要的属性，此处可以注入
    private String developer;

/**
     * 激活各组件的方法
     * Appender初始的时候被调用
     */
    @Override
    public void activateOptions() {
        init();
        super.activateOptions();
    }

/**
     * 自定义初始化方法
     */
    private void init(){
        if (this.layout == null) {
            LogLog.debug("The layout is not loaded... we set it.");
            String pattern = "[%-5p][%d{yyyy/MM/dd HH:mm:ss}][%X{TRACE_ID}][%X{LOGGER_FILTER1}][%X{LOGGER_FILTER2}][%l][%m]%n";
            this.setLayout(new org.apache.log4j.PatternLayout(pattern));
        }
    }

@Override
    protected void append(LoggingEvent loggingEvent) {
        String str = "======" + developer + " Test========" + this.getLayout().format(loggingEvent);
        System.out.println(str);
        writeLogAsync(str);
    }

/**
     * 异步输出log
     * @param value
     */
    private void writeLogAsync(String value){
        CompletableFuture.runAsync(() -> {
            writeLog(value);
        });
    }

/**
     * @param value
     */
    private void writeLog(String value) {
        //可以记录到数据库、本地、缓存等
    }

@Override
    public boolean requiresLayout() {
        //是否需要布局，如果返回false，即使log4j.xml配置了layout也不生效。
        return false;
    }

@Override
    public void close() {
        //释放资源
        this.closed = true;
    }

public String getDeveloper() {
        return developer;
    }

public void setDeveloper(String developer) {
        this.developer = developer;
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
public class SimpleAppender extends AppenderSkeleton {

    //在log4j.xml中配置需要的属性，此处可以注入
    private String developer;

    /**
     * 激活各组件的方法
     * Appender初始的时候被调用
     */
    @Override
    public void activateOptions() {
        init();
        super.activateOptions();
    }

    /**
     * 自定义初始化方法
     */
    private void init(){
        if (this.layout == null) {
            LogLog.debug("The layout is not loaded... we set it.");
            String pattern = "[%-5p][%d{yyyy/MM/dd HH:mm:ss}][%X{TRACE_ID}][%X{LOGGER_FILTER1}][%X{LOGGER_FILTER2}][%l][%m]%n";
            this.setLayout(new org.apache.log4j.PatternLayout(pattern));
        }
    }

    @Override
    protected void append(LoggingEvent loggingEvent) {
        String str = "======" + developer + " Test========" + this.getLayout().format(loggingEvent);
        System.out.println(str);
        writeLogAsync(str);
    }

    /**
     * 异步输出log
     * @param value
     */
    private void writeLogAsync(String value){
        CompletableFuture.runAsync(() -> {
            writeLog(value);
        });
    }

    /**
     * @param value
     */
    private void writeLog(String value) {
        //可以记录到数据库、本地、缓存等
    }

    @Override
    public boolean requiresLayout() {
        //是否需要布局，如果返回false，即使log4j.xml配置了layout也不生效。
        return false;
    }

    @Override
    public void close() {
        //释放资源
        this.closed = true;
    }

    public String getDeveloper() {
        return developer;
    }

    public void setDeveloper(String developer) {
        this.developer = developer;
    }
}

　　继承已有的Appender

复制代码

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
public class SimpleFileAppender extends RollingFileAppender {
    @Override
    protected void subAppend(LoggingEvent event) {
        //在此可以做一些过滤，或者格式的调整
        qw.write("======SimpleFileAppender Test========" + this.layout.format(event));

        if (layout.ignoresThrowable()) {
            String[] s = event.getThrowableStrRep();
            if (s != null) {
                int len = s.length;
                for (int i = 0; i < len; i++) {
                    this.qw.write(s[i]);
                    this.qw.write(Layout.LINE_SEP);
                }
            }
        }

        if (this.immediateFlush) {
            this.qw.flush();
        }
        if ((fileName != null) && ((CountingQuietWriter) qw).getCount() >= maxFileSize)
            super.rollOver();
    }
}

2.配置log4j.xml

复制代码

<appender name="simpleAppender" class="com.cn.simple.logger.SimpleAppender">
        <param name="developer" value="lqw"></param>
        <layout class="org.apache.log4j.PatternLayout">
            <param name='ConversionPattern' value='[%-5p][%d{yyyy/MM/dd HH:mm:ss}][%X{TRACE_ID}][%X{LOGGER_FILTER1}][%X{LOGGER_FILTER2}][%l][%m]%n'/>
        </layout>
    </appender>

<logger name="com.cn.simple.controller">
        <level value="info" ></level>
        <appender-ref ref="simpleAppender" ></appender-ref>
    </logger>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
<!--自定义Appender-->
    <appender name="simpleAppender" class="com.cn.simple.logger.SimpleAppender">
        <param name="developer" value="lqw"></param>
        <layout class="org.apache.log4j.PatternLayout">
            <param name='ConversionPattern' value='[%-5p][%d{yyyy/MM/dd HH:mm:ss}][%X{TRACE_ID}][%X{LOGGER_FILTER1}][%X{LOGGER_FILTER2}][%l][%m]%n'/>
        </layout>
    </appender>

    <appender name="simpleFileAppender" class="com.cn.simple.logger.SimpleFileAppender">
        <param name="file" value="${project.home}/logs/simpleAppender-soa.log"/>
        <param name="append" value="true"/>
        <param name="maxFileSize" value="100MB"/>
        <param name="maxBackupIndex" value="10"/>
        <layout class="org.apache.log4j.PatternLayout">
            <param name='ConversionPattern' value='[%-5p][%d{yyyy/MM/dd HH:mm:ss}][%X{TRACE_ID}][%X{LOGGER_FILTER1}][%X{LOGGER_FILTER2}][%l][%m]%n'/>
        </layout>
    </appender>

    <!-- Application Loggers -->
    <logger name="com.cn.simple.controller">
        <level value="info" />
        <appender-ref ref="simpleAppender" />
    </logger>

    <logger name="com.cn.simple.controller.SimpleController">
        <level value="info" />
        <appender-ref ref="simpleFileAppender" />
    </logger>

3.执行

复制代码

1
2
3
logger.info("[springDemo]--------info信息");
        logger.warn("[springDemo]--------warn提醒");
        logger.error("[springDemo]--------error异常");

4.输出结果

复制代码

1
2
3
4
5
======lqw Test========[INFO ][2017/09/06 15:29:09][123456][filter1][filter2][com.cn.simple.controller.SimpleController.str(SimpleController.java:82)][[springDemo]--------info信息]

======lqw Test========[WARN ][2017/09/06 15:29:09][123456][filter1][filter2][com.cn.simple.controller.SimpleController.str(SimpleController.java:83)][[springDemo]--------warn提醒]

======lqw Test========[ERROR][2017/09/06 15:29:09][123456][filter1][filter2][com.cn.simple.controller.SimpleController.str(SimpleController.java:84)][[springDemo]--------error异常]