Java Logging之JUL系列——Filter

本文介绍日志过滤器(Filter)，顾名思义，Filter就是用来对输出的日志信息进行过滤作用的，我们可以根据很多维度来对日志信息进行过滤，比如只输出message中包含某段文本信息的日志，或者只输出某个方法中记录的日志等等。具体能根据哪些维度来过滤我们后面介绍LogRecord的时候再回顾一下。本文我只举两个例子，一个是根据具体文本信息进行过滤，另一个是根据方法名来过滤。

先简单地说一下java.util.logging.LogRecord类，该类对日志输出的过程中涉及到的各种属性进行封装，可以理解为通过LogRecord对象，我们可以获取该条日志的文本信息、日志生成的时间戳、日志来自于哪个类、日志来自于哪个方法、日志来自于哪个线程等等。日志记录器Logger对象的log方法中会将日志信息包装成一个LogRecord对象，最终会将该对象递交给Handler进行实际的输出操作，LogRecord对象可以理解为是用来在JUL日志组件当中进行数据传递的DTO(数据传输对象)。

Filter在JUL中是通过java.util.logging.Filter接口来表示的，该接口的声明如下：

@FunctionalInterface
public interface Filter {

    /**
     * Check if a given log record should be published.
     * @param record  a LogRecord
     * @return true if the log record should be published.
     */
    public boolean isLoggable(LogRecord record);
}

该接口在java8中被声明为一个函数式接口，只有一个抽象方法：boolean isLoggable(LogRecord record)，如果该方法返回true就表示不过滤掉该日志，如果返回false就表示过滤掉该日志，从而不进行输出。在实际使用过程当中需要实现我们自己的过滤器。下面我们将实现两个过滤器，一个是为了构建和谐社会，对包含"Shit"信息的日志进行过滤的shitFilter，另一个是只对某个方法如"earnMoney"中记录的日志进行输出的earnMoneyFilter。

首先我们看一下没有Filter时的代码以及输出情况：

package cn.codecrazy.study;

import java.util.logging.Logger;

public class JavaLogging {
    private static final Logger logger = Logger.getLogger(JavaLogging.class.getName());
    public static void main(String[] args) {
        logger.info("Freedom");
        logger.info("Equality");
        logger.info("Justice");
        logger.info("Rule of Law");
        logger.info("Shit! too young too simple, sometimes naive");
        earnMoney();
    }

    private static void earnMoney() {
        logger.info("earn lots of money.");
    }
}

输出如下:

八月 09, 2018 8:30:49 下午 cn.codecrazy.study.JavaLogging main
信息: Freedom
八月 09, 2018 8:30:49 下午 cn.codecrazy.study.JavaLogging main
信息: Equality
八月 09, 2018 8:30:49 下午 cn.codecrazy.study.JavaLogging main
信息: Justice
八月 09, 2018 8:30:49 下午 cn.codecrazy.study.JavaLogging main
信息: Rule of Law
八月 09, 2018 8:30:49 下午 cn.codecrazy.study.JavaLogging main
信息: Shit! too young too simple, sometimes naive
八月 09, 2018 8:30:49 下午 cn.codecrazy.study.JavaLogging earnMoney
信息: earn lots of money.

所有的信息都输出来了，下面我们定义一个shitFilter来过滤掉"Shit! too young too simple, sometimes naive"这条日志。我们可以采用lambda表达式来进行定义，当然，通过显示地实现Filter接口的方式也是可以的，为了简单起见，我们直接用lambda表达式的语法。

private static final Logger logger = Logger.getLogger(JavaLogging.class.getName());
static {
    Filter shitFilter = logRecord -> !logRecord.getMessage().contains("Shit");
    logger.setFilter(shitFilter);
}

输出为:

八月 09, 2018 8:38:06 下午 cn.codecrazy.study.JavaLogging main
信息: Freedom
八月 09, 2018 8:38:06 下午 cn.codecrazy.study.JavaLogging main
信息: Equality
八月 09, 2018 8:38:06 下午 cn.codecrazy.study.JavaLogging main
信息: Justice
八月 09, 2018 8:38:06 下午 cn.codecrazy.study.JavaLogging main
信息: Rule of Law
八月 09, 2018 8:38:06 下午 cn.codecrazy.study.JavaLogging earnMoney
信息: earn lots of money.

可以看到包含"Shit"信息的日志没有被输出来，达到了我们预期的过滤效果。同样地，我们再实现一个过滤器，用来只输出earnMoney方法中记录的日志，其他方法（如main方法）中记录的日志我们不进行输出。Filter实现如下：

private static final Logger logger = Logger.getLogger(JavaLogging.class.getName());
static {
    Filter earnMoneyFilter = logRecord -> "earnMoney".equals(logRecord.getSourceMethodName());
    logger.setFilter(earnMoneyFilter);
}

输出如下：

八月 09, 2018 8:41:09 下午 cn.codecrazy.study.JavaLogging earnMoney
信息: earn lots of money.

即只输出了我们指定的方法中记录的日志信息。相信大家可能也看出来了，能根据哪些维度进行过滤关键是看LogRecord中对外提供了哪些信息。一旦我们对LogRecord中提供的信息有了更充分的了解，我们就能根据需要创建我们自己的Filter，从而更好地控制我们日志的输出。

关于LogRecord的详细信息我们后面的文章再进行介绍。