Java Logging之JUL系列——LogRecord

上文提到过，LogRecord可以理解为是一个DTO，那么LogRecord里面到底存储了哪些数据呢？我们可以看一下LogRecord类中含有哪些get/set方法，get方法如下所示：

Level getLevel()
String getLoggerName()
String getMessage()
long getMillis()
Object[] getParameters()
ResourceBundle getResourceBundle()
String getResourceBundleName()
long getSequenceNumber()
String getSourceClassName()
String getSourceMethodName()
int getThreadID()
Throwable getThrown()

每个get方法都有相应的set方法。

在记录日志的过程中可以直接使用LogRecord对象，也可以不直接使用LogRecord对象，而是由日志组件内部为我们自动组装成一个LogRecord对象。我们之前通过logger.info这一类方法记录日志时，内部会根据我们传入的参数以及调用的方法自动组装成一个LogRecord对象。例如：

logger.info("Hello")

该方法首先转调方法logger.log(Level.INFO, “Hello”),该方法内部自动帮我们创建了LogRecord：

public void log(Level level, String msg) {
    if (!isLoggable(level)) {
        return;
    }
    LogRecord lr = new LogRecord(level, msg);
    doLog(lr);
}
1
2
3
4
5
6
7

LogRecord给我们提供了一个含有两个参数的构造方法，第一个参数指定需要记录的信息的级别，第二个参数指定需要记录的信息，即:

public LogRecord(Level level, String msg) {
    // Make sure level isn't null, by calling random method.
    level.getClass();
    this.level = level;
    message = msg;
    // Assign a thread ID and a unique sequence number.
    sequenceNumber = globalSequenceNumber.getAndIncrement();
    threadID = defaultThreadID();
    millis = System.currentTimeMillis();
    needToInferCaller = true;
}
1
2
3
4
5
6
7
8
9
10
11

当然我们也可以直接构造LogRecord对象，然后通过Logger.log(LogRecord record)方法来记录日志，如下所示：

public class JavaLogging {
    private static final Logger logger = Logger.getLogger(JavaLogging.class.getName());
    public static void main(String[] args) {
        LogRecord infoLogRecord = new LogRecord(Level.INFO, "info");
        LogRecord severeLogRecord = new LogRecord(Level.SEVERE, "severe");
        logger.log(infoLogRecord);
        logger.log(severeLogRecord);
    }
}
1
2
3
4
5
6
7
8
9

但这样做显然不太方便，还是通过logger.info，logger.warning这一类方法来记录日志更简便，当然这一类方法也有他们的局限处，比如无法传递Throwable类型的异常信息等。
getLevel()方法返回的就是当前日志信息的级别，即通过logger.info方法调用时，当前日志信息的级别为INFO级别，通过logger.severe方法调用时，当前日志信息级别为SEVERE级别。JUL中的级别涉及如下三个方面：

• 日志记录器(Logger)的级别
• 当前需要记录的日志信息（message）的级别
• 真正执行日志记录操作的Handler的级别

我们是要将当前需要记录的日志信息的级别与日志记录器Logger的级别以及Handler的级别相比较，只有高于或等于他们的信息才会被记录。首先是与Logger的级别进行比较，如果低于Logger的级别则直接不输出，如果高于或等于Logger的级别，到真正执行输出时还需要跟Handler的级别进行比较。

getLoggerName()方法是获取当前日志记录器名字，日志记录器名字就是调用Logger.getLogger(String name)方法时传入的参数，在我们的例子中就是cn.codecrazy.study.JavaLogging。

getMillis()返回值默认就是创建LogRecord对象时的当前系统时间戳（从1970年到现在所经过的毫秒数），millis属性值是在LogRecourd的构造方法中进行赋值的。

getThrown()方法返回Throwable类型的信息，即获取异常信息，我们目前为止记录的日志信息只是记录一段message，并没有记录发生异常时的异常堆栈信息，要记录这种类型的信息，我们需要通过Logger.log()方法来进行日志的记录，Logger.log有几种重载的方法，其中有一种就能传递Throwable信息，该方法如下所示:

public void log(Level level, String msg, Throwable thrown) {
    if (!isLoggable(level)) {
        return;
    }
    LogRecord lr = new LogRecord(level, msg);
    lr.setThrown(thrown);
    doLog(lr);
}
1
2
3
4
5
6
7
8

可以看到将传入的Throwable类型参数赋值给了LogRecord对象的thrown属性，因此在LogRecord中通过getThrown()方法就能获取到传入的Throwable信息，最终可以对异常堆栈信息进行输出。示例代码如下：

public class JavaLogging {
    private static final Logger logger = Logger.getLogger(JavaLogging.class.getName());
    public static void main(String[] args) {
        logger.log(Level.SEVERE, "error", new NullPointerException("NPE"));
    }
}
1
2
3
4
5
6

输出为：

