Google は、黒人コミュニティに対する人種平等の促進に取り組んでいます。取り組みを見る

Parcelable 実装生成ツール

kotlin-parcelize プラグインには、Parcelable 実装生成ツールが用意されています。

クラスに @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 は、さまざまな型をサポートします。

  • プリミティブ型(およびそのボックス化バージョン)
  • オブジェクトと列挙型
  • StringCharSequence
  • Exception
  • SizeSizeFBundleIBinderIInterfaceFileDescriptor
  • SparseArraySparseIntArraySparseLongArraySparseBooleanArray
  • すべての SerializableDate を含む)と Parcelable の実装
  • サポートされているすべての型のコレクション: ListArrayList にマッピング)、SetLinkedHashSet にマッピング)、MapLinkedHashMap にマッピング)
    • 具体的な実装: ArrayListLinkedListSortedSetNavigableSetHashSetLinkedHashSetTreeSetSortedMapNavigableMapHashMapLinkedHashMapTreeMapConcurrentHashMap
  • サポートされているすべての型の配列
  • サポートされているすべての型の 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)

// Property-local parceler
@Parcelize
class MyClass(@TypeParceler<ExternalClass, ExternalClassParceler>() val external: ExternalClass)

// Type-local parceler
@Parcelize
class MyClass(val external: @WriteWith<ExternalClassParceler>() ExternalClass)

フィードバック

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