log4cpp之Layout佈局

首先回顧一下HelloWorld的日誌格式,它使用了最簡單的BasicLayout: ios

1248337987 ERROR  : Hello log4cpp in a Error Message!
1248337987 WARN : Hello log4cpp in a Warning Message!

上面的日誌格式還能夠,但顯然不是許多程序員心中理想的格式,許多人理想的格式應該是這樣的: 程序員

2009-07-24 15:59:55,703: INFO infoCategory : system is running
2009-07-24 15:59:55,703: WARN infoCategory : system has a warning
2009-07-24 15:59:55,703: ERROR infoCategory : system has a error, can't find a file
2009-07-24 15:59:55,718: FATAL infoCategory : system has a fatal error, must be shutdown
2009-07-24 15:59:55,718: INFO infoCategory : system shutdown, you can find some information in system log

要得到上面的格式,必須使用比BasicLayout複雜的PatternLayout,並且要花一個小時來熟悉一下PatternLayout的格式定義方式,若是你認爲值得的話。
函數

PatternLayout spa

  在介紹PatternLayout 之前,首先來看看log4cpp中全部的Layout子類(Layout自己是個虛類),一共三個:BasicLayout、PatternLayout 和SimpleLayout,其中SimapleLayout並不建議使用,而BaiscLayout過於簡單,所以若是程序員不本身擴展Layout的話,就只能使用PatternLayout了,值得慶幸的是,PatternLayout仍是比較好用的。 日誌

PatternLayout使用setConversionPattern函數來設置日誌的輸出格式。該函數的聲明以下: orm

void log4cpp::PatternLayout::setConversionPattern  (  const std::string &  conversionPattern   )  throw (ConfigureFailure) [virtual]

其中參數類型爲std::string,相似於C語言中的printf,使用格式化字符串來描述輸出格式,其具體含義以下:
%c category;
%d 日期;日期能夠進一步的設置格式,用花括號包圍,例如%d{%H:%M:%S,%l} 或者 %d{%d %m %Y %H:%M:%S,%l}。若是不設置具體日期格式,則以下默認格式被使用「Wed Jan 02 02:03:55 1980」。日期的格式符號與ANSI C函數strftime中的一致。但增長了一個格式符號%l,表示毫秒,佔三個十進制位。
%m 消息;
%n 換行符,會根據平臺的不一樣而不一樣,但對於用戶透明;
%p 優先級;
%r 自從layout被建立後的毫秒數;
%R 從1970年1月1日0時開始到目前爲止的秒數;
%u 進程開始到目前爲止的時鐘週期數;
%x NDC。

   所以,要獲得上述的理想格式,能夠將setConversionPattern的參數設置爲「%d: %p %c %x: %m%n」,其具體含義是「時間: 優先級 Category NDC: 消息 換行」。使用PatternLayout的例子程序以下,項目名稱是LayoutExam:
進程

#include <iostream>
#include <log4cpp/Category.hh>
#include <log4cpp/OstreamAppender.hh>
#include <log4cpp/PatternLayout.hh>
#include <log4cpp/Priority.hh>
using namespace std;
using namespace log4cpp;

int main(void)
{
        //指定日誌輸出目的地,只能對應一個Category
        OstreamAppender * pOsApender =
                new OstreamAppender("osApender", &cout);

        //格式化日誌信息
        PatternLayout * ptnLyt = new PatternLayout();
        ptnLyt->setConversionPattern("%d: %p %c %x: %m%n");
        pOsApender->setLayout(ptnLyt);

        //負責輸出日誌,輸出目的有Appender決定,能夠指定多個Appender
        Category & root = Category::getRoot();
        Category & infoCat = root.getInstance("infoCat");
        infoCat.addAppender(pOsApender);
        infoCat.setPriority(Priority::INFO);

        //寫日誌
        infoCat.info("system is running!");
        infoCat.warn("system has a warning!");
        infoCat.error("system has an error, can't find file!");
        infoCat.fatal("system has an fatal error, must be shutdown!");
        infoCat.info("system shutdown,you can find information in system log");

        //關閉Category
        Category::shutdown();
        return 0;
}
#include<iostream>
#include<log4cpp/Category.hh>
#include<log4cpp/OstreamAppender.hh>
#include<log4cpp/Priority.hh>
#include<log4cpp/PatternLayout.hh>
using namespace std;
using namespace log4cpp;
int main(int argc,char* argv[])
{
        OstreamAppender* osAppender = new OstreamAppender("osAppender",&cout);
        PatternLayout* pLayout = new PatternLayout();
        pLayout->setConversionPattern("%d: %p %c %x: %m%n");  //%x 不寫同樣的輸出結果
        //時間(默認格式) 優先級 Category NDC:消息 換行
        //NDC(嵌套的診斷上下文),%c 到時候就是輸出下面的infoCategory
        osAppender->setLayout(pLayout);

        Category& root = Category::getRoot();
        //獲取root下的一個實例,由於系統只有一個根,根下能夠有多個Category,不能統一直接對root設置樣式,除非全部日誌記錄都採用同樣的樣式
        Category& infoCategory = root.getInstance("infoCategory");
        infoCategory.addAppender(osAppender);
        infoCategory.setPriority(Priority::INFO);

        infoCategory.info("system is running");
        infoCategory.warn("system has a warning");
        infoCategory.error("system has a error,can't find a file");
        infoCategory.fatal("system has a fatal error,must be shutdown");
        infoCategory.info("system shutdown,you can find some information in system log");

        Category::shutdown();
        return 0;
}

其運行結果即以下所示: 字符串

2017-12-24 17:33:56,230: INFO infoCategory : system is running
2017-12-24 17:33:56,230: WARN infoCategory : system has a warning
2017-12-24 17:33:56,230: ERROR infoCategory : system has a error,can't find a file
2017-12-24 17:33:56,230: FATAL infoCategory : system has a fatal error,must be shutdown
2017-12-24 17:33:56,230: INFO infoCategory : system shutdown,you can find some information in system log
相關文章
相關標籤/搜索