首頁 > 軟體

Android實現友好崩潰介面

2021-11-25 19:00:29

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

安裝到手機上測試一下

點選【崩潰測試】按鈕

這裡的演示程式並沒有新增向開發者提交錯誤報告的功能,當然本文的重點在於實現友好的崩潰介面,在此基礎上的更多功能請讀者自行實現。

以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支援it145.com。


IT145.com E-mail:sddin#qq.com