Java Logging之JUL系列——LogRecord

上文提到過击孩,LogRecord可以理解為是一個(gè)DTO趾断,那么LogRecord里面到底存儲(chǔ)了哪些數(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()

每個(gè)get方法都有相應(yīng)的set方法昧穿。

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

logger.info("Hello")

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

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

LogRecord給我們提供了一個(gè)含有兩個(gè)參數(shù)的構(gòu)造方法饰潜,第一個(gè)參數(shù)指定需要記錄的信息的級(jí)別初坠,第二個(gè)參數(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對(duì)象彭雾,然后通過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)前日志信息的級(jí)別抄囚,即通過logger.info方法調(diào)用時(shí)霉赡,當(dāng)前日志信息的級(jí)別為INFO級(jí)別,通過logger.severe方法調(diào)用時(shí)幔托,當(dāng)前日志信息級(jí)別為SEVERE級(jí)別穴亏。JUL中的級(jí)別涉及如下三個(gè)方面:

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

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

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

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

getThrown()方法返回Throwable類型的信息氢橙,即獲取異常信息,我們目前為止記錄的日志信息只是記錄一段message恬偷,并沒有記錄發(fā)生異常時(shí)的異常堆棧信息悍手,要記錄這種類型的信息,我們需要通過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對(duì)象的thrown屬性诡延,因此在LogRecord中通過getThrown()方法就能獲取到傳入的Throwable信息滞欠,最終可以對(duì)異常堆棧信息進(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()方法用來獲取記錄日志的操作是在哪個(gè)類中進(jìn)行的孕暇,在我們的例子中該方法的返回值就是cn.codecrazy.study.JavaLogging仑撞。

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

需要注意一點(diǎn)的是隧哮,上述兩個(gè)方法所獲取的類名和方法名有可能是不正確的。如果我們?cè)谟涗浫罩镜倪^程中沒有主動(dòng)設(shè)置這兩個(gè)屬性的值座舍,那么這兩個(gè)屬性的值就會(huì)被自動(dòng)推斷出來沮翔,推斷出來的結(jié)果有可能就會(huì)出現(xiàn)偏差。我們可以看一下getSourceClassName()方法內(nèi)部實(shí)現(xiàn):

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

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

可以看出在系統(tǒng)運(yùn)行期間,每一個(gè)LogRecord對(duì)象都有一個(gè)唯一的編號(hào)妆够。
getThreadId()方法獲取當(dāng)前線程的id,需要注意的是該id有可能不是真正的線程id,構(gòu)造方法中是通過如下語句對(duì)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類型的,因此它們之間沒辦法做到一一對(duì)應(yīng)神妹,參考JDK-6278014
getResourceBundle()和getResourceBundleName()以及getParameters()方法都是與日志信息本地化相關(guān)的颓哮,本地化與國際化我覺得是同一個(gè)概念的兩個(gè)不同角度,只有支持國際化才有所謂的在不同地區(qū)的本地化鸵荠,我們不咬文嚼字了冕茅。關(guān)于本地化或者說國際化的相關(guān)內(nèi)容,我之前的一片文章《Tomcat7.0源碼分析——國際化》有所涉及蛹找,這里就不再詳細(xì)論述了姨伤,getParameters方法中獲取到的參數(shù)就是用來格式化帶有占位符的文本信息的。如果getResourceBundle()不為null庸疾,則說明要進(jìn)行本地化輸出姜挺,那么這個(gè)時(shí)候最外層傳入的message字段代表的就是key,通過該key去獲取到對(duì)應(yīng)的value彼硫,如果對(duì)應(yīng)的value找不到,則把key當(dāng)成value凌箕,然后再判斷parameters數(shù)組中是否有值拧篮,如果有值,則需要用這些值去替換掉value中的占位符牵舱。如果getResourceBundle()方法返回null串绩,則不需要進(jìn)行本地化,那么最外層傳入的message就是真正要進(jìn)行輸出的信息芜壁,message中可能含有占位符礁凡,此時(shí)還需要判斷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的如下兩個(gè)方法:

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

這兩個(gè)方法本質(zhì)上都是一樣的塞淹,內(nèi)部在構(gòu)造LogRecord時(shí)對(duì)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組件的時(shí)候再詳細(xì)論述饱普。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末运挫,一起剝皮案震驚了整個(gè)濱河市状共,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌谁帕,老刑警劉巖峡继,帶你破解...
    沈念sama閱讀 211,948評(píng)論 6 492
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異匈挖,居然都是意外死亡碾牌,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,371評(píng)論 3 385
  • 文/潘曉璐 我一進(jìn)店門关划,熙熙樓的掌柜王于貴愁眉苦臉地迎上來小染,“玉大人,你說我怎么就攤上這事贮折】泗妫” “怎么了?”我有些...
    開封第一講書人閱讀 157,490評(píng)論 0 348
  • 文/不壞的土叔 我叫張陵调榄,是天一觀的道長踊赠。 經(jīng)常有香客問我,道長每庆,這世上最難降的妖魔是什么筐带? 我笑而不...
    開封第一講書人閱讀 56,521評(píng)論 1 284
  • 正文 為了忘掉前任,我火速辦了婚禮缤灵,結(jié)果婚禮上伦籍,老公的妹妹穿的比我還像新娘。我一直安慰自己腮出,他們只是感情好帖鸦,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,627評(píng)論 6 386
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著胚嘲,像睡著了一般作儿。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上馋劈,一...
    開封第一講書人閱讀 49,842評(píng)論 1 290
  • 那天攻锰,我揣著相機(jī)與錄音,去河邊找鬼妓雾。 笑死娶吞,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的械姻。 我是一名探鬼主播寝志,決...
    沈念sama閱讀 38,997評(píng)論 3 408
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來了材部?” 一聲冷哼從身側(cè)響起毫缆,我...
    開封第一講書人閱讀 37,741評(píng)論 0 268
  • 序言:老撾萬榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎乐导,沒想到半個(gè)月后苦丁,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 44,203評(píng)論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡物臂,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,534評(píng)論 2 327
  • 正文 我和宋清朗相戀三年旺拉,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片棵磷。...
    茶點(diǎn)故事閱讀 38,673評(píng)論 1 341
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡蛾狗,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出仪媒,到底是詐尸還是另有隱情沉桌,我是刑警寧澤,帶...
    沈念sama閱讀 34,339評(píng)論 4 330
  • 正文 年R本政府宣布算吩,位于F島的核電站留凭,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏偎巢。R本人自食惡果不足惜蔼夜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,955評(píng)論 3 313
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望压昼。 院中可真熱鬧求冷,春花似錦、人聲如沸窍霞。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,770評(píng)論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽官撼。三九已至,卻和暖如春似谁,著一層夾襖步出監(jiān)牢的瞬間傲绣,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 32,000評(píng)論 1 266
  • 我被黑心中介騙來泰國打工巩踏, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留秃诵,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 46,394評(píng)論 2 360
  • 正文 我出身青樓塞琼,卻偏偏與公主長得像菠净,于是被迫代替她去往敵國和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,562評(píng)論 2 349

推薦閱讀更多精彩內(nèi)容