跳到主要內容

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 對性能有一定影響，因此建議開發使用，上線關閉。


結語


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


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


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


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


參考鏈接：


本站聲明:網站內容來源於博客園,如有侵權,請聯繫我們,我們將及時處理

【其他文章推薦】

※想知道網站建置、網站改版該如何進行嗎?將由專業工程師為您規劃客製化網頁設計及後台網頁設計



※不管是台北網頁設計公司、台中網頁設計公司，全省皆有專員為您服務



※Google地圖已可更新顯示潭子電動車充電站設置地點!!



※帶您來看台北網站建置，台北網頁設計，各種案例分享


Orignal From: Android Debug 之 Log 最佳實踐

留言

張貼留言

這個網誌中的熱門文章

強強聯手!攜手打造雲林縣Web3.0 領地方品牌進軍元宇宙

中華電信攜手國內最大Potato Media Web3.0社群共享平台，及品牌醫生果俐文創三方結合，透過經濟部「CBMP智慧雲遊跨域串連計畫」，協助品牌數位轉型，帶動品牌體驗情境、新商業模組升級與行動支付應用，第一站選在雲林縣當地原生消費品牌，打造社群消費循環，探索近期最夯的元宇宙新玩法。 Potato Media執行長顏宏霖表示，在CBMP計畫協助下，加上站內Web3.0資源，將快速協助雲林縣當地品牌升級轉型，幫助店家創造品牌價值，包含黑矸仔醬油、四代目麥芽酥、玉津烘焙坊、禪屋米胖工坊、YuDS沐耳飲、莫蒂精品巧克力、維野納複合式餐飲、頂雲咖啡、媽祖埔豆腐張、玉山碾米廠等，另外嘉義市麥麵、名香茗茶也等不及跨縣市加入，結合Potato Media站內活動，打造雲林專屬限定NFT道具與頭框，發行雲林扭蛋，體驗全新元宇宙新世界。 左起雲林縣計畫處處長李明岳、果俐文創執行長-陳郁涵、雲林縣議員周秀月、中華電信雲林營運處總經理張肇家、Potato Media執行長顏宏霖、LINE禮物代表睿鼎數位、12CMTaiwan行銷總監楊涵柔。(圖/由Potato Media提供) 此次Potato Media平台合作內容是店家會員註冊活動：首次註冊可得100積分 + 一顆扭蛋，店家推薦文章介紹，可領取店家消費優惠券，站內扭蛋禮物抽獎活動，獎項豐富：雲林限定禮品、雲林意象限定NFT道具與頭框，雲林幣扭一下APP政令大聲公獎勵活動，另外各種雲林美食伴手禮、住宿旅遊的店家，都可以使用行動支付或上LINE禮物平台實際體驗消費。 推薦評價好的 iphone維修 中心 擁有專業的維修技術團隊，同時聘請資深iphone手機維修專家，現場說明手機問題，快速修理，沒修好不收錢 產品缺大量曝光嗎?你需要的是一流 包裝設計 窩窩觸角包含自媒體、自有平台及其他國家營銷業務等，多角化經營並具有國際觀的永續理念。 雲林縣副縣長謝淑亞強調，此次計畫和Potato Media 合作，Potato Media 是一個在 2021 年 4 月正式發布的「區塊鏈 Web3.0 共享社群平台」，創作者和使用者都可以透過互動的機制，例如對文章點讚、留言與轉發分享，來獲取相對應比例的加密貨幣CFO（Potato Media 平台上的原生加密貨幣），跟Facebook、Instagram、YouTu...
張貼留言
閱讀完整內容

要上網站行銷農產品，得經過市政府抽驗農藥殘留，檢驗合格才能上網行銷

台北網站設計      網頁設計公司     網站設計公司 食安五環為「源頭控管」、「重建生產管理履歷」、「提高查驗能力」、「加重生產者、廠商的責任」及「鼓勵、創造監督平臺」五大要環，除推動政府與市民消費者共同監督食品安全，更要從農場到餐桌，鏈結農村產業線，以網路社群為媒介，建立嘉義市農村網頁平台。活動現場介紹「農抵嘉」產銷網頁平台的內容，包含在地人文地產景，將景觀、產業、生態及文化等資訊整合、展現，更推廣在地農村農友優質、安全的農產品。要上「農抵嘉」網站行銷農產品，得經過市政府抽驗農藥殘留，檢驗合格才能上網行銷自己的農產品，嘉義市農友可以多利用，也提供店家採購管道。 「尚安心，農抵嘉」，透過「農抵嘉」產銷網頁平台，鏈結農村產業線並促進地產地消，從源頭管理食安，讓政府管理、民間參與，透過食安小教育，讓小朋友接觸農作物，與生產者互動，產生共鳴，一同攜手維護嘉義市的食安。記者會中也展示紅瓦厝社區所做的紅瓦窯烤，並有其他下埤花生等農產品，透過農場職人使「農特產品不只是農產品」，民眾可登入「農抵嘉」網頁http://chiayirural.com/index.asp瞭解更進一步的訊息。 網動廣告 參考資料:蕃新聞https://n.yam.com/Article/20171226529712 Orignal From: 要上網站行銷農產品，得經過市政府抽驗農藥殘留，檢驗合格才能上網行銷
張貼留言
閱讀完整內容

IEA：疫情衝擊能源需求 但再生能源呈創紀錄成長_台中搬家公司

※ 台中搬家公司 教你幾個打包小技巧,輕鬆整理裝箱! 還在煩惱搬家費用要多少哪？台中大展搬家線上試算搬家費用，從此不再擔心「物品怎麼計費」、「多少車才能裝完」 摘錄自2020年11月10日中央社報導 國際能源總署（IEA）報告今天（10日）指出，武漢肺炎（COVID-19）疫情可能衝擊能源需求，但電力部門再生能源繼續以創紀錄速度成長。 IEA執行董事比羅爾（Fatih Birol）表示：「在2025年，再生能源將成為全球最大發電來源，預計將提供1/3的全球電力，終結煤炭50年來作為最大電力供應來源的地位。」 ※推薦 台中搬家公司 優質服務,可到府估價 台中搬鋼琴,台中金庫搬運,中部廢棄物處理,南投縣搬家公司,好幫手搬家,西屯區搬家 IEA關於再生能源的年度報告估計，儘管受到疫情干擾，今年的再生能源新發電容量可望創紀錄，達將近200GW（GW為十億瓦）。 能源轉型 國際新聞 再生能源 疫情看氣候與能源 本站聲明:網站內容來源環境資訊中心https://e-info.org.tw/,如有侵權,請聯繫我們,我們將及時處理 ※ 台中搬家公司 教你幾個打包小技巧,輕鬆整理裝箱! 還在煩惱搬家費用要多少哪？台中大展搬家線上試算搬家費用，從此不再擔心「物品怎麼計費」、「多少車才能裝完」 Orignal From: IEA：疫情衝擊能源需求 但再生能源呈創紀錄成長_台中搬家公司
張貼留言
閱讀完整內容