Android Debug 之 Log 最佳實踐_ZenDei技術網路在線

本文微信公眾號「AndroidTraveler」首發。背景在開發過程中，調試是必不可少的一項工作。當我們要確定項目的邏輯時，當我們要瞭解界面的生命周期時，當我們發現新寫的邏輯與期望效果不一致時，當我們覺得數據有問題時...... 而調試有兩種方式：第一種就是使用 debug 模式運行 APP ...

本文微信公眾號「AndroidTraveler」首發。

背景

在開發過程中，調試是必不可少的一項工作。

當我們要確定項目的邏輯時，當我們要瞭解界面的生命周期時，當我們發現新寫的邏輯與期望效果不一致時，當我們覺得數據有問題時......

而調試有兩種方式：

第一種就是使用 debug 模式運行 APP，然後通過斷點讓程式運行到指定位置進行分析。

第二種就是打日誌的方式，通過觀察輸出來確定程式是否運行到該位置以及此時的數據。

本篇文章主要聚焦在第二種方式上面。

在 Android 裡面，打日誌使用的系統 API 是 Log，你以為直接使用就完了嗎？

封裝

假設你在需要列印日誌的地方直接使用系統的 API，那麼當遇到下麵情況時，會「牽一發而動全身」。

場景一：如果我列印日誌要用三方庫的日誌 API，那麼我要查找項目所有使用位置，並一一替換。

場景二：如果我希望在開發環境下列印日誌，release 環境不列印，這個時候每個位置都需要單獨做處理。

因此我們需要在使用 Log 進行日誌列印之前，做一層封裝。

假設我們的類名字為 ZLog，代碼如下：

import android.util.Log;

/**
 * Created on 2019-10-26
 *
 * @author Zengyu.Zhan
 */
public class ZLog {
    public static int v(String tag, String msg) {
        return Log.v(tag, msg);
    }

    public static int d(String tag, String msg) {
        return Log.d(tag, msg);
    }

    public static int i(String tag, String msg) {
        return Log.i(tag, msg);
    }

    public static int w(String tag, String msg) {
        return Log.w(tag, msg);
    }

    public static int e(String tag, String msg) {
        return Log.e(tag, msg);
    }
}

這樣處理之後，對於場景一和場景二，我們需要修改的只是 ZLog 這個類，而不需要到具體使用 ZLog 的所有地方去修改。

提供日誌列印控制

我們知道，日誌列印可能包含敏感信息，而且過多的日誌列印可能影響 APP 的性能，因此我們一般是在開發時候打開日誌，在發佈 APP 之前關閉。

因此我們這邊需要提供一個標誌位來控制日誌的列印與否。

import android.util.Log;

/**
 * Created on 2019-10-26
 *
 * @author Zengyu.Zhan
 */
public class ZLog {
    private static boolean isDebugMode = false;
    public static void setDebugMode(boolean debugMode) {
        isDebugMode = debugMode;
    }

    public static int v(String tag, String msg) {
        return isDebugMode ? Log.v(tag, msg) : -1;
    }

    public static int d(String tag, String msg) {
        return isDebugMode ? Log.d(tag, msg) : -1;
    }

    public static int i(String tag, String msg) {
        return isDebugMode ? Log.i(tag, msg) : -1;
    }

    public static int w(String tag, String msg) {
        return isDebugMode ? Log.w(tag, msg) : -1;
    }

    public static int e(String tag, String msg) {
        return isDebugMode ? Log.e(tag, msg) : -1;
    }
}

預設是不開啟日誌列印，避免開發者忘記設置。

普通日誌和奔潰棧系統日誌在控制台的輸出對比

現在我們在 APP 裡面使用 ZLog 列印日誌，代碼為：

ZLog.setDebugMode(true);
ZLog.e("ZLog", "just test");

輸出如下：

我們現在增加如下代碼：

String nullString = null;
if (nullString.equals("null")) {
}

運行之後控制台會顯示空指針異常奔潰棧，如下：

可以看到奔潰棧信息會顯示具體是哪個文件出現了空指針，以及具體哪一行。在我們這個例子裡面就是 MainActivity.java 的 24 行。

而且點擊藍色鏈接游標會直接定位到錯誤位置。

如果我們普通的日誌也可以點擊就跳轉到對應位置，對於我們開發來說效率是有很大提升的。

ZLogHelper

既然奔潰棧裡面有鏈接可以跳轉，那麼我們可以通過棧信息來獲取日誌的列印位置。

我們直接上代碼：

public class ZLogHelper {
    private static final int CALL_STACK_INDEX = 1;
    private static final Pattern ANONYMOUS_CLASS = Pattern.compile("(\\$\\d+)+$");

    public static String wrapMessage(int stackIndex, String message) {
        // DO NOT switch this to Thread.getCurrentThread().getStackTrace().
        if (stackIndex < 0) {
            stackIndex = CALL_STACK_INDEX;
        }
        StackTraceElement[] stackTrace = new Throwable().getStackTrace();
        if (stackTrace.length <= stackIndex) {
            throw new IllegalStateException(
                    "Synthetic stacktrace didn't have enough elements: are you using proguard?");
        }
        String clazz = extractClassName(stackTrace[stackIndex]);
        int lineNumber = stackTrace[stackIndex].getLineNumber();
        message = ".(" + clazz + ".java:" + lineNumber + ") - " + message;
        return message;
    }

    /**
     * Extract the class name without any anonymous class suffixes (e.g., {@code Foo$1}
     * becomes {@code Foo}).
     */
    private static String extractClassName(StackTraceElement element) {
        String tag = element.getClassName();
        Matcher m = ANONYMOUS_CLASS.matcher(tag);
        if (m.find()) {
            tag = m.replaceAll("");
        }
        return tag.substring(tag.lastIndexOf('.') + 1);
    }
}

