Android实现友好崩溃界面

Z时代
2024-01-10
分类：IT

Android 的默认崩溃机制是 APP 闪退，然后显示一个【xxx 已停止运行】的对话框或 Toast，而崩溃的详情只有开发者在 Logcat 里才能看到，用户看到发生了这样的情况肯定一头雾水，的确，这样默认的异常处理方式很不友好，容易造成用户流失。我们现在要做的是，程序发生异常时，新开一个 Activity 向用户致歉，输出详细的异常信息，并提供将异常信息提交给开发者的功能。

首先，在 BaseActivity 里封装方法：


/**
 * BaseActivity: 该抽象类定义所有活动均拥有的共同属性。
 * 本 APP 中所有活动对象均继承此类。
 */
public abstract class BaseActivity extends AppCompatActivity {
    private static final AppManager MANAGER = AppManager.get();
    /**
     * onCreate(): 重写父类的 onCreate() 方法，向应用管理器中添加本活动。
     */
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        MANAGER.addActivity(this);
    } // onCreate()
    /**
     * onDestroy(): 重写父类的 onDestroy() 方法，从应用管理器中移除本活动。
     */
    @Override
    protected void onDestroy() {
        super.onDestroy();
        MANAGER.removeActivity(this);
    } // onDestroy()
    /**
     * crash(): 捕获到非预期的异常后强制令程序崩溃。
     *
     * @param e 传入造成崩溃的异常对象。
     */
    protected void crash(Exception e) {
        Intent i;
        String dump;
        PrintWriter pw;
        StringWriter sw;
        sw = new StringWriter();
        pw = new PrintWriter(sw);
        e.printStackTrace(pw);
        pw.flush();
        dump = sw.toString();
        i = new Intent(this, CrashActivity.class);
        i.putExtra("dump", dump);
        startActivity(i);
        MANAGER.finishAllExcept(CrashActivity.class);
    } // crash()
    /**
     * getCrashDump(): 仅限 CrashActivity 调用。
     * 获得传入的 dump 信息。
     *
     * @return 传入的 dump 信息。
     */
    String getCrashDump() {
        return getIntent().getStringExtra("dump");
    } // getCrashDump()
} // BaseActivity Abstract Class
// E.O.F

BaseActivity 里用到了两个自定义类，AppManager 和 CrashActivity。后面添加的这两个类请确保和 BaseActivity 在同一包下。

添加 AppManager 类：


/**
 * AppManager: 用于对活动进行管理。该模块仅限 base 包内使用。
 * 该模块为单一实例，您需要调用 AppManager.get() 获取实例后再调用方法。
 * <p>
 * 为确保应用管理器正常工作，请新建一个继承 Activity 的抽象类 BaseActivity，
 * 然后重写 BaseActivity 类的 onCreate() 和 onDestroy() 方法。
 * 请给 BaseActivity 类的 onCreate() 方法添加如下代码：
 * AppManager.get().addActivity(this);
 * 请给 BaseActivity 类的 onDestroy() 方法添加如下代码：
 * AppManager.get().removeActivity(this);
 * 最后，确保本 APP 内的所有活动类均继承于 BaseActivity 类。
 */
class AppManager {
    private static final AppManager MANAGER = new AppManager();
    private Stack<BaseActivity> mStack;
    private AppManager() {
        // 将作用域关键字设置为 private 以隐藏该类的构造器。
        mStack = new Stack<>();
    } // AppManager() (Class Constructor)
    /**
     * get(): 获得 AppManager 类的单例。
     *
     * @return 该类的单例 MANAGER。
     */
    static AppManager get() {
        return MANAGER;
    } // get()
    /**
     * addActivity(): 向堆栈中添加一个活动对象。
     *
     * @param activity 要添加的活动对象。
     */
    void addActivity(BaseActivity activity) {
        mStack.add(activity);
        Log.i("AppManager", "[+] Created: " + activity.getClass().getName());
    } // addActivity()
    /**
     * removeActivity(): 从堆栈中移除一个活动对象。
     *
     * @param activity 要移除的活动对象。
     */
    void removeActivity(BaseActivity activity) {
        mStack.remove(activity);
        Log.i("AppManager", "<-> Removed: " + activity.getClass().getName());
    } // removeActivity()
    /**
     * finishAllExcept(): 除一个特定活动外，结束堆栈中其余所有活动。
     * 结束活动时会触发 BaseActivity 类的 onDestroy()方法，
     * 堆栈中的活动对象会同步移除。
     *
     * @param cls 要保留的活动的类名（xxxActivity.class）
     */
    void finishAllExcept(Class<?> cls) {
        int i, len;
        BaseActivity[] activities;
        // 结束活动时会调用活动的 onDestroy() 方法，堆栈的内容会实时改变
        // 为避免因此引起的引用错误，先将堆栈的内容复制到一个临时数组里
        activities = mStack.toArray(new BaseActivity[0]);
        len = activities.length;
        for (i = 0; i < len; ++i) {
            if (activities[i].getClass() != cls) {
                // 从数组里引用活动对象并结束，堆栈内容的改变不影响数组
                activities[i].finish();
            } // if (activities[i].getClass() != cls)
        } // for (i = 0; i < len; ++i)
    } // finishAllExcept()
    /**
     * finishAllActivities(): 结束堆栈中的所有活动。
     * 结束活动时会触发 BaseActivity 类的 onDestroy()方法，
     * 堆栈中的活动对象会同步移除。
     */
    void finishAllActivities() {
        int i, len;
        BaseActivity[] activities;
        // 结束活动时会调用活动的 onDestroy() 方法，堆栈的内容会实时改变
        // 为避免因此引起的引用错误，先将堆栈的内容复制到一个临时数组里
        activities = mStack.toArray(new BaseActivity[0]);
        len = activities.length;
        for (i = 0; i < len; ++i) {
            // 从数组里引用活动对象并结束，堆栈内容的改变不影响数组
            activities[i].finish();
        } // for (i = 0; i < len; ++i)
    } // finishAllActivities()
} // AppManager Class
// E.O.F

