Generator implementacji rozwiązania Parcelable

Wtyczka kotlin-parcelize udostępnia generator implementacji Parcelable.

Aby uwzględnić obsługę języka Parcelable, dodaj wtyczkę Gradle do swojej witryny plik build.gradle aplikacji:

plugins {
    id 'kotlin-parcelize'
}

plugins {
    id("kotlin-parcelize")
}

Dodawanie adnotacji do zajęć za pomocą funkcji @Parcelize, implementacja Parcelable jest generowany automatycznie, jak widać w tym przykładzie:

import kotlinx.parcelize.Parcelize

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

@Parcelize wymaga, aby wszystkie zserializowane właściwości były zadeklarowane w głównym konstruktorze. Wtyczka wyświetla ostrzeżenie w każdej usłudze z polem backendu zadeklarowanym w treści klasy. Nie można też zastosuj @Parcelize, jeśli niektóre główne parametry konstruktora są a nie właściwości.

Jeśli klasa wymaga bardziej zaawansowanej logiki serializacji, wpisz 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 wiele typów:

• typy proste (i ich wersje w pudełku);
• Obiekty i wyliczenia
• String, CharSequence
• Duration
• Exception
• Size, SizeF, Bundle, IBinder, IInterface, FileDescriptor
• SparseArray, SparseIntArray, SparseLongArray, SparseBooleanArray
• Wszystkie implementacje Serializable (w tym Date) i Parcelable
• Kolekcje wszystkich obsługiwanych typów: List (zmapowane na ArrayList), Set (zmapowano na LinkedHashSet), Map (zmapowano 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 typy, w przypadku których dopuszczalna jest wartość null

Niestandardowe Parceler

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

Możesz zastosować dostawców zewnętrznych za pomocą: @TypeParceler lub @WriteWith adnotacje:

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

Pomiń właściwości z serializacji

Jeśli chcesz pominąć wyodrębnianie niektórych usług, użyj @IgnoredOnParcel adnotacja. Można go też używać w usługach w obrębie treść klasy wyciszając ostrzeżenia o tym, że właściwość nie jest serializowana. Właściwości konstruktora opisane przy użyciu atrybutu @IgnoredOnParcel muszą mieć wartość domyślną .

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

Użyj android.os.Parcel.writeValue do serializacji właściwości

Aby użyć Parcelize, możesz dodać adnotacje do typu za pomocą atrybutu @RawValue Parcel.writeValue dla tej usługi.

@Parcelize
class MyClass(val external: @RawValue ExternalClass): Parcelable

Może to się nie udać w czasie działania, jeśli wartość właściwości nie jest natywnie obsługiwane przez Androida.

Parcelize może też wymagać użycia tej adnotacji, jeśli nie ma innego sposobu na serializację właściwości.

Zadbaj o komponent z zastosowanymi klasami i zamkniętymi interfejsami

Parcelize wymaga klasy do parcelizacji, aby nie była abstrakcyjna. To ograniczenie a nie w przypadku zajęć ograniczonych. Gdy adnotacja @Parcelize jest używana w przypadku zamkniętej klasy, nie trzeba jej powtarzać w przypadku klas pochodnych.

@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

Opinia

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