Android將程式崩潰資訊儲存本地檔案傳送至伺服器

yangxi_001發表於2014-10-31
Android伺服器

轉自：http://blog.csdn.net/liuhe688/article/details/6584143

大家都知道，現在安裝Android系統的手機版本和裝置千差萬別，在模擬器上執行良好的程式安裝到某款手機上說不定就出現崩潰的現象，開發者個人不可能購買所有裝置逐個除錯，所以在程式釋出出去之後，如果出現了崩潰現象，開發者應該及時獲取在該裝置上導致崩潰的資訊，這對於下一個版本的bug修復幫助極大，所以今天就來介紹一下如何在程式崩潰的情況下收集相關的裝置引數資訊和具體的異常資訊，併傳送這些資訊到伺服器供開發者分析和除錯程式。

我們先建立一個crash專案，專案結構如圖：

在MainActivity.java程式碼中，程式碼是這樣寫的：

[java] view plaincopy
  1. package com.scott.crash;  
  2.   
  3. import android.app.Activity;  
  4. import android.os.Bundle;  
  5.   
  6. public class MainActivity extends Activity {  
  7.   
  8.     private String s;  
  9.       
  10.     @Override  
  11.     public void onCreate(Bundle savedInstanceState) {  
  12.         super.onCreate(savedInstanceState);  
  13.         System.out.println(s.equals("any string"));  
  14.     }  
  15. }  

 我們在這裡故意製造了一個潛在的執行期異常，當我們執行程式時就會出現以下介面：

遇到軟體沒有捕獲的異常之後，系統會彈出這個預設的強制關閉對話方塊。

我們當然不希望使用者看到這種現象，簡直是對使用者心靈上的打擊，而且對我們的bug的修復也是毫無幫助的。我們需要的是軟體有一個全域性的異常捕獲器，當出現一個我們沒有發現的異常時，捕獲這個異常，並且將異常資訊記錄下來，上傳到伺服器公開發這分析出現異常的具體原因。

接下來我們就來實現這一機制，不過首先我們還是來了解以下兩個類：android.app.Application和java.lang.Thread.UncaughtExceptionHandler。

Application：用來管理應用程式的全域性狀態。在應用程式啟動時Application會首先建立，然後才會根據情況(Intent)來啟動相應的Activity和Service。本示例中將在自定義加強版的Application中註冊未捕獲異常處理器。

Thread.UncaughtExceptionHandler：執行緒未捕獲異常處理器，用來處理未捕獲異常。如果程式出現了未捕獲異常，預設會彈出系統中強制關閉對話方塊。我們需要實現此介面，並註冊為程式中預設未捕獲異常處理。這樣當未捕獲異常發生時，就可以做一些個性化的異常處理操作。

大家剛才在專案的結構圖中看到的CrashHandler.java實現了Thread.UncaughtExceptionHandler，使我們用來處理未捕獲異常的主要成員，程式碼如下：

