Parcelable 实现生成器

该 kotlin-parcelize 插件提供了一个 Parcelable 实现生成器。

要包含对 Parcelable 的支持，请将 Gradle 插件添加到应用的 build.gradle 文件中

Groovy

plugins {
    id 'kotlin-parcelize'
}

Kotlin

plugins {
    id("kotlin-parcelize")
}

当您使用 @Parcelize 注释类时，会自动生成 Parcelable 实现，如下例所示

import kotlinx.parcelize.Parcelize

@Parcelize
class User(val firstName: String, val lastName: String, val age: Int): Parcelable

@Parcelize 要求所有序列化属性都在主构造函数中声明。该插件会针对在类主体中声明的后备字段的每个属性发出警告。此外，如果某些主构造函数参数不是属性，则不能应用 @Parcelize。

如果您的类需要更高级的序列化逻辑，请在伴随类中编写。

@Parcelize
data class User(val firstName: String, val lastName: String, val age: Int) : Parcelable {
    private companion object : Parceler<User> {
        override fun User.write(parcel: Parcel, flags: Int) {
            // Custom write implementation
        }

        override fun create(parcel: Parcel): User {
            // Custom read implementation
        }
    }
}

支持的类型

@Parcelize 支持各种类型

原始类型（及其对应的包装类型）
对象和枚举
String、CharSequence
Duration
Exception
Size、SizeF、Bundle、IBinder、IInterface、FileDescriptor
SparseArray、SparseIntArray、SparseLongArray、SparseBooleanArray
所有 Serializable（包括 Date）和 Parcelable 实现
所有支持类型的集合：List（映射到 ArrayList）、Set（映射到 LinkedHashSet）、Map（映射到 LinkedHashMap）
- 还有一些具体的实现：ArrayList、LinkedList、SortedSet、NavigableSet、HashSet、LinkedHashSet、TreeSet、SortedMap、NavigableMap、HashMap、LinkedHashMap、TreeMap、ConcurrentHashMap
所有支持类型的数组
所有支持类型的可空版本

自定义 `Parceler`

如果您的类型不受直接支持，您可以为其编写一个 Parceler 映射对象。

class ExternalClass(val value: Int)

object ExternalClassParceler : Parceler<ExternalClass> {
    override fun create(parcel: Parcel) = ExternalClass(parcel.readInt())

    override fun ExternalClass.write(parcel: Parcel, flags: Int) {
        parcel.writeInt(value)
    }
}

您可以使用 @TypeParceler 或 @WriteWith 注释应用外部 parceler。

// Class-local parceler
@Parcelize
@TypeParceler<ExternalClass, ExternalClassParceler>()
class MyClass(val external: ExternalClass) : Parcelable

// Property-local parceler
@Parcelize
class MyClass(@TypeParceler<ExternalClass, ExternalClassParceler>() val external: ExternalClass) : Parcelable

// Type-local parceler
@Parcelize
class MyClass(val external: @WriteWith<ExternalClassParceler>() ExternalClass) : Parcelable

跳过序列化属性

如果要跳过某些属性的序列化，请使用 @IgnoredOnParcel 注释。它也可以用于类主体内的属性，以消除有关未序列化属性的警告。使用 @IgnoredOnParcel 注释的构造函数属性必须具有默认值。

@Parcelize
class MyClass(
    val include: String,
    // Don't serialize this property
    @IgnoredOnParcel val ignore: String = "default"
): Parcelable {
    // Silence a warning
    @IgnoredOnParcel
    val computed: String = include + ignore
}

使用 android.os.Parcel.writeValue 序列化属性

您可以使用 @RawValue 注释类型，以使 Parcelize 对该属性使用 Parcel.writeValue。

@Parcelize
class MyClass(val external: @RawValue ExternalClass): Parcelable

如果属性的值不受 Android 本机支持，则这可能会在运行时失败。

如果无法通过其他方式序列化属性，Parcelize 也可能要求您使用此注释。

带密封类和密封接口的 Parcelize

Parcelize 要求要序列化的类不能是抽象的。此限制不适用于密封类。当 @Parcelize 注释用于密封类时，无需为派生类重复使用它。

@Parcelize
sealed class SealedClass: Parcelable {
    class A(val a: String): SealedClass()
    class B(val b: Int): SealedClass()
}

@Parcelize
class MyClass(val a: SealedClass.A, val b: SealedClass.B, val c: SealedClass): Parcelable

反馈

如果您在 kotlin-parcelize Gradle 插件中遇到任何问题，您可以提交错误。