Android Debug 之 Log 最佳實踐

本文微信公衆號「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