Плагин kotlin-parcelize
предоставляет генератор реализации Parcelable
.
Чтобы включить поддержку Parcelable
, добавьте плагин Gradle в файл build.gradle
вашего приложения:
классный
plugins { id 'kotlin-parcelize' }
Котлин
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
:
// 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
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, вы можете сообщить об ошибке .