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를 사용하려면 모든 직렬화된 속성을 기본 생성자에서 선언해야 합니다. 플러그인은 클래스 본문에서 선언된 backing 필드가 있는 각 속성에 경고를 표시합니다. 또한 기본 생성자 매개변수의 일부가 속성이 아니면 @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
        }
    }
}

#supportedtypes

@Parcelize는 다음과 같이 다양한 유형을 지원합니다.

  • 기본 유형 및 기본 유형의 박스 버전
  • 객체 및 enum
  • CharSequence String
  • 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 주석을 사용하여 외부 parceler를 적용할 수 있습니다.

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

직렬화에서 속성 건너뛰기

일부 속성이 parceling되지 않도록 건너뛰려면 @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
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 플러그인에서 문제가 발생하면 버그를 신고해 주세요.