這裡我們對外提供一個 wrapMessage 方法，看名字就知道是對 Message 進行包裝。

方法裡面也是對 StackTraceElement 進行分析。

這邊還做了一個控制，避免 stackIndex 出現負數情況。

可能有小伙伴會好奇，為什麼要把 stackIndex 對外開放呢？

因為你列印日誌的地方不一樣，這裡的 stackIndex 也需要對應調整。

方法裡面是對 StackTraceElement 做處理，而 StackTraceElement 跟你的方法層級有關係。

我們以最常用的兩種日誌列印形式為例，來說明這裡的 stackIndex 要怎麼傳遞，以及這個 ZLogHelper 的用法。

直接代碼使用

我們在 MainActivity.java 中直接使用，stackIndex 傳入 1 即可。

Log.e("ZLog", ZLogHelper.wrapMessage(1, "just test"));

控制台輸出如下：

可以看到代碼所在的類和行數到顯示為鏈接文本，點擊會定位到具體的位置。

做了封裝的情況

一般我們對 Log 都會做封裝，因此假設我們有一個 LogUtils 類，我們在 MainActivity.java 裡面調用。

LogUtils.java:

class LogUtils {
    public static  void loge() {
        Log.e("ZLog", ZLogHelper.wrapMessage(2, "just test"));
    }
}

MainActivity.java：

LogUtils.loge();

我們先看下結果，再來分析。控制台輸出如下：

可以看到確實定位到了 MainActivity.java 中的具體使用地方。

那麼為什麼這裡傳入的 stackIndex 跟第一種不一樣，是 2 而不是 1 呢？

其實答案很簡單，你改為 1 之後，輸出的控制台顯示的會定位到 LogUtils 裡面的日誌列印語句處。在這裡就是：

Log.e("ZLog", ZLogHelper.wrapMessage(2, "just test"));

所以其實你可以看出一個規律，而這個從代碼也可以發現。

因為代碼裡面解析調用位置是根據棧來的，對 StackTraceElement 進行分析，因此情況一直接使用，傳入 1。而情況二多了一層函數調用，通過 loge 方法做了一層包裝。因此需要傳入 2。如果你再套一層，那麼需要傳入 3。瞭解了這一點，我們下麵的工具類相信你就看得懂了。

ZLog

如果你不想自己手動傳入 stackIndex，可以直接使用我們提供的工具類 ZLog。

public class ZLog {
    private static boolean isDebugMode = false;
    public static void setDebugMode(boolean debugMode) {
        isDebugMode = debugMode;
    }

    private static boolean isLinkMode = true;
    public static void setLinkMode(boolean linkMode) {
        isLinkMode = linkMode;
    }

    private static final int CALL_STACK_INDEX = 3;

    public static int v(String tag, String msg) {
        return isDebugMode ? Log.v(tag, mapMsg(msg)) : -1;
    }

    public static int d(String tag, String msg) {
        return isDebugMode ? Log.d(tag, mapMsg(msg)) : -1;
    }

    public static int i(String tag, String msg) {
        return isDebugMode ? Log.i(tag, mapMsg(msg)) : -1;
    }

    public static int w(String tag, String msg) {
        return isDebugMode ? Log.w(tag, mapMsg(msg)) : -1;
    }

    public static int e(String tag, String msg) {
        return isDebugMode ? Log.e(tag, mapMsg(msg)) : -1;
    }

    private static String mapMsg(String msg) {
        return isLinkMode ? ZLogHelper.wrapMessage(CALL_STACK_INDEX, msg) : msg;
    }
}

相信有了前面的知識，小伙伴對於這裡為什麼傳入 3 應該瞭解了。

1 的話會定位到

return isLinkMode ? ZLogHelper.wrapMessage(CALL_STACK_INDEX, msg) : msg;

2 的話(以 e 為例)會定位到

return isDebugMode ? Log.e(tag, mapMsg(msg)) : -1;

3 的話才能夠定位到外面具體的調用處。

優化

我們知道，雖然 ZLog 做了封裝，但是我們每次打日誌都要傳入 ZLog，有點麻煩？

能否提供一個預設的 TAG，允許對外設置。

可以的，我們修改如下(以 e 為例)：

private static String tag = "ZLOG";
public static void setTag(String tag) {
    if (!TextUtils.isEmpty(tag)) {
        ZLog.tag = tag;
    }
}

public static int e(String tag, String msg) {
    return isDebugMode ? Log.e(mapTag(tag), mapMsg(msg)) : -1;
}

public static int e(String msg) {
    return isDebugMode ? Log.e(tag, mapMsg(msg)) : -1;
}

private static String mapTag(String tag) {
    return TextUtils.isEmpty(tag) ? ZLog.tag : tag;
}

項目實戰

按照下麵兩步引入開源庫。

Step 1. Add the JitPack repository to your build file
Add it in your root build.gradle at the end of repositories:

allprojects {
  repositories {
    ...
    maven { url 'https://jitpack.io' }
  }
}

Step 2. Add the dependency

dependencies {
  implementation 'com.github.nesger:AndroidWheel:1.0.0'
}

使用時先打開開關：

ZLog.setDebugMode(true);

然後就可以直接使用了。

溫馨提示

由於帶鏈接的 debug 對性能有一定影響，因此建議開發使用，上線關閉。

結語

這邊在完善一個開源倉庫 AndroidWheel，跟名字一樣，避免重覆造輪子。

目前 1.0.0 版本提供日誌相關工具類，1.0.1 增加了防抖動 EditText。

後續會繼續更新迭代，功能會更完善更全面。

覺得不錯，歡迎給個 star 哈～

參考鏈接：
Android Studio Pro Tip: go to source from logcat output