Генератор программных реализаций

Плагин 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

Создать данные из посылки

В коде Java вы можете напрямую получить доступ к полю CREATOR .

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

В Котлине вы не можете использовать поле 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
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

Настройка Parcelize для мультиплатформы Kotlin

До Kotlin 2.0 вы могли использовать Parcelize, используя псевдонимы аннотаций Parcelize с expect и actual : 

// 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 . Это решает одну проблему использования парцелизации с наследованием, которая ранее требовала использования 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, вы можете сообщить об ошибке .