CustomActivityOnCrash开源项目使用手册

CustomActivityOnCrash开源项目使用手册

CustomActivityOnCrashAndroid library that allows launching a custom activity when your app crashes, instead of showing the hated "Unfortunately, X has stopped" dialog.项目地址:https://gitcode.com/gh_mirrors/cu/CustomActivityOnCrash

1. 项目目录结构及介绍

CustomActivityOnCrash是一个旨在改进Android应用程序崩溃处理的开源库。以下是其基本的目录结构概览及其简要描述：

• src/main/java/cat/ereza/customactivityoncrash: 主要源码存放区，包含核心类如CustomActivityOnCrash，用于管理和控制应用崩溃后的逻辑。
  • CustomActivityOnCrash.java: 核心类，提供了自动重启应用、自定义崩溃界面等功能的关键接口。
• src/main/res: 资源文件夹，包括字符串资源(strings.xml)用于默认错误信息，以及可能的布局文件等。
• sample: 示例应用模块，展示了如何集成CustomActivityOnCrash并自定义崩溃界面的实践。
• README.md: 项目的主要说明文件，包含了快速入门指南、配置方法和使用案例。

2. 项目的启动文件介绍

在实际应用中，集成CustomActivityOnCrash通常从Application类开始。你需要在你的自定义Application类中初始化这个库。示例代码如下：

import cat.ereza.customactivityoncrash.CustomActivityOnCrash;

@Override
public void onCreate() {
    super.onCreate();
    
    // 初始化CustomActivityOnCrash
    CustomActivityOnCrash.install(this, new CustomActivityOnCrash.EventListener() {
        @Override
        public void onPreCrash(CustomActivityOnCrash.PreCrashInformation preCrashInfo) {
            // 可选：在这个回调中可以做一些数据保存等预处理工作
        }
        
        @Override
        public void onPostCrash(CustomActivityOnCrash.PostCrashInformation postCrashInfo) {
            // 可选：崩溃后执行的逻辑，例如上传错误报告
        }
    })
    .showErrorDetails(true)     // 是否显示详细错误信息
    .trackActivities(true);     // 是否跟踪活动
}

确保在你的AndroidManifest.xml中指定了自定义的Application类。

3. 项目的配置文件介绍

AndroidManifest.xml配置

首先，确保在你的应用的AndroidManifest.xml文件中声明了你的自定义Application类，如下所示：

<application
    android:name=".YourCustomApplication"
    ...>
    <!-- Other activities, services, etc. -->
</application>

build.gradle 配置

在你的模块的build.gradle文件中添加CustomActivityOnCrash的依赖：

dependencies {
    implementation 'cat.ereza:customactivityoncrash:latest.version'
}

替换latest.version为最新的版本号，可以从GitHub releases页面找到。

自定义配置

在你的代码中，你可以通过调用.handleActivityExceptions()、.forceCloseOnError()等方法进一步定制行为。此外，如前所述，在install()方法中传入的EventListener可以让您自定义崩溃前后的行为。

通过以上步骤，您就可以充分利用CustomActivityOnCrash库，实现更友好的应用错误处理机制。记得查看GitHub上的项目页面获取最新信息和详细的API文档。

CustomActivityOnCrashAndroid library that allows launching a custom activity when your app crashes, instead of showing the hated "Unfortunately, X has stopped" dialog.项目地址:https://gitcode.com/gh_mirrors/cu/CustomActivityOnCrash