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 支持多种类型：

• 基元类型（及其 boxed 版本）
• 对象和枚举
• 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
• 所有受支持类型的数组
• 所有受支持类型的可为 null 版本

自定义 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 插件时遇到任何问题，可以提交 bug。