# **Recovery**
A crash recovery framework!

----

[ ![Download](https://api.bintray.com/packages/sunzxyong/maven/Recovery/images/download.svg) ](https://bintray.com/sunzxyong/maven/Recovery/_latestVersion) ![build](https://img.shields.io/badge/build-passing-blue.svg) [![License](https://img.shields.io/hexpm/l/plug.svg)](https://github.com/Sunzxyong/Recovery/blob/master/LICENSE)

[英文文档](https://github.com/Sunzxyong/Recovery/blob/master/README.md)

# **Introduce**

[博客介绍](http://zhengxiaoyong.com/2016/09/05/Android%E8%BF%90%E8%A1%8C%E6%97%B6Crash%E8%87%AA%E5%8A%A8%E6%81%A2%E5%A4%8D%E6%A1%86%E6%9E%B6-Recovery)

“Recovery”帮助你自动处理程序在运行时的Crash，它含有以下几点功能

* 自动恢复Activity Stack和数据
* 支持只恢复栈顶Activity
* Crash信息的显示与保存
* 应用重启或者清空缓存
* 一分钟内两次恢复失败不再恢复而进行重启应用

# **Art**
![recovery](http://7xswxf.com2.z0.glb.qiniucdn.com//blog/recovery.jpg)

# **Usage**
## **Reference**
**Gradle**

```
	implementation 'com.zxy.android:recovery:1.0.0'
```

或者

```gradle
    debugImplementation 'com.zxy.android:recovery:1.0.0'
    releaseImplementation 'com.zxy.android:recovery-no-op:1.0.0'
```


**Maven**

```
		<dependency>
  			<groupId>com.zxy.android</groupId>
  			<artifactId>recovery</artifactId>
  			<version>1.0.0</version>
  			<type>pom</type>
		</dependency>
```
## **Init**
你可以使用类似如下初始化代码在你自定义的Application中进行初始化：

```java
        Recovery.getInstance()
                .debug(true)
                .recoverInBackground(false)
                .recoverStack(true)
                .mainPage(MainActivity.class)
                .recoverEnabled(true)
                .callback(new MyCrashCallback())
                .silent(false, Recovery.SilentMode.RECOVER_ACTIVITY_STACK)
                .skip(TestActivity.class)
                .init(this);
```

如果你不想在应用发生Crash时显示RecoveryActivity，你可以使用静默恢复来进行无界面的恢复你的应用，那么请使用类似如下初始化代码在你自定义的Application中进行初始化：

```java
        Recovery.getInstance()
                .debug(true)
                .recoverInBackground(false)
                .recoverStack(true)
                .mainPage(MainActivity.class)
                .recoverEnabled(true)
                .callback(new MyCrashCallback())
                .silent(false, Recovery.SilentMode.RECOVER_ACTIVITY_STACK)
                .skip(TestActivity.class)
                .init(this);
```

如果你仅仅需要在开发时显示RecoveryActivity界面来获取debug数据，而在线上版本不显示，那么可以设置`recoverEnabled(false);`

## **Arguments**

| Argument | Type | Function |
| :-: | :-: | :-: |
| debug | boolean | 是否开启debug模式 |
| recoverInBackgroud | boolean | 当应用在后台时发生Crash，是否需要进行恢复  |
| recoverStack | boolean | 是否恢复整个Activity Stack，否则将恢复栈顶Activity |
| mainPage | Class<? extends Activity> | 回退的界面 |
| callback | RecoveryCallback | 发生Crash时的回调 |
| silent | boolean,SilentMode | 是否使用静默恢复，如果设置为true的情况下，那么在发生Crash时将不显示RecoveryActivity界面来进行恢复，而是自动的恢复Activity的堆栈和数据，也就是无界面恢复 |

**SilentMode**
> 1. RESTART - 重启应用
> 2. RECOVER_ACTIVITY_STACK - 恢复Activity堆栈
> 3. RECOVER_TOP_ACTIVITY - 恢复栈顶Activity
> 4. RESTART_AND_CLEAR - 重启应用并清空缓存数据

## **Callback**

```
public interface RecoveryCallback {

    void stackTrace(String stackTrace);

    void cause(String cause);

    void exception(String throwExceptionType, String throwClassName, String throwMethodName, int throwLineNumber);
    
    void throwable(Throwable throwable);
}
```

## **Custom Theme**

自定义RecoveryActivity的主题，需重写以下styles属性：

```
    <color name="recovery_colorPrimary">#2E2E36</color>
    <color name="recovery_colorPrimaryDark">#2E2E36</color>
    <color name="recovery_colorAccent">#BDBDBD</color>
    <color name="recovery_background">#3C4350</color>
    <color name="recovery_textColor">#FFFFFF</color>
    <color name="recovery_textColor_sub">#C6C6C6</color>
```
## **Crash File Path**
> {SDCard Dir}/Android/data/{packageName}/files/recovery_crash/

## **Update history**
* `VERSION-0.0.5`——**支持静默恢复**
* `VERSION-0.0.6`——**加强静默恢复模式的保护**
* `VERSION-0.0.7`——**添加混淆配置**
* `VERSION-0.0.8`——**增加可配置不需要恢复的Activity,方法:skip()**
* `VERSION-0.0.9`——**更新UI和解决一些问题**
* `VERSION-0.1.0`——**异常传递的优化,可在任意位置初始化Recovery框架,发布正式版本**
* `VERSION-0.1.3`——**增加no-op包**
* `VERSION-0.1.4`——**更新默认主题.**
* `VERSION-0.1.5`——**fix 8.0+ hook bug**
* `VERSION-0.1.6`——**update**
* `VERSION-1.0.0`——**修复8.0上兼容性问题**

## **About**
* **Blog**：[https://zhengxiaoyong.com](https://zhengxiaoyong.com)
* **Wechat**：

![](https://raw.githubusercontent.com/Sunzxyong/ImageRepository/master/qrcode.jpg)

# **LICENSE**

```
   Copyright 2016 zhengxiaoyong

   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.
```