Le plug-in kotlin-parcelize
fournit un générateur d'implémentation Parcelable
.
Pour inclure la compatibilité avec Parcelable
, ajoutez le plug-in Gradle au fichier build.gradle
de votre application :
Groovy
plugins { id 'kotlin-parcelize' }
Kotlin
plugins { id("kotlin-parcelize") }
Lorsque vous annotez une classe avec @Parcelize
, une implémentation Parcelable
est automatiquement générée, comme illustré dans l'exemple suivant :
import kotlinx.parcelize.Parcelize
@Parcelize
class User(val firstName: String, val lastName: String, val age: Int): Parcelable
@Parcelize
nécessite que toutes les propriétés sérialisées soient déclarées dans le constructeur principal. Le plug-in émet un avertissement sur chaque propriété avec un champ de support déclaré dans le corps de la classe. De plus, vous ne pouvez pas appliquer @Parcelize
si certains paramètres du constructeur principal ne sont pas des propriétés.
Si votre classe nécessite une logique de sérialisation plus avancée, écrivez-la dans une classe compagnon :
@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
}
}
}
Types acceptés
@Parcelize
accepte un large éventail de types :
- Types primitifs (et leurs versions encapsulées)
- Objets et énumérations
String
,CharSequence
Exception
Size
,SizeF
,Bundle
,IBinder
,IInterface
,FileDescriptor
SparseArray
,SparseIntArray
,SparseLongArray
,SparseBooleanArray
- Toutes les implémentations
Serializable
(y comprisDate
) etParcelable
- Les collections de tous les types compatibles :
List
(mappé surArrayList
),Set
(mappé surLinkedHashSet
),Map
(mappé surLinkedHashMap
)- Plusieurs implémentations concrètes sont également possibles :
ArrayList
,LinkedList
,SortedSet
,NavigableSet
,HashSet
,LinkedHashSet
,TreeSet
,SortedMap
,NavigableMap
,HashMap
,LinkedHashMap
,TreeMap
,ConcurrentHashMap
- Plusieurs implémentations concrètes sont également possibles :
- Tableaux de tous les types compatibles
- Versions nullable de tous les types compatibles
Parceler
personnalisés
Si votre type n'est pas directement pris en charge, vous pouvez écrire un objet de mappage 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)
}
}
Vous pouvez appliquer des Parceler externes à l'aide d'annotations @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
Commentaires
Si vous rencontrez des problèmes avec le plug-in Gradle kotlin-parcelize
, vous veuillez signaler un bug.