Android 之 应用未捕获异常处理

　　最近开发一款低功耗蓝牙通讯的 Android 应用，安装使用时多次出现“ 抱歉，xxx已停止 ”。现在安装Android系统的手机版本和设备千差万别，在模拟器上运行良好的程序安装到某款手机上说不定就出现崩溃的现象，开发者不可能购买所有设备逐个调试，所以在程序发布出去之后，如果出现了崩溃现象，开发者应该及时获取在该设备上导致崩溃的信息，这对于下一个版本的bug修复帮助极大。

　　所以，通过查阅资料整理如何在程序崩溃的情况下收集相关的设备参数信息和具体的异常信息，并发送这些信息到服务器供开发者分析和调试程序。

一、新建一个测试项目，并构建异常逻辑

　　在MainActivity.java代码中，如下：

package com.yimx.test;  
  
import android.app.Activity;  
import android.os.Bundle;  
  
public class MainActivity extends Activity {  
  
    private String str;  
      
    @Override  
    public void onCreate(Bundle savedInstanceState) {  
        super.onCreate(savedInstanceState);  
        System.out.println(str.equals("any string"));  
    }  
}  

　　在这里制造了一个潜在的运行期异常，当我们运行程序时就会出现以下界面：

　　

　　遇到软件没有捕获的异常之后，系统会弹出这个默认的强制关闭对话框。

　　当然不希望用户看到这种现象，简直是对用户体验造成毁灭性的打击，而且对我们的bug的修复也是毫无帮助的。我们需要的是应用有一个全局的异常捕获器，当出现一个我们没有发现的异常时，捕获这个异常，并且将异常信息记录下来，上传到服务器公开，开发者以此来分析出现异常的具体原因。

二、未捕获异常处理实现

　　为了实现异常捕获机制，首先我们还需了解以下两个类：android.app.Application 和 java.lang.Thread.UncaughtExceptionHandler。

　　Application：用来管理应用程序的全局状态。在应用程序启动时 Application 会首先创建，然后才会根据情况(Intent)来启动相应的Activity和Service。本文将自定义加强版的Application中注册未捕获异常处理器。

　　Thread.UncaughtExceptionHandler：线程未捕获异常处理器，用来处理未捕获异常。如果程序出现了未捕获异常，默认会弹出系统中强制关闭对话框。我们需要实现此接口，并注册为程序中默认未捕获异常处理。这样当未捕获异常发生时，就可以做一些个性化自定义的异常处理操作。

 1、实现 Thread.UncaughtExceptionHandler 接口

package com.yimx.test;

import java.io.File;
import java.io.FileOutputStream;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.io.Writer;
import java.lang.Thread.UncaughtExceptionHandler;
import java.lang.reflect.Field;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;

import android.content.Context;
import android.content.pm.PackageInfo;
import android.content.pm.PackageManager;
import android.content.pm.PackageManager.NameNotFoundException;
import android.os.Build;
import android.os.Environment;
import android.os.Looper;
import android.util.Log;
import android.widget.Toast;

/**
 * UncaughtException处理类,当程序发生Uncaught异常的时候,有该类来接管程序,并记录发送错误报告. 
 * Created by YIYI on 2017/10/10.
 */

public class CrashHandler implements UncaughtExceptionHandler {
    public static final String TAG = "CrashHandler";
    //系统默认的UncaughtException处理类   
    private Thread.UncaughtExceptionHandler mDefaultHandler;
    //CrashHandler实例  
    private static CrashHandler INSTANCE = new CrashHandler();
    //程序的Context对象  
    private Context mContext;
    //用来存储设备信息和异常信息  
    private Map<String, String> infos = new HashMap<String, String>();

    //用于格式化日期,作为日志文件名的一部分  
    private DateFormat formatter = new SimpleDateFormat("yyyyMMddHHmmss");

    //保证只有一个CrashHandler实例  
    private CrashHandler() {
        //构造函数
    }

    //获取CrashHandler实例,单例模式
    public static CrashHandler getInstance(){
        return INSTANCE;
    }