[java] view plaincopy
  1. package com.scott.crash;  
  2.   
  3. import java.io.File;  
  4. import java.io.FileOutputStream;  
  5. import java.io.PrintWriter;  
  6. import java.io.StringWriter;  
  7. import java.io.Writer;  
  8. import java.lang.Thread.UncaughtExceptionHandler;  
  9. import java.lang.reflect.Field;  
  10. import java.text.DateFormat;  
  11. import java.text.SimpleDateFormat;  
  12. import java.util.Date;  
  13. import java.util.HashMap;  
  14. import java.util.Map;  
  15.   
  16. import android.content.Context;  
  17. import android.content.pm.PackageInfo;  
  18. import android.content.pm.PackageManager;  
  19. import android.content.pm.PackageManager.NameNotFoundException;  
  20. import android.os.Build;  
  21. import android.os.Environment;  
  22. import android.os.Looper;  
  23. import android.util.Log;  
  24. import android.widget.Toast;  
  25.   
  26. /** 
  27.  * UncaughtException處理類,當程式發生Uncaught異常的時候,有該類來接管程式,並記錄傳送錯誤報告. 
  28.  *  
  29.  * @author user 
  30.  *  
  31.  */  
  32. public class CrashHandler implements UncaughtExceptionHandler {  
  33.       
  34.     public static final String TAG = "CrashHandler";  
  35.       
  36.     //系統預設的UncaughtException處理類   
  37.     private Thread.UncaughtExceptionHandler mDefaultHandler;  
  38.     //CrashHandler例項  
  39.     private static CrashHandler INSTANCE = new CrashHandler();  
  40.     //程式的Context物件  
  41.     private Context mContext;  
  42.     //用來儲存裝置資訊和異常資訊  
  43.     private Map<String, String> infos = new HashMap<String, String>();  
  44.   
  45.     //用於格式化日期,作為日誌檔名的一部分  
  46.     private DateFormat formatter = new SimpleDateFormat("yyyy-MM-dd-HH-mm-ss");  
  47.   
  48.     /** 保證只有一個CrashHandler例項 */  
  49.     private CrashHandler() {  
  50.     }  
  51.   
  52.     /** 獲取CrashHandler例項 ,單例模式 */  
  53.     public static CrashHandler getInstance() {  
  54.         return INSTANCE;  
  55.     }  
  56.   
  57.     /** 
  58.      * 初始化 
  59.      *  
  60.      * @param context 
  61.      */  
  62.     public void init(Context context) {  
  63.         mContext = context;  
  64.         //獲取系統預設的UncaughtException處理器  
  65.         mDefaultHandler = Thread.getDefaultUncaughtExceptionHandler();  
  66.         //設定該CrashHandler為程式的預設處理器  
  67.         Thread.setDefaultUncaughtExceptionHandler(this);  
  68.     }  
  69.   
  70.     /** 
  71.      * 當UncaughtException發生時會轉入該函式來處理 
  72.      */  
  73.     @Override  
  74.     public void uncaughtException(Thread thread, Throwable ex) {  
  75.         if (!handleException(ex) && mDefaultHandler != null) {  
  76.             //如果使用者沒有處理則讓系統預設的異常處理器來處理  
  77.             mDefaultHandler.uncaughtException(thread, ex);  
  78.         } else {  
  79.             try {  
  80.                 Thread.sleep(3000);  
  81.             } catch (InterruptedException e) {  
  82.                 Log.e(TAG, "error : ", e);  
  83.             }  
  84.             //退出程式  
  85.             android.os.Process.killProcess(android.os.Process.myPid());  
  86.             System.exit(1);  
  87.         }  
  88.     }  
  89.   
  90.     /** 
  91.      * 自定義錯誤處理,收集錯誤資訊 傳送錯誤報告等操作均在此完成. 
  92.      *  
  93.      * @param ex 
  94.      * @return true:如果處理了該異常資訊;否則返回false. 
  95.      */  
  96.     private boolean handleException(Throwable ex) {  
  97.         if (ex == null) {  
  98.             return false;  
  99.         }  
  100.         //使用Toast來顯示異常資訊  
  101.         new Thread() {  
  102.             @Override  
  103.             public void run() {  
  104.                 Looper.prepare();  
  105.                 Toast.makeText(mContext, "很抱歉,程式出現異常,即將退出.", Toast.LENGTH_LONG).show();  
  106.                 Looper.loop();  
  107.             }  
  108.         }.start();  
  109.         //收集裝置引數資訊   
  110.         collectDeviceInfo(mContext);  
  111.         //儲存日誌檔案   
  112.         saveCrashInfo2File(ex);  
  113.         return true;  
  114.     }  
  115.       
  116.     /** 
  117.      * 收集裝置引數資訊 
  118.      * @param ctx 
  119.      */  
  120.     public void collectDeviceInfo(Context ctx) {  
  121.         try {  
  122.             PackageManager pm = ctx.getPackageManager();  
  123.             PackageInfo pi = pm.getPackageInfo(ctx.getPackageName(), PackageManager.GET_ACTIVITIES);  
  124.             if (pi != null) {  
  125.                 String versionName = pi.versionName == null ? "null" : pi.versionName;  
  126.                 String versionCode = pi.versionCode + "";  
  127.                 infos.put("versionName", versionName);  
  128.                 infos.put("versionCode", versionCode);  
  129.             }  
  130.         } catch (NameNotFoundException e) {  
  131.             Log.e(TAG, "an error occured when collect package info", e);  
  132.         }  
  133.         Field[] fields = Build.class.getDeclaredFields();  
  134.         for (Field field : fields) {  
  135.             try {  
  136.                 field.setAccessible(true);  
  137.                 infos.put(field.getName(), field.get(null).toString());  
  138.                 Log.d(TAG, field.getName() + " : " + field.get(null));  
  139.             } catch (Exception e) {  
  140.                 Log.e(TAG, "an error occured when collect crash info", e);  
  141.             }  
  142.         }  
  143.     }  
  144.   
  145.     /** 
  146.      * 儲存錯誤資訊到檔案中 
  147.      *  
  148.      * @param ex 
  149.      * @return  返回檔名稱,便於將檔案傳送到伺服器 
  150.      */  
  151.     private String saveCrashInfo2File(Throwable ex) {  
  152.           
  153.         StringBuffer sb = new StringBuffer();  
  154.         for (Map.Entry<String, String> entry : infos.entrySet()) {  
  155.             String key = entry.getKey();  
  156.             String value = entry.getValue();  
  157.             sb.append(key + "=" + value + "\n");  
  158.         }  
  159.           
  160.         Writer writer = new StringWriter();  
  161.         PrintWriter printWriter = new PrintWriter(writer);  
  162.         ex.printStackTrace(printWriter);  
  163.         Throwable cause = ex.getCause();  
  164.         while (cause != null) {  
  165.             cause.printStackTrace(printWriter);  
  166.             cause = cause.getCause();  
  167.         }  
  168.         printWriter.close();  
  169.         String result = writer.toString();  
  170.         sb.append(result);  
  171.         try {  
  172.             long timestamp = System.currentTimeMillis();  
  173.             String time = formatter.format(new Date());  
  174.             String fileName = "crash-" + time + "-" + timestamp + ".log";  
  175.             if (Environment.getExternalStorageState().equals(Environment.MEDIA_MOUNTED)) {  
  176.                 String path = "/sdcard/crash/";  
  177.                 File dir = new File(path);  
  178.                 if (!dir.exists()) {  
  179.                     dir.mkdirs();  
  180.                 }  
  181.                 FileOutputStream fos = new FileOutputStream(path + fileName);  
  182.                 fos.write(sb.toString().getBytes());  
  183.                 fos.close();  
  184.             }  
  185.             return fileName;  
  186.         } catch (Exception e) {  
  187.             Log.e(TAG, "an error occured while writing file...", e);  
  188.         }  
  189.         return null;  
  190.     }  
  191. }  

