Skip to content

Latest commit

 

History

History
266 lines (185 loc) · 7.17 KB

README_zh.md

File metadata and controls

266 lines (185 loc) · 7.17 KB
Raw

SaveState

Download

自动恢复 Activity、Fragment 以及 View 的状态。

无需任何类似 onSaveInstanceState 以及 onRestoreInstanceState 的模板代码。

如何使用

在成员变量上标记 @AutoRestore 注解。

在 Activity 中使用：

class MyActivity : Activity() {

    @AutoRestore
    var myInt: Int = 0;

    @AutoRestore
    var myRpcCall: IBinder? = null;

    @AutoRestore
    var result: String? = null;

    override fun onCreate(savedInstanceState: Bundle?) {
        // Your code here
    }
}

在 Fragment 中使用：

class MyFragment : Fragment() {

    @AutoRestore
    var currentLoginUser: User? = null;

    @AutoRestore
    var networkResponse: List<Map<String, Object>>? = null;

    override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View? {
        // Your code here
    }
}

在自定义 View 中使用：

class MyView : FrameLayout {

    @AutoRestore
    val someText: String? = null;

    @AutoRestore
    val size: Size? = null;

    @AutoRestore
    val myFloatArray: FloatArray? = null;

    constructor(context: Context) : super(context) {
        // your code here
    }

    constructor(context: Context, attrs: AttributeSet?) : super(context, attrs) {
        // your code here
    }

    constructor(context: Context, attrs: AttributeSet?, defStyleAttr: Int) : super(context, attrs, defStyleAttr) {
        // your code here
    }

}

没错，就这么简单，只需要在变量上标记 @AutoRestore 注解。

现在就接入 SaveState

在项目根目录的 build.gradle 中增加以下内容：

buildscript {

    repositories {
        google()
        jcenter()
    }
    dependencies {
        // your other dependencies

        // dependency for save-state
        classpath "io.github.prototypez:save-state:${latest_version}"
    }
}

SaveState 当前最新版本： Download

然后在您的项目的 application 模块的 build.gradle 中应用插件：

apply plugin: 'com.android.application'
apply plugin: 'save.state'

如果您的模块包含 kotlin 代码， 请确保 kotlin-kapt 插件也同步导入：

apply plugin: 'com.android.application'
apply plugin: 'kotlin-android'
apply plugin: 'kotlin-kapt'
apply plugin: 'save.state'

如果你的项目中还有其他 library 模块也需要使用 SaveState，那么只需要在对应模块的 build.gradle 中也应用插件即可：

apply plugin: 'com.android.library'
apply plugin: 'save.state'

如果 library 模块也包含 kotlin 代码，那和 application 模块类似：

apply plugin: 'com.android.library'
apply plugin: 'kotlin-android'
apply plugin: 'kotlin-kapt'
apply plugin: 'save.state'

注意事项：如果您的模块是纯 Java 模块，那么 SaveState 默认使用 annotationProcessor; 而如果你的模块包含 kotlin 代码，那么 SaveState 则会在编译时使用 kotlin-kapt 插件。 所以如果您的模块包含 kotlin 代码，同时又使用 SaveState 插件的情况下， 请保证其他注解处理框架统一使用 kapt 插件。 例如：Dagger, DeepLinkDispatch 的写法应改造为：

kapt "com.google.dagger:dagger-compiler:${dagger_version}"
kapt "com.airbnb:deeplinkdispatch-processor:${deeplinkdispatch_version}"

支持的变量类型

如果被 @AutoRestore 标记的字段是下列类型之一，那么不需要额外的配置, SaveState 就可以帮您自动保存与恢复变量。

基本数据类型（包装类型） 对象 数组
int/Integer Serializable byte[]
long/Long IBinder short[]
short/Short Bundle char[]
float/Float CharSequence float[]
double/Double Parcelable CharSequence[]
byte/Byte Size Parcelable[]
char/Character SizeF
boolean/Boolean String

自定义变量类型

如果您需要自动保存与恢复的变量不属于上面类型中的任意一种，并且您的变量类型可以被序列化为 JSON , 那么 SaveState 可以通过把这个对象和与它对应的 JSON 字符串之间的序列化和反序列化操作, 来实现变量的自动保存与恢复。

例如自定义对象：

class User (
    val name: String,
    val age: Int
)


class NetworkResponse<T> (
    val resultCode: Int,
    val data: T?
)

类似这样的对象都可以通过 SaveState 来自动恢复：

class MyActivity : Activity() {

    @AutoRestore
    var user: User? = null

    @AutoRestore
    var response: NetworkResponse<List<User>>? = null
}

额外的配置操作有：

  1. 确保项目中已引入 支持的JSON序列化库 之一
  2. 在模块( com.android.application / com.android.library )的 build.gradle 中加入配置,

如果是纯 Java 模块：

defaultConfig {

    // your other configs

    // 配置 JSON 序列化库
    javaCompileOptions {
        annotationProcessorOptions {
            arguments = [ serializer : "/*JSON库*/" ]
        }
    }
}

如果是启用了 kotlin 的模块：

kapt {
    arguments {
        arg("serializer", "/*JSON库*/")
    }
}

目前支持的 JSON 序列化库有：

FAQ

  • Q: SaveState 支持 Instant Run 吗？

    A: 是的，基于 Transform API, 所以支持。

  • Q: 需要配置 Proguard 混淆规则吗？

    A: 没有使用任何反射，不需要额外配置。

  • Q: SaveState 性能如何？

    A: 当前版本基于编译时字节码修改以及 AnnotationProcessor，所以运行时性能几乎和手写是一样的，编译时因为插入了额外的任务，会稍微影响编译速度，但是根据实测，这点影响是可以忽略不计的。

  • Q: SaveState 大吗？会影响打包出来 APK 大小吗？

    A: SaveState 主要工作都在编译时完成，运行时没有任何依赖，不用担心影响 APK 大小。

LICENSE

Copyright (c) 2016-present, SateState Contributors.

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.