安卓开发定义一个全局的捕获异常，提升客户体验

Posted 2022-04-28 Gradle官方文件

今天就来介绍一下如何在程序崩溃的情况下收集相关的设备参数信息和具体的异常信息，并发送这些信息到服务器供开发者分析和调试程序。

CrashHandler

package com.luyuesports.crashdemo;
import java.io.File;
import java.io.FileOutputStream;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.io.Writer;
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.annotation.SuppressLint;
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;

/**
 * Created by joey on 2017/3/31.
 */

public class CrashHandler implements Thread.UncaughtExceptionHandler 
    public static final String TAG = "bbb";

    // 系统默认的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("yyyy-MM-dd-HH-mm-ss");

    /** 保证只有一个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);
            

            AppManager.getAppManager().finishAllActivity();
            // 退出程序
            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);
        
        // 使用反射来收集设备信息.在Build类中包含各种设备信息,
        // 例如: 系统版本号,设备生产商 等帮助调试程序的有用信息
        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 返回文件名称,便于将文件传送到服务器
     */
    @SuppressLint("SdCardPath")
    private String saveCrashInfo2File(Throwable ex) 

        StringBuffer sb = new StringBuffer();
        for (Map.Entry<String, String> entry : infos.entrySet()) 
            String key = entry.getKey();
            String value = entry.getValue();
            sb.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();
        sb.append(result);
        try 
            String time = formatter.format(new Date());
            String fileName = "crash-" + time + ".log";
            if (Environment.getExternalStorageState().equals(
                    Environment.MEDIA_MOUNTED)) 
                String path = Environment.getExternalStorageDirectory()
                        .getAbsolutePath() + "/move_crash/";
                // String path = "/sdcard/crash/";
                File dir = new File(path);
                if (!dir.exists()) 
                    dir.mkdirs();
                
                FileOutputStream fos = new FileOutputStream(path + fileName);
                fos.write(sb.toString().getBytes());
                fos.close();
            
            return fileName;
         catch (Exception e) 
            Log.e(TAG, "an error occured while writing file...", e);
        
        return null;
    

AppManager

package com.luyuesports.crashdemo;

import android.app.Activity;

import java.util.Stack;

/**
  * 应用程序Activity管理类：用于Activity管理和应用程序退出
  */
public class AppManager 
    private static Stack<Activity> activityStack;
    private static AppManager instance;

    public AppManager() 

    public static AppManager getAppManager()
        if(instance==null)
            instance=new AppManager();
        
        return instance;
    

    //添加Activity到堆栈
    public void addActivity(Activity activity)
        if(activityStack==null)
            activityStack=new Stack<Activity>();
        
        activityStack.add(activity);
    

    public void finishAllActivity()
        for(int i=0;i<activityStack.size();i++)
            if(activityStack.get(i) != null)
                activityStack.get(i).finish();
            
        
        activityStack.clear();
    

Application

package com.luyuesports.crashdemo;

import android.app.Application;

/**
 * Created by joey on 2017/3/31.
 */

public class MyApp extends Application 
    @Override
    public void onCreate() 
        super.onCreate();
        CrashHandler crashHandler = CrashHandler.getInstance();
        crashHandler.init(getApplicationContext());
    

实例应用
xml

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:orientation="vertical"
    tools:context="com.luyuesports.crashdemo.MainActivity">

    <Button
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:text="设置崩溃"
        android:onClick="btnClick"/>
    <TextView
        android:id="@+id/tv"
        android:layout_width="match_parent"
        android:layout_height="wrap_content" />

</LinearLayout>

Activity

package com.luyuesports.crashdemo;

import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.view.View;
import android.widget.TextView;

public class MainActivity extends AppCompatActivity 
    private TextView tv;
    @Override
    protected void onCreate(Bundle savedInstanceState) 
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        AppManager.getAppManager().addActivity(this);

    

    public void btnClick(View view) 
        tv.setText("空指针了");
    

实现由bug出现不弹出错误框，并完美退出app