Generatore di implementazioni parcelle

Il plug-in kotlin-parcelize fornisce un generatore di implementazioni di Parcelable.

Per includere il supporto per Parcelable, aggiungi il plug-in Gradle al file build.gradle della tua app:

Trendy

plugins {
    id 'kotlin-parcelize'
}

Kotlin

plugins {
    id("kotlin-parcelize")
}

Quando annoti una classe con @Parcelize, viene generata automaticamente un'implementazione Parcelable, come mostrato nell'esempio seguente:

import kotlinx.parcelize.Parcelize

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

@Parcelize richiede che tutte le proprietà serializzate siano dichiarate nel costruttore principale. Il plug-in invia un avviso per ogni proprietà con un campo di supporto dichiarato nel corpo della classe. Inoltre, non puoi applicare @Parcelize se alcuni dei parametri principali del costruttore non sono proprietà.

Se la tua classe richiede una logica di serializzazione più avanzata, scrivila all'interno di una classe companion:

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

Tipi supportati

@Parcelize supporta un'ampia gamma di tipi:

• Tipi primitivi (e relative versioni in scatola)
• Oggetti ed enumerazioni
• String, CharSequence
• Exception
• Size, SizeF, Bundle, IBinder, IInterface e FileDescriptor
• SparseArray, SparseIntArray, SparseLongArray, SparseBooleanArray
• Tutte le implementazioni Serializable (inclusa Date) e Parcelable
• Raccolte di tutti i tipi supportati: List (mappata a ArrayList), Set (mappata a LinkedHashSet), Map (mappata a LinkedHashMap)
  • Inoltre, alcune implementazioni concrete: ArrayList, LinkedList, SortedSet, NavigableSet, HashSet, LinkedHashSet, TreeSet, SortedMap, NavigableMap, HashMap, LinkedHashMap, TreeMap, ConcurrentHashMap
• Array di tutti i tipi supportati
• Versioni con valori null di tutti i tipi supportati

Parceler personalizzati

Se il tipo non è supportato direttamente, puoi scrivere un oggetto di mappatura 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)
    }
}

Puoi applicare appaltatori esterni utilizzando le annotazioni @TypeParceler o @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

Feedback

In caso di problemi con il plug-in Gradle kotlin-parcelize, puoi segnalare un bug.