Logback日志格式優化，解決輸出***@2b193f2d問題

原文出處：Java之道

原文地址：http://www.hollischuang.com/archives/3689

 

　　我們在開發的時候，經常要打印日志，有的時候會在一些代碼的關鍵節點處進行日志輸出。使用logback/log4j等原生的日志框架，在日志輸出的時候可能會遇到一個問題，那就是經常我們要打印對象的時候，如以下代碼：

log.info("req = {}", aRequest);

　　打印結果卻是以下形式：

req = com.hollis.java.ways.ApplyRequest@39ddf169

　　其實原因比較簡單，那就是要打印的對象沒有重寫toString方法，這樣無法將該對象的參數打印出來。

　　所以，為了可以把對象的值都打印出來，我們一般要求對於自己定義的入參、出參等定義toString方法。但是有些時候，我們使用的是外部定義的request和response對象，他們並沒有覆蓋toString，當對這些對象打印的時候，就會出現以上問題。

　　一般簡單的解決辦法是，可以通過JSON把對象轉成String，如：

log.info("req = {}", JSON.toJSONString(aRequest));

　　日志輸出：

req = {"name":"Hollis","wechat":"hollischuang","javaways":"Java之道"}

　　但是，這樣的話，就需要在每一個日志記錄的地方人為的要處理下，很不高效，而且也容易遺忘。作為程序員，要想辦法干掉這種手動操作，有一個好的辦法，可以一勞永逸：借助logback(log4j也有類似的功能)的MessageConverter。無侵入性的解決這個問題

　　1. 定義一個MessageConverter

public class ArgumentJsonFormatLayout extends MessageConverter {

    @Override
    public String convert(ILoggingEvent event) {
        try {
            return MessageFormatter.arrayFormat(event.getMessage(), Stream.of(event.getArgumentArray())
                .map(JSON::toJSONString).toArray()).getMessage();
        } catch (Exception e) {
            return event.getMessage();
        }
    }
}

　　2. 在logbacb的配置文件中加上配置上這個類

<configuration>
    ……
    <conversionRule conversionWord="m" converterClass="com.hollis.java.ways.ArgumentJsonFormatLayout"/>
    ……
</configuration>  

　　注意：conversionWord里的值m不是隨便寫的，要和logback里的日志輸出格式里的信息參數相同。比如：

[%-5level] [%d{yyyy-MM-dd HH:mm:ss.SSS}] [%t] [%logger.%method:%line] -- %m%n

 

 

補充：我在查閱網上資料時，發現很多金融、電商項目會用這個類實現對用戶名、密碼、交易密碼等信息的脫敏處理，也很方便，不過實現邏輯比較復雜，大家可以自己查閱。

補充資料：

https://www.jianshu.com/p/ade8b7c220df

https://blog.csdn.net/fywfengyanwei/article/details/78484590