6 Star 1 Fork 0

hihopeorg / CustomActivityOnCrash

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

CustomAbilityOnCrash

本项目是基于开源项目CustomActivityOnCrash进行ohos化的移植和开发的,可以通过项目标签以及github地址( https://github.com/Ereza/CustomActivityOnCrash )追踪到原项目版本

项目介绍

  • 项目名称:自定义应用崩溃时的页面
  • 所属系列:ohos的第三方组件适配移植
  • 功能:监听崩溃,自定义崩溃页面,设置重启的的目标页面,复制异常信息到剪贴板
  • 项目移植状态:完成
  • 调用差异:无
  • 项目作者和维护人:hihope
  • 联系方式:hihope@hoperun.com
  • 原项目Doc地址:https://github.com/Ereza/CustomActivityOnCrash
  • 原项目基线版本:v2.3.0
  • 编程语言:Java
  • 外部库依赖:无

效果预览

安装教程

方案一:
  1. 编译依赖包 library-release.har。
  2. 启动 DevEco Studio,将编译的har包,导入工程目录“entry->libs”下。
  3. 在moudle级别下的build.gradle文件中添加依赖,在dependences标签中增加对libs目录下har包的引用。
dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar', '*.har'])
	……
}
  1. 在导入的har包上点击右键,选择“Add as Library”对包进行引用,选择需要引用的模块,并点击“OK”即引用成功。
方案二:
  1. 在工程的build.gradle的allprojects中,添加HAR所在的Maven仓地址
repositories {
    maven {
        url 'http://106.15.92.248:8081/repository/Releases/' 
    }
}
  1. 在应用模块的build.gradle的dependencies闭包中,添加如下代码:
dependencies {
    implementation 'cat.ereza.ohos:customactivityoncrash:1.0.1'
}

使用说明

1、初始化,在应用程序的AbilityPackage类中的onInitialize方法中添加如下代码

CustomAbilityOnCrash.install(this);

2、设置配置

CaocConfig.Builder.create()
        .backgroundMode(CaocConfig.BACKGROUND_MODE_SILENT)
        .enabled(true)
        .showErrorDetails(true)
        .showRestartButton(true)
        .trackAbilities(true)
        .logErrorOnRestart(true)
        .minTimeBetweenCrashesMs(10000)
        .errorDrawable(ResourceTable.Media_icon)
        .restartAbility(MainAbility.class)
        .errorAbility(CustomErrorAbility.class)
        .eventListener(new CustomEventListener())
        .apply();

####下面是可以使用的每个选项的详细的说明CaocConfig.Builder:

backgroundMode(int);

这个方法定义当应用程序在后台崩溃时是否应该启动错误活动。 有三种模式:

  • CaocConfig.BACKGROUND_MODE_SHOW_CUSTOM: 即使应用程序在后台,也要启动错误活动。
  • CaocConfig.BACKGROUND_MODE_CRASH: 当应用程序在后台时,启动默认的系统错误。
  • CaocConfig.BACKGROUND_MODE_SILENT: 当应用程序在后台时无声崩溃。

默认值是CaocConfig.BACKGROUND_MODE_SHOW_CUSTOM.

enabled(boolean);

定义是否启用了CustomAbilityOnCrash崩溃拦截机制。 如果你想让CustomAbilityOnCrash拦截崩溃,设置为“true”, 如果您希望将它们视为未安装库则设置为“false”。 这可用于根据喜好或构建类型启用或禁用库。 默认值是' true '。

showErrorDetails(boolean);

这个方法定义了error活动是否必须显示一个带有错误细节的按钮。 如果您将其设置为' false',默认error活动上的按钮将消失,从而使用户无法看到堆栈跟踪。 默认值是' true '。

trackAbilities(boolean);

该方法定义库是否必须跟踪用户访问的活动及其生命周期调用。 这将作为错误详细信息的一部分显示在默认错误活动中。 默认值是' false '。

showRestartButton(boolean);

这个方法定义了error活动是必须显示“Restart app”按钮还是“Close app”按钮。 如果你将其设置为' false',默认error活动上的按钮将关闭应用程序,而不是重新启动。 如果你将其设置为“true”,并且你的应用程序没有启动活动,它仍然会显示“关闭应用程序”按钮! 默认值是' true '。

logErrorOnRestart(boolean);

这将控制在启动自定义错误活动时是否必须重新记录堆栈跟踪。 默认值是' true '。

minTimeBetweenCrashesMs(boolean);

定义应用程序崩溃之间必须经过的时间,以确定我们没有陷入崩溃循环。 如果崩溃发生的次数比上次少,则不会启动错误活动,并且会调用系统崩溃屏幕。 默认值是' 3000 '。

errorDrawable(Integer);

这个方法允许用你选择的图像来改变默认的错误图像。 默认值是' null '(使用错误图像)。

restartAbility(Class<? extends Ability>);

当按下重启应用按钮时,设置将要重启的页面,这需要与showRestartButton方法配合使用,只有同时将showRestartButton设置为true,且设置了restartAbility,才可正确启动应用(该ability需要在config.json中预先进行配置)

errorAbility(Class<? extends Ability>);

设置需要启动的自定义错误页面,而不是默认的错误页面,该页面需要在config.json中预先进行配置

eventListener(EventListener);

这个方法允许你指定一个事件监听器,以便在库显示错误活动、重启或关闭应用程序时得到通知。 您提供的EventListener不能是匿名或非静态的内部类,因为它需要由库序列化。如果试图设置无效类,库将抛出异常。 如果将其设置为' null ',则不会调用事件侦听器。 默认值是' null '。

版本迭代

  • v1.0.1

版权和许可信息

  • Apache Licence
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

自定义应用崩溃时的页面 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/hihopeorg/CustomActivityOnCrash.git
git@gitee.com:hihopeorg/CustomActivityOnCrash.git
hihopeorg
CustomActivityOnCrash
CustomActivityOnCrash
master

搜索帮助