在收集異常資訊時，朋友們也可以使用Properties，因為Properties有一個很便捷的方法properties.store(OutputStream out, String comments)，用來將Properties例項中的鍵值對外輸到輸出流中，但是在使用的過程中發現生成的檔案中異常資訊列印在同一行，看起來極為費勁，所以換成Map來存放這些資訊，然後生成檔案時稍加了些操作。

完成這個CrashHandler後，我們需要在一個Application環境中讓其執行，為此，我們繼承android.app.Application，新增自己的程式碼，CrashApplication.java程式碼如下：

[java] view plaincopy
  1. package com.scott.crash;  
  2.   
  3. import android.app.Application;  
  4.   
  5. public class CrashApplication extends Application {  
  6.     @Override  
  7.     public void onCreate() {  
  8.         super.onCreate();  
  9.         CrashHandler crashHandler = CrashHandler.getInstance();  
  10.         crashHandler.init(getApplicationContext());  
  11.     }  
  12. }  

最後，為了讓我們的CrashApplication取代android.app.Application的地位，在我們的程式碼中生效，我們需要修改AndroidManifest.xml：

[html] view plaincopy
  1. <application android:name=".CrashApplication" ...>  
  2. </application>  

因為我們上面的CrashHandler中，遇到異常後要儲存裝置引數和具體異常資訊到SDCARD，所以我們需要在AndroidManifest.xml中加入讀寫SDCARD許可權：

[html] view plaincopy
  1. <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>  

搞定了上邊的步驟之後，我們來執行一下這個專案：

看以看到，並不會有強制關閉的對話方塊出現了，取而代之的是我們比較有好的提示資訊。

然後看一下SDCARD生成的檔案：



用文字編輯器開啟日誌檔案，看一段日誌資訊：

[java] view plaincopy
  1. CPU_ABI=armeabi  
  2. CPU_ABI2=unknown  
  3. ID=FRF91  
  4. MANUFACTURER=unknown  
  5. BRAND=generic  
  6. TYPE=eng  
  7. ......  
  8. Caused by: java.lang.NullPointerException  
  9.     at com.scott.crash.MainActivity.onCreate(MainActivity.java:13)  
  10.     at android.app.Instrumentation.callActivityOnCreate(Instrumentation.java:1047)  
  11.     at android.app.ActivityThread.performLaunchActivity(ActivityThread.java:2627)  
  12.     ... 11 more  

這些資訊對於開發者來說幫助極大，所以我們需要將此日誌檔案上傳到伺服器，有關檔案上傳的技術，請參照Android中使用HTTP服務相關介紹。

不過在使用HTTP服務之前，需要確定網路暢通，我們可以使用下面的方式判斷網路是否可用：

[java] view plaincopy
  1. /** 
  2.      * 網路是否可用 
  3.      *  
  4.      * @param context 
  5.      * @return 
  6.      */  
  7.     public static boolean isNetworkAvailable(Context context) {  
  8.         ConnectivityManager mgr = (ConnectivityManager) context.getSystemService(Context.CONNECTIVITY_SERVICE);  
  9.         NetworkInfo[] info = mgr.getAllNetworkInfo();  
  10.         if (info != null) {  
  11.             for (int i = 0; i < info.length; i++) {  
  12.                 if (info[i].getState() == NetworkInfo.State.CONNECTED) {  
  13.                     return true;  
  14.                 }  
  15.             }  
  16.         }  
  17.         return false;  
  18.     }  

相關文章