新建 CrashActivity 活动。

活动的布局文件 activity_crash.xml


<?xml version="1.0" encoding="utf-8"?>
<android.support.constraint.ConstraintLayout 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:background="#1A237E"
    tools:context=".base.CrashActivity">
    <!-- 请自行设置 background 和 textColor -->
    <TextView
        android:id="@+id/lblCrashMsg"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_marginStart="8dp"
        android:layout_marginLeft="8dp"
        android:layout_marginTop="8dp"
        android:layout_marginEnd="8dp"
        android:layout_marginRight="8dp"
        android:layout_marginBottom="8dp"
        android:gravity="center"
        android:text="@string/lblCrashMsg"
        android:textAppearance="?android:attr/textAppearanceMedium"
        android:textColor="#EEEEEE"
        app:layout_constraintBottom_toTopOf="@+id/lblCrashDetail"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toTopOf="parent" />
    <TextView
        android:id="@+id/lblCrashDetail"
        android:layout_width="0dp"
        android:layout_height="0dp"
        android:layout_marginStart="8dp"
        android:layout_marginLeft="8dp"
        android:layout_marginTop="8dp"
        android:layout_marginEnd="8dp"
        android:layout_marginRight="8dp"
        android:layout_marginBottom="8dp"
        android:textColor="#EEEEEE"
        android:typeface="monospace"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toBottomOf="@+id/lblCrashMsg" />
</android.support.constraint.ConstraintLayout>

字符串资源 strings.xml 里添加


<string name="lblCrashMsg">
    程序发生了非预期错误
    \n非常抱歉给您造成不便
    \n以下是错误详情
</string>

CrashActivity.java 代码：


/**
 * CrashActivity: 该活动由任意活动调用 crash() 方法激活。输出抛出的异常信息。
 */
public class CrashActivity extends BaseActivity { // 注意此处是继承 BaseActivity
    /**
     * onCreate(): 活动创建时触发。
     */
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        String dump;
        TextView lblDetail;
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_crash);
        dump = getCrashDump();
        lblDetail = findViewById(R.id.lblCrashDetail);
        lblDetail.setText(dump);
        lblDetail.setMovementMethod(ScrollingMovementMethod.getInstance());
    } // onCreate()
    /**
     * onKeyDown(): 按下回退键时触发。
     * 直接退出程序。
     */
    @Override
    public boolean onKeyDown(int keyCode, KeyEvent event) {
        if (keyCode == KeyEvent.KEYCODE_BACK) {
            AppManager.get().finishAllActivities();
            return true;
        } // if (keyCode == KeyEvent.KEYCODE_BACK)
        else {
            return super.onKeyDown(keyCode, event);
        } // else
    } // onKeyDown()
    /**
     * onUserLeaveHint(): 按下 HOME 键退回桌面时触发。直接退出程序。
     */
    @Override
    protected void onUserLeaveHint() {
        AppManager.get().finishAllActivities();
    } // onUserLeaveHint()
} // CrashActivity Class
// E.O.F

下面我们要做的就是，在程序抛出异常时捕获它，并将异常内容带入 CrashActivity 中。要实现这样的操作，我们需要在 Activity 中的所有 public 和 protected 方法里添加 try/catch 语句块。（private 方法不用添加，因为 private 方法也必然是由某个 public 或 protected 方法调用的，而调用它的 public/protected 方法已经在抓捕异常了）

我们在 MainActivity 里添加一个按钮。activity_main.xml 布局代码如下：


<?xml version="1.0" encoding="utf-8"?>
<android.support.constraint.ConstraintLayout 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"
    tools:context=".MainActivity">
    <Button
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:onClick="onBtnCrashTestTapped"
        android:text="@string/btnMainCrashTest"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        app:layout_constraintTop_toTopOf="parent" />
</android.support.constraint.ConstraintLayout>

strings.xml 里添加：


<string name="btnMainCrashTest">崩溃测试</string>

MainActivity.java 代码：


public class MainActivity extends BaseActivity { // 注意此处是继承 BaseActivity
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        // protected 方法必须以 try/catch 包裹
        // 在 catch 中加入 crash(e); 语句实现友好崩溃
        try {
            super.onCreate(savedInstanceState);
            setContentView(R.layout.activity_main);
        } // try
        catch (Exception e) {
            crash(e);
        } // catch (Exception e)
    } // onCreate()
    public void onBtnCrashTestTapped(View v) {
        int[] arr;
        // public 方法必须以 try/catch 包裹
        // 在 catch 中加入 crash(e); 语句实现友好崩溃
        try {
            arr = new int[4];
            crashTest(arr);
        } // try
        catch (Exception e) {
            crash(e);
        } // catch (Exception e)
    } // onBtnCrashTestTapped()
    private void crashTest(int[] arr) {
        // private 方法不用以 try/catch 包裹
        // 除非调用了带 throws 关键字的方法强制要求捕获异常
        arr[4] = 4; // 因为传入的 arr 数组长度为 4，所以此处会抛出数组越界异常
    } // crashTest()
} // MainActivity Class
// E.O.F