1. 面相抽象：不直接使用 printf / std::cout

直接使用 printf 或 std::cout 的弊端在于：不夠規(guī)模化，修改起來麻煩。

例如，除了想往控制臺打印，還希望往文件打印； 想確保每一處打印都有 flush； 想通過 CMake Option， 用一個(gè)簡單的開關(guān)來控制日志的開啟和關(guān)閉。

使用專門的日志庫提供的 宏/函數(shù)， 而不是直接使用 printf / std::cout, 是基本的要求。

而 Debug/Info/Warning/Error 等級的劃分， 算是日志庫的基本功能， 這里不探討了。

2. 有區(qū)分度的打?。簩俚?tag

在多人協(xié)作、多 SDK 集成的場景下， 所有 log 都輸出到控制臺時(shí)， 怎樣區(qū)分不同模塊的日志？ 每個(gè)模塊應(yīng)當(dāng)有自己獨(dú)特的 tag， 也就是顯示在日志打印的每一行的最開頭部分的， 如：

[D] module1: xxxxx
[D] module2: xxxxx

這里的 module1 和 module2 就是 tag。 當(dāng)程序出現(xiàn) crash，根據(jù) crash 前最后一次打印的 tag， 來判定職責(zé)在哪個(gè)模塊（SDK）中，對應(yīng)的開發(fā)負(fù)責(zé)人負(fù)責(zé)排查（也就是甩鍋、背鍋）。

3. 自證清白：API函數(shù)的進(jìn)入-離開 log

當(dāng)調(diào)用子模塊時(shí)，子模塊的某個(gè) API 函數(shù)是否運(yùn)行完畢， 決定了誰來背鍋。例如有 f 和 g 兩個(gè)模塊， f 負(fù)責(zé)調(diào)用 g 模塊的 g1(), g2() 兩個(gè) API 函數(shù)：

f1()
  - g1()
  - g2()
f2()

當(dāng)最終的日志打印中，看到了 g2( ) 內(nèi)的日志打印、沒看到 f2() 的日志打印， 并且 f2() 代碼中確實(shí)寫了日志打印， 這時(shí)候如何裁定職責(zé)呢？

由于我負(fù)責(zé) g 模塊， 無法主導(dǎo) f 模塊的排查， 只能在 g1(), g2() 函數(shù)中自證清白： 在 API 函數(shù)執(zhí)行的最開頭、最末尾， 增加日志打?。?/p>

class AutoLogger
{
public:
    AutoLogger(const char* name):
        m_name(name)
    {
        XX_LOGD("%s begin()", name);
    }
    ~AutoLogger()
    {
        XX_LOGD("%s end()", name);
    }
private:
    std::string m_name;
};

void g2()
{
    AutoLogger logger(__FUNCTION__);

    ... // 原有代碼
    // XX_LOGD("g2() end"); // 原本有這句，但是無法保證是 g2() 最后執(zhí)行的內(nèi)容，因?yàn)榭赡苡蓄悓?shí)例的析構(gòu)函數(shù)在這句之后執(zhí)行
}

為了進(jìn)一步簡化代碼，以及避免 logger 命名沖突，改為宏定義:

#define API_ENTER_LEAVE_LOG AutoLogger logger##__LINE__(__FUNCTION__)

這樣一來，看到的日志一定是這兩種之一：

// g 模塊沒crash
[D] module_g: g2() begin()
[D] module_g: .....
[D] module_g: g2() end()
crash info

// crash 在 g 模塊內(nèi)
[D] module_g: g2() begin()
[D] module_g: .....
crash info

4. 保存現(xiàn)場: 多重輸出

一個(gè)合格的日志庫， 應(yīng)當(dāng)能讓調(diào)用者同時(shí)往控制臺、文件寫入日志，并且支持用戶往其他地方寫入日志，例如 Android logcat， 或 QNX 系統(tǒng)的 slog。

那么作為使用者，就需要這樣寫：

static void custom_logger(char* line, FILE* fp)
{
    char buf[1024];
    sprintf(buf, "%s\n", line);
    
    fprintf(stdout, "%s", buf);
    fflush(stdout);

    if (!fp && fp!=stdout)
    {
        fprintf(fp, "%s", buf);
        fflush(fp);
    }
#ifdef ENABLE_SLOG
    {
        slog2(DEBUG1, "%s\n", buf);
    }
#endif
}

static FILE* s_file = NULL;
void g_init()
{
    API_ENTER_LEAVE_LOG();

    if (s_file) 
        fclose(s_file);
    s_file = fopen("xxx.log", "wt");
    xx_log_register_logger(custom_logger);
}

void g_run()
{
    API_ENTER_LEAVE_LOG();
     ...
}

5. 有效性探討

個(gè)人認(rèn)為上述 log 內(nèi)容有一定正向作用，但是只能起到有限作用。 當(dāng) f 模塊遇到了 "Malloc failed: xxxx" 的報(bào)錯(cuò)時(shí)，那看起來應(yīng)該是 glibc 的作者們寫 bug 了，我們應(yīng)當(dāng)找 glibc 的作者去修改 bug 嗎？有這種可能，但是也可能是調(diào)用者出了問題。