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

从 Parcel 创建数据

在 Java 代码中，您可以直接访问 CREATOR 字段。

class UserCreator {
    static User fromParcel(Parcel parcel) {
        return User.CREATOR.createFromParcel(parcel);
    }
}

在 Kotlin 中，您不能直接使用 CREATOR 字段。而是使用 kotlinx.parcelize.parcelableCreator。

import kotlinx.parcelize.parcelableCreator

fun userFromParcel(parcel: Parcel): User {
    return parcelableCreator<User>().createFromParcel(parcel)
}

跳过序列化属性

如果要跳过某些属性的序列化，请使用 @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

在 Kotlin 2.0 之前，您可以通过使用expect 和actual 为 Parcelize 注解创建别名来使用 Parcelize。

// Common code
package example

@Target(AnnotationTarget.CLASS)
@Retention(AnnotationRetention.BINARY)
expect annotation class MyParcelize()

expect interface MyParcelable

@Target(AnnotationTarget.PROPERTY)
@Retention(AnnotationRetention.SOURCE)
expect annotation class MyIgnoredOnParcel()

@MyParcelize
class MyClass(
    val x: String,
    @MyIgnoredOnParcel val y: String = ""
): MyParcelable

// Platform code
package example

actual typealias MyParcelize = kotlinx.parcelize.Parcelize
actual typealias MyParcelable = android.os.Parcelable
actual typealias MyIgnoredOnParcel = kotlinx.parcelize.IgnoredOnParcel

在 Kotlin 2.0 及更高版本中，不支持为触发插件的注解创建别名。为了解决此问题，请改为将新的Parcelize 注解作为additionalAnnotation 参数提供给插件。

// Gradle build configuration
kotlin {
    androidTarget {
        compilerOptions {
            // ...
            freeCompilerArgs.addAll("-P", "plugin:org.jetbrains.kotlin.parcelize:additionalAnnotation=example.MyParcelize")
        }
    }
}

// Common code
package example

@Target(AnnotationTarget.CLASS)
@Retention(AnnotationRetention.BINARY)
// No `expect` keyword here
annotation class MyParcelize()

expect interface MyParcelable

@Target(AnnotationTarget.PROPERTY)
@Retention(AnnotationRetention.SOURCE)
expect annotation class MyIgnoredOnParcel()

@MyParcelize
class MyClass(
    val x: String,
    @MyIgnoredOnParcel val y: String = ""
): MyParcelable

// Platform code
package example

// No typealias for MyParcelize here
actual typealias MyParcelable = android.os.Parcelable
actual typealias MyIgnoredOnParcel = kotlinx.parcelize.IgnoredOnParcel

由于Parcel 接口仅在 Android 上可用，因此 Parcelize 不会在其他平台上生成任何代码，因此任何actual 实现都可以为空。也不可能在通用代码中使用任何需要引用Parcel 类的注解，例如@WriteWith。

实验性功能

数据类序列化器

自 Kotlin 2.1.0 起可用。

DataClass 注解允许序列化数据类，就像它们本身使用Parcelize 注解一样。此注解需要kotlinx.parcelize.Experimental 启用。

@file:OptIn(kotlinx.parcelize.Experimental::class)

data class C(val a: Int, val b: String)

@Parcelize
class P(val c: @DataClass C) : Parcelable

主构造函数及其所有属性必须能够从Parcelable 类访问。此外，数据类所有主构造函数属性都必须受Parcelize 支持。自定义 Parcelers（如果选择）应在Parcelable 类上指定，而不是在数据类上。如果数据类同时实现了Serializable，则@DataClass 注解优先：android.os.Parcel.writeSerializable 不会被使用。

这方面的一个实用案例是序列化kotlin.Pair。另一个有用的示例是简化多平台代码：通用代码可以将数据层声明为数据类，然后 Android 代码可以为其添加序列化逻辑，从而无需在通用代码中使用 Android 特定的注解和类型别名。

// Common code:
data class MyData(val x: String, val y: MoreData)
data class MoreData(val a: String, val b: Int)

// Platform code:
@OptIn(kotlinx.parcelize.Experimental::class)
@Parcelize
class DataWrapper(val wrapped: @DataClass MyData): Parcelable

主构造函数中的非 val 或 var 参数

自 Kotlin 2.1.0 起可用。

要启用此功能，请将experimentalCodeGeneration=true 添加到 parcelize 插件参数中。

kotlin {
    compilerOptions {
        // ...
        freeCompilerArgs.addAll("-P", "plugin:org.jetbrains.kotlin.parcelize:experimentalCodeGeneration=true")
    }
}

此功能取消了主构造函数参数必须为val 或var 的限制。这解决了使用继承时的 Parcelize 的一个痛点，该痛点之前需要使用open 属性。

// base parcelize
@Parcelize
open class Base(open val s: String): Parcelable

@Parcelize
class Derived(
    val x: Int,
    // all arguments have to be `val` or `var` so we need to override
    // to not introduce new property name
    override val s: String
): Base(s)

// experimental code generation enabled
@Parcelize
open class Base(val s: String): Parcelable

@Parcelize
class Derived(val x: Int, s: String): Base(s)

此类参数仅允许用于基类构造函数的参数中。不允许在类的正文中引用它们。

@Parcelize
class Derived(s: String): Base(s) { // allowed
    @IgnoredOnParcel
    val x: String = s // ERROR: not allowed.
    init {
        println(s) // ERROR: not allowed
    }
}

反馈

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