O plug-in kotlin-parcelize
(link em inglês) fornece um gerador de implementação de
Parcelable
.
Para incluir suporte à interface Parcelable
, adicione o plug-in do Gradle ao
arquivo build.gradle
do app:
Groovy
plugins { id 'kotlin-parcelize' }
Kotlin
plugins { id("kotlin-parcelize") }
Quando você insere uma anotação com @Parcelize
, uma implementação de Parcelable
é gerada automaticamente, como mostrado no exemplo a seguir.
import kotlinx.parcelize.Parcelize
@Parcelize
class User(val firstName: String, val lastName: String, val age: Int): Parcelable
@Parcelize
requer que todas as propriedades serializadas sejam declaradas no
construtor principal. O plug-in emite um aviso em cada propriedade
com um campo de backup declarado no corpo da classe. Além disso, não
será possível aplicar @Parcelize
se alguns dos parâmetros do construtor principal não
forem propriedades.
Caso sua classe exija uma lógica de serialização mais avançada, escreva-a dentro de uma classe de acompanhamento:
@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
}
}
}
Tipos com suporte
@Parcelize
aceita uma grande variedade de tipos:
- Tipos primitivos (e suas versões em caixa)
- Objetos e enumerações
String
,CharSequence
Exception
Size
,SizeF
,Bundle
,IBinder
,IInterface
,FileDescriptor
SparseArray
,SparseIntArray
,SparseLongArray
,SparseBooleanArray
- Todas as implementações de
Serializable
(incluindoDate
) eParcelable
- Coleções de todos os tipos com suporte:
List
(mapeado paraArrayList
),Set
(mapeado paraLinkedHashSet
),Map
(mapeado paraLinkedHashMap
)- Além disso, algumas implementações concretas:
ArrayList
,LinkedList
,SortedSet
,NavigableSet
,HashSet
,LinkedHashSet
,TreeSet
,SortedMap
,NavigableMap
,HashMap
,LinkedHashMap
,TreeMap
,ConcurrentHashMap
- Além disso, algumas implementações concretas:
- Matrizes de todos os tipos com suporte
- Versões anuláveis de todos os tipos com suporte
Parceler
s personalizados
Se o tipo não tiver suporte direto, crie um objeto de mapeamento Parceler
para ele.
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)
}
}
É possível aplicar parcelers externos usando anotações
@TypeParceler
ou @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
Se você encontrar problemas com o plug-in do Gradle kotlin-parcelize
,
registre um bug.