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
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
意見回饋
如果您在使用 kotlin-parcelize
Gradle 外掛程式時遇到任何問題,可以回報錯誤。