Generator für Parcelable-Implementierungen

Das kotlin-parcelize-Plug-in bietet eine Implementierungsgenerator von Parcelable.

Um Parcelable zu unterstützen, füge das Gradle-Plug-in zu deinem Datei build.gradle der App:

Cool

plugins {
    id 'kotlin-parcelize'
}

Kotlin

plugins {
    id("kotlin-parcelize")
}

Wenn Sie eine Klasse mit @Parcelize annotieren, wird eine Parcelable-Implementierung automatisch generiert, wie im folgenden Beispiel gezeigt:

import kotlinx.parcelize.Parcelize

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

Für @Parcelize müssen alle serialisierten Attribute im Primären Konstruktor. Das Plug-in gibt für jede Property eine Warnung aus. mit einem im Klassentext deklarierten Sicherungsfeld. Außerdem können Sie @Parcelize anwenden, wenn einige der primären Konstruktorparameter und nicht auf Properties.

Wenn Ihre Klasse eine erweiterte Serialisierungslogik benötigt, schreiben Sie sie in eine Companion-Klasse:

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

Unterstützte Typen

@Parcelize unterstützt viele verschiedene Typen:

  • Primitive Typen (und ihre Box-Versionen)
  • Objekte und Enums
  • String, CharSequence
  • Exception
  • Size, SizeF, Bundle, IBinder, IInterface, FileDescriptor
  • SparseArray, SparseIntArray, SparseLongArray, SparseBooleanArray
  • Alle Serializable- (einschließlich Date) und Parcelable-Implementierungen
  • Sammlungen aller unterstützten Typen: List (zugeordnet zu ArrayList), Set (zugeordnet zu LinkedHashSet), Map (zugeordnet zu LinkedHashMap)
    • Einige konkrete Implementierungen: ArrayList, LinkedList, SortedSet, NavigableSet, HashSet, LinkedHashSet, TreeSet, SortedMap, NavigableMap, HashMap, LinkedHashMap, TreeMap ConcurrentHashMap
  • Arrays aller unterstützten Typen
  • Versionen aller unterstützten Typen, für die Nullwerte zulässig sind

Benutzerdefinierte Parcelers

Wenn Ihr Typ nicht direkt unterstützt wird, können Sie einen Parceler schreiben. Zuordnungsobjekt.

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

Sie können externe Pakete mit @TypeParceler oder @WriteWith anwenden Anmerkungen:

// 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

Feedback

Falls Probleme mit dem Gradle-Plug-in kotlin-parcelize auftreten, kannst du Folgendes tun: Fehler melden