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)
}
跳过属性的序列化
如果您想跳过某些属性不进行 parcelize,请使用 @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
注解用于密封类时,无需对其派生类重复此注解。
@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 之前,您可以通过将 Parcelize 注解与 expect
和 actual
别名来使用 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
支持。自定义 Parceler(如果选择)应在 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 插件时遇到任何问题,可以提交 bug。