八月 10, 2018 9:02:42 下午 cn.codecrazy.study.JavaLogging main
严重: error
java.lang.NullPointerException: NPE
    at cn.codecrazy.study.JavaLogging.main(JavaLogging.java:11)
1
2
3
4

getSourceClassName()方法用来获取记录日志的操作是在哪个类中进行的，在我们的例子中该方法的返回值就是cn.codecrazy.study.JavaLogging。

getSourceMethodName()方法用来获取记录日志的操作是在哪个方法中进行的，在我们的例子中该方法的返回值就是main。

需要注意一点的是，上述两个方法所获取的类名和方法名有可能是不正确的。如果我们在记录日志的过程中没有主动设置这两个属性的值，那么这两个属性的值就会被自动推断出来，推断出来的结果有可能就会出现偏差。我们可以看一下getSourceClassName()方法内部实现：

    public String getSourceClassName() {
        if (needToInferCaller) {
            inferCaller();
        }
        return sourceClassName;
    }
1
2
3
4
5
6

可以看到如果needToInferCaller的值为true时，就会执行inferCaller方法对发起记录日志请求操作的类名和方法名进行推断，关于如何推断我们在这里不进行深入研究。
getSequenceNumber()为每一个LogRecord对象都赋予一个唯一的序号，从0开始。每创建一个LogRecord对象该值就增加1，在LogRecord的构造方法中给该属性赋值：
sequenceNumber = globalSequenceNumber.getAndIncrement();
globalSequenceNumber的声明如下：
private static final AtomicLong globalSequenceNumber         = new AtomicLong(0);

可以看出在系统运行期间，每一个LogRecord对象都有一个唯一的编号。
getThreadId()方法获取当前线程的id,需要注意的是该id有可能不是真正的线程id,构造方法中是通过如下语句对threadId进行赋值的：
threadID = defaultThreadID();

defaultThreadID()方法如下：

private int defaultThreadID() {
    long tid = Thread.currentThread().getId();
    if (tid < MIN_SEQUENTIAL_THREAD_ID) {
        return (int) tid;
    } else {
        Integer id = threadIds.get();
        if (id == null) {
            id = nextThreadId.getAndIncrement();
            threadIds.set(id);
        }
        return id;
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13

可以看到通过Thread.currentThread().getId()获取的线程id是long类型的，但是LogRecord中的threadId字段是int类型的，因此它们之间没办法做到一一对应，参考JDK-6278014
getResourceBundle()和getResourceBundleName()以及getParameters()方法都是与日志信息本地化相关的，本地化与国际化我觉得是同一个概念的两个不同角度，只有支持国际化才有所谓的在不同地区的本地化，我们不咬文嚼字了。关于本地化或者说国际化的相关内容，我之前的一片文章《Tomcat7.0源码分析——国际化》有所涉及，这里就不再详细论述了，getParameters方法中获取到的参数就是用来格式化带有占位符的文本信息的。如果getResourceBundle()不为null，则说明要进行本地化输出，那么这个时候最外层传入的message字段代表的就是key，通过该key去获取到对应的value，如果对应的value找不到，则把key当成value，然后再判断parameters数组中是否有值，如果有值，则需要用这些值去替换掉value中的占位符。如果getResourceBundle()方法返回null，则不需要进行本地化，那么最外层传入的message就是真正要进行输出的信息，message中可能含有占位符，此时还需要判断parameters数组中是否有值，如果有值，还需要一一替换掉message中的占位符，然后进行输出，我们来看一下parameters是如何使用的：

public class JavaLogging {
    private static final Logger logger = Logger.getLogger(JavaLogging.class.getName());
    public static void main(String[] args) {
        logger.log(Level.INFO, "Hello, {0}", "World");
        logger.log(Level.INFO, "{0}{1}{2}", new Object[]{"Log", 4, 'J'});
    }
}
1
2
3
4
5
6
7

上述代码中分别调用了Logger的如下两个方法：

public void log(Level level, String msg, Object param1) {
    if (!isLoggable(level)) {
        return;
    }
    LogRecord lr = new LogRecord(level, msg);
    Object params[] = { param1 };
    lr.setParameters(params);
    doLog(lr);
}

public void log(Level level, String msg, Object params[]) {
    if (!isLoggable(level)) {
        return;
    }
    LogRecord lr = new LogRecord(level, msg);
    lr.setParameters(params);
    doLog(lr);
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

这两个方法本质上都是一样的，内部在构造LogRecord时对parameters属性进行赋值。输出结果如下所示:

八月 11, 2018 4:22:05 下午 cn.codecrazy.study.JavaLogging main
信息: Hello, World
八月 11, 2018 4:22:05 下午 cn.codecrazy.study.JavaLogging main
信息: Log4J
1
2
3
4

可以看到parameters的作用就是用来填充message中的占位符的。关于格式化的这一部分我们后面介绍Formatter组件的时候再详细论述。