cocos creator主程入門教程（五）—— 日志系統

五邑隱俠，本名關健昌，10年游戲生涯，現隱居五邑。本系列文章以TypeScript為介紹語言。

 

這一篇介紹日志系統的設計。一般我們開發一個demo，只會簡單的用cocos提供的cc.log打印下日志，方便調試功能。但是要開發一個商業項目，還要考慮怎么收集日志，方便產品上線后定位線上問題。如果線上產品運行出異常時能把當時的上下文日志發到一個文件服務器，有利於分析異常的原因。例如如果有通信數據日志，可以先判斷是后端返回數據異常，還是前端邏輯出問題。因此，我會在項目里設計一個統一的日志系統，游戲里所有日志的打印都使用該日志系統進行打印。

首先對日志進行分級

/**
 * 日志等級枚舉
 */
export enum LogLv {
    DEBUG = 0,
    INFO,
    WARN,
    ERROR
}

　　

調試和內部測試時打開所有等級的日志，上線后只打開info等級以上的日志。

產品上線后，日志需要緩存，在異常發生時進行上報

    private static MAX_LEN: number = 5000;
    private static CLEAR_COUNT: number = 1000;

    private static logs: Array<LogInfo> = [];

　　

這里設定一個清理的條數，當緩存達到上限，把指定條數的舊日志清理出去。當然也可以使用鏈表實現的隊列或環形buffer緩存，達到上限后只替換一條。

每次調用打印方法時，根據設定的日志等級進行攔截，如果打印等級小於輸出等級，不做輸出。每個打印都可以添加tag，方便日志排查時根據模塊定位問題。

    /**
     * 收集、打印調試等級的日志
     * @param tag 
     * @param msg 
     */
    public static debug(tag: string, msg: string): void {
        if (Logger.level > LogLv.DEBUG) {
            return;
        }

        let logMsg = "[DEBUG] [" + tag + "] " + msg;
        Logger._addLog(LogLv.DEBUG, logMsg);
        cc.log(logMsg);
    }

　　

日志緩存處理

/**
     * 添加緩存日志
     * @param level 
     * @param logMsg 
     */
    private static _addLog(level: LogLv, logMsg: string): void {
        if (Logger.logs.length >= Logger.MAX_LEN) {
            Logger.logs.splice(0, Logger.CLEAR_COUNT);
        }

        Logger.logs.push({
            level: level,
            msg: logMsg
        });
    }

　　

對於網頁版本，可以實現window.onerror方法，在這里把所有日志連接成字符串上傳到日志文件服務器，實現對異常日志的收集上報。

 

日志系統先說到這里，下一篇我們將介紹下怎樣做消息分發。