編程開發中怎么如何寫一個無配置格式統一的日志

這篇文章主要介紹了編程開發中怎么如何寫一個無配置格式統一的日志，具有一定借鑒價值，感興趣的朋友可以參考下，希望大家閱讀完這篇文章之后大有收獲，下面讓小編帶著大家一起了解一下。

一、背景

大量項目在使用logback記日志，有部分項目使用日志混亂，格式不統一，多數人搞不懂配置文件，導致配置錯誤，現在需要開發一套統一的、少配置的日志組件，方便使用。

二、設計思路

盡量采用0配置，無logback.xml

日志格式統一，方便后續日志分析系統

只有兩個日志級別，一個是正常日志，一個是異常日志

提供log4j、jcl、logback、commons-log等橋接方案及版本兼容方案

提子線程、json格式化輸出、map格式化、數組格式化、請求響應參數（供耗時）等便捷日志輸出方法

支持redis、db、http自動開關配置****

新增日志類型(logger)

api采用流式結構，類似StringBuffer

三、概要設計

1、零配置

調研代碼 

java
static LoggerContext lc;
    static {
        lc = (LoggerContext) LoggerFactory.getILoggerFactory();
        // 對應配置中的appender
        ConsoleAppender ca = new ConsoleAppender();
        ca.setContext(lc);
        ca.setName("console");
        // 格式
        PatternLayoutEncoder pl = new PatternLayoutEncoder();
        pl.setContext(lc);
        pl.setPattern("%d{MMddHHmmss.SSS} [%thread] %-5level %logger{36} - %msg%n");
        pl.start();
        ca.setEncoder(pl);
        ca.start();
        // 對應配置中的logger
        ch.qos.logback.classic.Logger rootLogger = lc.getLogger("com.test");
        rootLogger.addAppender(ca);}

上面代碼等價于下面的xml

                    %d{MMddHHmmss.SSS} [%thread] %-5level %logger{36} - %msg%n

由此可以隨意把配置文件中的內容以代碼形式編寫，理論已經可以實現0配置。

2、輸出路徑

約定固定將日志輸出到，相對路徑log/xxx.yyyy-MM-dd-HH.log，其中xxx為logger的name

3、日志格式

格式固定：
MMddHHmmss.SSS||id||【交易名★子步驟】||context ||[level][線程號]
例：
150000.311||N-XrUTQzIc1531897200311||【CiTeeFilter★ci攔截器】||ci攔截器 請求的完整參數為：{"merchantId":["0012444"],"userId":["13112341232"]} ||[INFO][http-8091-7]

固定格式的核心代碼，攔截到日志請求，按照格式拼裝，主要方法為繼承ThrowableProxyConverter和MessageConverter來實現對日志的攔截，并修改為想要的格式，其中使用的例如id等放到本地變量內，核心是對MDC的使用

4、基礎logger

所有日志都默認輸出到這里 logger name:service 系統初始化時，定義這個Logger和appender，即這個Logger為root log

5、自定義的logger

提供addLogger方法，參數 packageName 包名，例如：com.test 必輸參數 如果name未設置時，name默認為包名最后一個.后面的字符 name 名字，決定日志文件的名字 非必輸 path 日志路徑 非必輸 additivity 是否輸出到root log內

6、特殊的log

提供特殊組件的log配置，例如：redis 默認ERROR http 默認ERROR db連接池 默認ERROR kafka 默認ERROR schedul 默認ERROR spring 默認ERROR

7、異常、換行日志處理

提供exception異常棧格式打印 提供帶換行的格式化打印 代碼思路：繼承ThrowableProxyConverter，獲取異常棧，在每行的前面插入固定格式文本

8、普通日志api（VirgoLog）

業務日志api（VirgoLog）

平時記日志時，如果某個類沒有時間toString方法，會無法正確打印出數據，此時提供替換方法，直接將object替換為json打印，核心代碼思路為

MessageFormatter是處理{}替換的類，重新寫個類，稍加改動即支持{}也支持`` ，并判斷替換為json還是toString

api如下

系統api（LoggerHelper）

9、特殊的格式化

map:即轉化為json，然后再格式化 

collection:同上 

array:也同上 

object:同上

10、問題

• 密碼脫敏、加解密有必要單獨提取方法嗎

• 提供父線程打印開關

11、maven依賴

                    com.cdc.ecliptic            virgo            1.5_1.6-SNAPSHOT

12、demo

public static void main(String[] args) throws InterruptedException {
        // 啟動
        VirgoLancher.start("hahaha", "com.cdc.virgo", "D:/test/hahah.log");
        LoggerHelper.commonOpen("hahaha", LogLevel.DEBUG);
        Logger logger1 = LoggerFactory.getLogger("druid");
//        VirgoLancher.commonStart("abc", "com.cdc.virgo");
        // 打開控制臺
        LoggerHelper.consoleOpen();
        // 設置cid
        VirgoLog.setUniqKey(null);
        // 設置步驟名和交易名
        VirgoLog.updateStep("adfa", "saf");
        // 獲取Logger
        VirgoLog logger = VirgoLog.getLogger();
        // 打開debug級別（只有在開發階段可以打開）
//        logger.changeLevel(LogLevel.DEBUG);
        // 記錄換行
        logger.log("a");
        logger1.info("dddddddddd");
        logger1.error("dddddddddd");
//        logger1.info("sfdasfaf" +
//                "\nafafdasfd" +
//                "\nasfdasf");
        logger.log("sfdasfaf" +
                "\nafafdasfd" +
                "\nasfdasf");
//        logger1.info("b");
        // 正常日志
//        logger.log("我只有一行");
        Map map = new HashMap();
        map.put("asdf", "1");
        map.put("asdf2", "2");
        map.put("asdf3", "13");
        map.put("asdf4", "14");
        map.put("asdf5", "15");
        map.put("asdf6", "16");
//        // 異常日志也支持格式化
//        logger.logErr("我錯了:{},你沒錯：~~", new Exception("asdfsaflk"), "啊", map);
//        logger.log("----------------------------------------------");
//        // {}替換普通對象，調用toString()  ~~把對象轉換為json并且格式化輸出 ``把對象轉換為json不格式化輸出
        logger.log("你好{},你是誰~~``,sd~xx {}", map, map, map, "tttt");
        VirgoLog.updateStep("saf2");
//        // 把對象轉換為json輸出
//        logger.logJson(map, false);
//        // 更新步驟名和交易名
//        VirgoLog.updateStep("bbbbb", "ccccc");
//        // 耗時日志打印
        logger.begin("處理內容");
        logger.begin("處理第二個");
        logger.begin("處理第三個");
        Thread.sleep(3000L);
        logger.end();
        Thread.sleep(1000L);
        logger.end();
        VirgoLog.updateStep("saf3");
        logger.end();
//        // 記錄debug日志，一般調試用
//        logger.logDebug("jajajajaja");
//        List l = new ArrayList();
//        B b = new B();
//        try {
//            b.b();
//        } catch (Exception e) {
//            logger.logErr("woqu", e);
//        }
    }

感謝你能夠認真閱讀完這篇文章，希望小編分享的“編程開發中怎么如何寫一個無配置格式統一的日志”這篇文章對大家有幫助，同時也希望大家多多支持億速云，關注億速云行業資訊頻道，更多相關知識等著你來學習!