    /**
     *  初始化
     *  @param context
     */
    public void init(Context context){
        mContext = context;
        //获取系统默认的UncaughtException处理器 
        mDefaultHandler = Thread.getDefaultUncaughtExceptionHandler();
        //设置该CrashHandler为程序的默认处理器 
        Thread.setDefaultUncaughtExceptionHandler(this);
    }
    /**
     *  当UncaughtException发生时会转入该函数来处理
     */
    @Override
    public void uncaughtException(Thread thread, Throwable ex){
        if(!handleException(ex) && mDefaultHandler != null)
        {
            //如果用户没有处理则让系统默认的异常处理器来处理 
            mDefaultHandler.uncaughtException(thread, ex);
        }
        else{
            try{
                Thread.sleep(3000);
            }catch(InterruptedException e){
                Log.e(TAG, "error : ", e);
            }
            //退出程序 
            android.os.Process.killProcess(android.os.Process.myPid());
            System.exit(1);
        }
    }

    /** 
       * 自定义错误处理,收集错误信息 发送错误报告等操作均在此完成. 
       *  
       * @param ex 
       * @return true:如果处理了该异常信息;否则返回false. 
       */
    private boolean handleException(Throwable ex) {
        if (ex == null)
            return false;

        //使用Toast来显示异常信息  
        new Thread(){
            @Override
            public void run(){
                Looper.prepare();
                Toast.makeText(mContext, "很抱歉,应用出现异常,即将退出！", Toast.LENGTH_LONG).show();
                Looper.loop();
            }
        }.start();
        //收集设备参数信息 
        collectDeviceInfo(mContext);
        //保存日志文件  
        saveCrashInfo2File(ex);
        return true;
    }

    /** 
     * 收集设备参数信息 
     * @param ctx 
     */
    public void collectDeviceInfo(Context ctx){
        try{
            PackageManager pm = ctx.getPackageManager();
            PackageInfo pi = pm.getPackageInfo(ctx.getPackageName(), PackageManager.GET_ACTIVITIES);
            if(pi != null) {
                String versionName = pi.versionName == null ? "null" : pi.versionName;
                String versionCode = pi.versionCode + "";
                infos.put("versionName", versionName);
                infos.put("versionCode", versionCode);
            }
        }catch(NameNotFoundException e){
            Log.e(TAG, "an error occured when collect package info", e);
        }
        Field[] fields = Build.class.getDeclaredFields();
        for (Field field : fields){
            try{
                field.setAccessible(true);
                infos.put(field.getName(), field.get(null).toString());
                Log.d(TAG, field.getName() + " : " + field.get(null));
            }catch(Exception e){
                Log.e(TAG, "an error occured when collect crash info", e);
            }
        }
    }

    /**
     * 保存错误信息到文件中
     * @param ex
     * @return 返回文件名称,便于将文件传送到服务器
     */
    private String saveCrashInfo2File(Throwable ex){
        StringBuffer sBuffer = new StringBuffer();
        for(Map.Entry<String, String> entry : infos.entrySet()){
            String key = entry.getKey();
            String value = entry.getValue();
            sBuffer.append(key + "=" + value + "\n");
        }

        Writer writer = new StringWriter();
        PrintWriter printWriter = new PrintWriter(writer);
        ex.printStackTrace(printWriter);
        Throwable cause = ex.getCause();
        while(cause != null){
            cause.printStackTrace(printWriter);
            cause = cause.getCause();
        }
        printWriter.close();
        String result = writer.toString();
        sBuffer.append(result);

        String fileName = null;
        try{
            long timestamp = System.currentTimeMillis();
            String currTime = formatter.format(new Date());
            fileName = "crash-" + currTime + "-" + timestamp + ".log";
            if(Environment.getExternalStorageState().equals(Environment.MEDIA_MOUNTED)){
                String path = "/sdcard/LPG/log/";
                File dir = new File(path);
                if(!dir.exists()){
                    dir.mkdirs();
                }

                FileOutputStream foStream = new FileOutputStream(path + fileName);
                foStream.write(sBuffer.toString().getBytes());
                foStream.close();
            }
        }catch(Exception e){
            Log.e(TAG, "an error occured while writing file...", e);
        }
        return fileName;
    }
}

