Java Logging之JUL系列——LogRecord

上文提到過,LogRecord可以理解為是一個DTO,那么LogRecord里面到底存儲了哪些數(shù)據(jù)呢?我們可以看一下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方法都有相應(yīng)的set方法。

在記錄日志的過程中可以直接使用LogRecord對象,也可以不直接使用LogRecord對象,而是由日志組件內(nèi)部為我們自動組裝成一個LogRecord對象。我們之前通過logger.info這一類方法記錄日志時,內(nèi)部會根據(jù)我們傳入的參數(shù)以及調(diào)用的方法自動組裝成一個LogRecord對象。例如:

logger.info("Hello")

該方法首先轉(zhuǎn)調(diào)方法logger.log(Level.INFO, “Hello”),該方法內(nèi)部自動幫我們創(chuàng)建了LogRecord:

public void log(Level level, String msg) {
    if (!isLoggable(level)) {
        return;
    }
    LogRecord lr = new LogRecord(level, msg);
    doLog(lr);
}

LogRecord給我們提供了一個含有兩個參數(shù)的構(gòu)造方法,第一個參數(shù)指定需要記錄的信息的級別,第二個參數(shù)指定需要記錄的信息,即:

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;
}

當(dāng)然我們也可以直接構(gòu)造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);
    }
}

但這樣做顯然不太方便,還是通過logger.info,logger.warning這一類方法來記錄日志更簡便,當(dāng)然這一類方法也有他們的局限處,比如無法傳遞Throwable類型的異常信息等。
getLevel()方法返回的就是當(dāng)前日志信息的級別,即通過logger.info方法調(diào)用時,當(dāng)前日志信息的級別為INFO級別,通過logger.severe方法調(diào)用時,當(dāng)前日志信息級別為SEVERE級別。JUL中的級別涉及如下三個方面:

  • 日志記錄器(Logger)的級別
  • 當(dāng)前需要記錄的日志信息(message)的級別
  • 真正執(zhí)行日志記錄操作的Handler的級別

我們是要將當(dāng)前需要記錄的日志信息的級別與日志記錄器Logger的級別以及Handler的級別相比較,只有高于或等于他們的信息才會被記錄。首先是與Logger的級別進(jìn)行比較,如果低于Logger的級別則直接不輸出,如果高于或等于Logger的級別,到真正執(zhí)行輸出時還需要跟Handler的級別進(jìn)行比較。

getLoggerName()方法是獲取當(dāng)前日志記錄器名字,日志記錄器名字就是調(diào)用Logger.getLogger(String name)方法時傳入的參數(shù),在我們的例子中就是cn.codecrazy.study.JavaLogging。

getMillis()返回值默認(rèn)就是創(chuàng)建LogRecord對象時的當(dāng)前系統(tǒng)時間戳(從1970年到現(xiàn)在所經(jīng)過的毫秒數(shù)),millis屬性值是在LogRecourd的構(gòu)造方法中進(jìn)行賦值的。

getThrown()方法返回Throwable類型的信息,即獲取異常信息,我們目前為止記錄的日志信息只是記錄一段message,并沒有記錄發(fā)生異常時的異常堆棧信息,要記錄這種類型的信息,我們需要通過Logger.log()方法來進(jìn)行日志的記錄,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);
}

可以看到將傳入的Throwable類型參數(shù)賦值給了LogRecord對象的thrown屬性,因此在LogRecord中通過getThrown()方法就能獲取到傳入的Throwable信息,最終可以對異常堆棧信息進(jìn)行輸出。示例代碼如下:

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"));
    }
}

輸出為:

八月 10, 2018 9:02:42 下午 cn.codecrazy.study.JavaLogging main
嚴(yán)重: error
java.lang.NullPointerException: NPE
    at cn.codecrazy.study.JavaLogging.main(JavaLogging.java:11)

getSourceClassName()方法用來獲取記錄日志的操作是在哪個類中進(jìn)行的,在我們的例子中該方法的返回值就是cn.codecrazy.study.JavaLogging。

getSourceMethodName()方法用來獲取記錄日志的操作是在哪個方法中進(jìn)行的,在我們的例子中該方法的返回值就是main。

需要注意一點(diǎn)的是,上述兩個方法所獲取的類名和方法名有可能是不正確的。如果我們在記錄日志的過程中沒有主動設(shè)置這兩個屬性的值,那么這兩個屬性的值就會被自動推斷出來,推斷出來的結(jié)果有可能就會出現(xiàn)偏差。我們可以看一下getSourceClassName()方法內(nèi)部實(shí)現(xiàn):

    public String getSourceClassName() {
        if (needToInferCaller) {
            inferCaller();
        }
        return sourceClassName;
    }

可以看到如果needToInferCaller的值為true時,就會執(zhí)行inferCaller方法對發(fā)起記錄日志請求操作的類名和方法名進(jìn)行推斷,關(guān)于如何推斷我們在這里不進(jìn)行深入研究。
getSequenceNumber()為每一個LogRecord對象都賦予一個唯一的序號,從0開始。每創(chuàng)建一個LogRecord對象該值就增加1,在LogRecord的構(gòu)造方法中給該屬性賦值:
sequenceNumber = globalSequenceNumber.getAndIncrement();
globalSequenceNumber的聲明如下:
private static final AtomicLong globalSequenceNumber = new AtomicLong(0);

可以看出在系統(tǒng)運(yùn)行期間,每一個LogRecord對象都有一個唯一的編號。
getThreadId()方法獲取當(dāng)前線程的id,需要注意的是該id有可能不是真正的線程id,構(gòu)造方法中是通過如下語句對threadId進(jìn)行賦值的:
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;
    }
}

可以看到通過Thread.currentThread().getId()獲取的線程id是long類型的,但是LogRecord中的threadId字段是int類型的,因此它們之間沒辦法做到一一對應(yīng),參考JDK-6278014
getResourceBundle()和getResourceBundleName()以及getParameters()方法都是與日志信息本地化相關(guān)的,本地化與國際化我覺得是同一個概念的兩個不同角度,只有支持國際化才有所謂的在不同地區(qū)的本地化,我們不咬文嚼字了。關(guān)于本地化或者說國際化的相關(guān)內(nèi)容,我之前的一片文章《Tomcat7.0源碼分析——國際化》有所涉及,這里就不再詳細(xì)論述了,getParameters方法中獲取到的參數(shù)就是用來格式化帶有占位符的文本信息的。如果getResourceBundle()不為null,則說明要進(jìn)行本地化輸出,那么這個時候最外層傳入的message字段代表的就是key,通過該key去獲取到對應(yīng)的value,如果對應(yīng)的value找不到,則把key當(dāng)成value,然后再判斷parameters數(shù)組中是否有值,如果有值,則需要用這些值去替換掉value中的占位符。如果getResourceBundle()方法返回null,則不需要進(jìn)行本地化,那么最外層傳入的message就是真正要進(jìn)行輸出的信息,message中可能含有占位符,此時還需要判斷parameters數(shù)組中是否有值,如果有值,還需要一一替換掉message中的占位符,然后進(jìn)行輸出,我們來看一下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'});
    }
}

上述代碼中分別調(diào)用了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);
}

這兩個方法本質(zhì)上都是一樣的,內(nèi)部在構(gòu)造LogRecord時對parameters屬性進(jìn)行賦值。輸出結(jié)果如下所示:

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

可以看到parameters的作用就是用來填充message中的占位符的。關(guān)于格式化的這一部分我們后面介紹Formatter組件的時候再詳細(xì)論述。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容