Generator für Parcelable-Implementierungen

Das kotlin-parcelize-Plug-in bietet einen Implementierungsgenerator für Parcelable.

Damit Parcelable unterstützt wird, fügen Sie das Gradle-Plug-in in die Datei build.gradle Ihrer App ein:

plugins {
    id 'kotlin-parcelize'
}

plugins {
    id("kotlin-parcelize")
}

Wenn Sie eine Klasse mit @Parcelize annotieren, wird automatisch eine Parcelable-Implementierung 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 seriellen Attribute im primären Konstruktor deklariert werden. Das Plug-in gibt für jedes Attribut eine Warnung aus, wobei ein Sicherungsfeld im Klassentext deklariert wird. Außerdem können Sie @Parcelize nicht anwenden, wenn einige der Parameter des primären Konstruktors keine Attribute sind.

Wenn Ihre Klasse eine erweiterte Serialisierungslogik erfordert, schreiben Sie sie in einer Begleitklasse:

@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 eine Vielzahl von Typen:

• Primitive Typen (und die dazugehörigen Versionen)
• Objekte und Enums
• String, CharSequence
• Exception
• Size, SizeF, Bundle, IBinder, IInterface, FileDescriptor
• SparseArray, SparseIntArray, SparseLongArray, SparseBooleanArray
• Alle Implementierungen von Serializable (einschließlich Date) und Parcelable
• Sammlungen aller unterstützten Typen: List (ArrayList zugeordnet), Set (zu LinkedHashSet zugeordnet), Map (LinkedHashMap zugeordnet)
  • Außerdem gibt es eine Reihe konkreter 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 ein Parceler-Zuordnungsobjekt dafür schreiben.

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 Parzellen mit den Annotationen @TypeParceler oder @WriteWith anwenden:

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

Wenn Probleme mit dem Gradle-Plug-in kotlin-parcelize auftreten, können Sie den Fehler melden.