　　在收集异常信息时，朋友们也可以使用Properties，因为Properties有一个很便捷的方法properties.store(OutputStream out, String comments)，用来将Properties实例中的键值对外输到输出流中，但是在使用的过程中发现生成的文件中异常信息打印在同一行，看起来极为费劲，所以换成Map来存放这些信息，然后生成文件时加了些格式化操作。

3、创建自定义 MyApplication 类，继承自 android.app.Application

package com.yimx.test;

import android.app.Application;

/**
 * Created by yimx on 2017-10-10.
 */
public class MyApplication extends Application {
    @Override
    public void onCreate(){
        super.onCreate();
        CrashHandler crashHandler = CrashHandler.getInstance(); //获取异常处理实例
        crashHandler.init(getApplicationContext());
    }
}

4、为了让新建的 MyApplication 取代 android.app.Application 的地位，在代码中生效，需要修改AndroidManifest.xml：

<application android:name=".MyApplication" ...>  
</application>  

　　 因为在 CrashHandler 中，遇到异常后要保存设备参数和具体异常信息到 SDCARD，所以我们需要在AndroidManifest.xml中加入读写SDCARD权限：

<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/> 

　　至此，未捕获异常处理完成。

三、异常上传

　　有时，需要将此日志文件上传到服务器，有关文件上传的技术，请参照Android中使用HTTP服务相关介绍。

　　在使用HTTP服务之前，需要确定网络畅通，可以使用下面的方式判断网络是否可用：

/**
     * 网络是否可用
     * @param context
     * @return
     */
    public static boolean isNetworkAvailable(Context context){
        ConnectivityManager connectivityManager = (ConnectivityManager)context.getSystemService(Context.CONNECTIVITY_SERVICE);
        //新版本调用方法获取网络状态
        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP) {
            Network[] networks = connectivityManager.getAllNetworks();
            NetworkInfo networkInfo;
            for (Network mNetwork : networks) {
                networkInfo = connectivityManager.getNetworkInfo(mNetwork);
                if (networkInfo.getState().equals(NetworkInfo.State.CONNECTED)) {
                    return true;
                }
            }
        }else {
            //否则调用旧版本方法
            if (connectivityManager != null) {
                NetworkInfo[] info = connectivityManager.getAllNetworkInfo();
                if (info != null) {
                    for (NetworkInfo anInfo : info) {
                        if (anInfo.getState() == NetworkInfo.State.CONNECTED) {
                            Log.d("Network","NETWORKNAME: " + anInfo.getTypeName());
                            return true;
                        }
                    }
                }
            }
        }
        return false;
    }/**
     * 网络是否可用
     * @param context
     * @return
     */
    public static boolean isNetworkAvailable(Context context){
        ConnectivityManager connectivityManager = (ConnectivityManager)context.getSystemService(Context.CONNECTIVITY_SERVICE);
        //新版本调用方法获取网络状态
        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP) {
            Network[] networks = connectivityManager.getAllNetworks();
            NetworkInfo networkInfo;
            for (Network mNetwork : networks) {
                networkInfo = connectivityManager.getNetworkInfo(mNetwork);
                if (networkInfo.getState().equals(NetworkInfo.State.CONNECTED)) {
                    return true;
                }
            }
        }else {
            //否则调用旧版本方法
            if (connectivityManager != null) {
                NetworkInfo[] info = connectivityManager.getAllNetworkInfo();
                if (info != null) {
                    for (NetworkInfo anInfo : info) {
                        if (anInfo.getState() == NetworkInfo.State.CONNECTED) {
                            Log.d("Network","NETWORKNAME: " + anInfo.getTypeName());
                            return true;
                        }
                    }
                }
            }
        }
        return false;
    }