Generator implementacji rozwiązania Parcelable

Wtyczka kotlin-parcelize udostępnia generator implementacji Parcelable.

Aby uwzględnić obsługę Parcelable, dodaj wtyczkę Gradle do pliku build.gradle aplikacji:

Odlotowy

plugins {
    id 'kotlin-parcelize'
}

Kotlin

plugins {
    id("kotlin-parcelize")
}

Gdy dodasz adnotacje do klasy za pomocą @Parcelize, automatycznie generowana jest implementacja Parcelable, jak w tym przykładzie:

import kotlinx.parcelize.Parcelize

@Parcelize
class User(val firstName: String, val lastName: String, val age: Int): Parcelable

@Parcelize wymaga zadeklarowania wszystkich zserializowanych właściwości w głównym konstruktorze. Wtyczka wysyła ostrzeżenie w każdej właściwości z polem zapasowym zadeklarowanym w treści klasy. Nie możesz też stosować właściwości @Parcelize, jeśli niektóre główne parametry konstruktora nie są właściwościami.

Jeśli klasa wymaga bardziej zaawansowanej logiki serializacji, zapisz ją w klasie towarzyszącej:

@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
        }
    }
}

Obsługiwane typy

@Parcelize obsługuje szeroki zakres typów:

  • Typy podstawowe (i ich wersje w pudełkach)
  • Obiekty i wyliczenia
  • String, CharSequence
  • Exception
  • Size, SizeF, Bundle, IBinder, IInterface, FileDescriptor
  • SparseArray, SparseIntArray, SparseLongArray, SparseBooleanArray
  • Wszystkie implementacje typu Serializable (w tym Date) i Parcelable
  • Kolekcje wszystkich obsługiwanych typów: List (zmapowane na ArrayList), Set (zmapowane na LinkedHashSet), Map (zmapowane na LinkedHashMap)
    • a także kilka konkretnych implementacji: ArrayList, LinkedList, SortedSet, NavigableSet, HashSet, LinkedHashSet, TreeSet, SortedMap, NavigableMap, HashMap, LinkedHashMap, TreeMap, ConcurrentHashMap
  • Tablice wszystkich obsługiwanych typów
  • Wszystkie obsługiwane wersje z możliwością wartości null

Niestandardowe Parceler

Jeśli Twój typ nie jest obsługiwany bezpośrednio, możesz napisać dla niego obiekt mapowania 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)
    }
}

Zewnętrzne działki możesz stosować za pomocą adnotacji @TypeParceler lub @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

Opinia

Jeśli napotkasz problemy z wtyczką kotlin-parcelize do Gradle, możesz zgłosić błąd.