Parcelable 実装生成ツール

kotlin-parcelize プラグイン には、 Parcelable 実装生成ツール。

Parcelable のサポートを組み込むには、アプリの build.gradle ファイルに次の Gradle プラグインを追加します。

Groovy

plugins {
    id 'kotlin-parcelize'
}

Kotlin

plugins {
    id("kotlin-parcelize")
}

クラスに @Parcelize アノテーションを付けると、Parcelable の実装が自動的に生成されます。次に例を示します。

import kotlinx.parcelize.Parcelize

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

@Parcelize では、シリアル化されたすべてのプロパティを基本コンストラクタで宣言する必要があります。プラグインは、バッキング フィールドがクラス本文で宣言されているプロパティごとに、警告を発行します。また、一部の基本コンストラクタ パラメータがプロパティでない場合は、@Parcelize を適用できません。

クラスがより高度なシリアル化ロジックを必要とする場合は、コンパニオン クラス内に記述します。

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

サポートされている型

@Parcelize は、さまざまな型をサポートします。

  • プリミティブ型（およびそのボックス化バージョン）
  • オブジェクトと列挙型
  • String、CharSequence
  • Duration
  • Exception
  • Size、SizeF、Bundle、IBinder、IInterface、FileDescriptor
  • SparseArray、SparseIntArray、SparseLongArray、SparseBooleanArray
  • すべての Serializable（Date を含む）と Parcelable の実装
  • サポートされているすべての型のコレクション: List（ArrayList にマッピング）、Set（LinkedHashSet にマッピング）、Map（LinkedHashMap にマッピング）
    • 具体的な実装: ArrayList、LinkedList、SortedSet、NavigableSet、HashSet、LinkedHashSet、TreeSet、SortedMap、NavigableMap、HashMap、LinkedHashMap、TreeMap、ConcurrentHashMap
  • サポートされているすべての型の配列
  • サポートされているすべての型の null 許容バージョン

Parceler のカスタマイズ

型が直接サポートされていない場合、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)
    }
}

@TypeParceler または @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

シリアル化からプロパティのスキップ

一部の宿泊施設のパーセル化をスキップする場合は、 @IgnoredOnParcel アノテーション。また、 クラスの本体を使用して、プロパティがシリアル化されていないことに関する警告を非表示にします。 @IgnoredOnParcel アノテーション付きのコンストラクタ プロパティにはデフォルトが必要です あります。

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

android.os.Parcel.writeValue を使用してプロパティのシリアル化

型に @RawValue アノテーションを付けると、Parcelize を使用できます。 そのプロパティの Parcel.writeValue。

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

プロパティの値が Android でネイティブにサポートされています。

Parcelize では、他に何もない場合にも、このアノテーションを使用することが求められます。 使用してプロパティをシリアル化します。

シールクラスとシール インターフェースを使用して Parcelize する

Parcelize では、Parcelize が抽象でないクラスである必要があります。この制限により、 保持されません。@Parcelize アノテーションが シールクラスであるため、派生クラスに対して繰り返す必要はありません。

@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

フィードバック

kotlin-parcelize Gradle プラグインで問題が発生した場合は、バグを報告してください。