嗨,大家好,欢迎来到系列文章的第五篇,在这里我们将研究在Kotlin中处理Parcelable对象。前面文章我们研究了data class这里我们将data class继承Parcelable接口。
使用Parcelable最常见的场景是将一个数据模型从一个Activity传递给另外一个Activity。当传递基本数据类型没什么问题,但是要传递自定义的对象,那么我们需要做一些操作:
class ActivityA : Activity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
val intent = Intent(this, ActivityB::class.java)
val person = Person("name", 32, "[email protected]", 1234)
intent.putExtra("A_STRING", "some string")
intent.putExtra("A_NUMBER", 1234)
intent.putExtra("AN_OBJECT", person) // compilation error
startActivity(intent)
}
}
如果我们的Person类和上篇文章的Person一样保持不变的话,那么上面代码的第11行会报编译错误,因为我们不能这样传递Person模型。
我们的Person类模型不符合上面的任何一条,我们有一些选择可以做:
实现Serializable: 希望你不要再这样做,虽然简单高效,但是性能却很差,因为它基于反射。
Json String representation: 你也可以将模型转换为String后再传递。这样做也很简单,特别是当你使用了类似Gson这样的库的时候,但这仍然不是最优方案。
实现Parcelable: 这是正确答案。这是官方推荐的解决方案。和serialization一样,它也能编组/解组(marshalling/unmarshalling)Java对象,但是更加高效。
Parcelable是最好的方案但是它包含很多模板代码,因此每次更细数据模型的时候我们都要编写和更新代码。在Java中我们可以使用AutoValue来避免模板代码,但是Kotlin呢?
下面我们看下怎样将前篇文章中的Person类实现Parcelable,一行代码的Person类:
data class Person(val name: String, val age: Int, val email: String, val phone: Long)
标准方法
首先我们使用传统的标准方法。让Person类继承Parcelable接口并按照Android Studio的要求实现相关API:
data class Person(val name: String, val age: Int, val email: String, val phone: Long) : Parcelable {
constructor(parcel: Parcel) : this(
parcel.readString(),
parcel.readInt(),
parcel.readString(),
parcel.readLong())
override fun writeToParcel(parcel: Parcel, flags: Int) {
parcel.writeString(name)
parcel.writeInt(age)
parcel.writeString(email)
parcel.writeLong(phone)
}
override fun describeContents(): Int {
return 0
}
companion object CREATOR : Parcelable.Creator {
override fun createFromParcel(parcel: Parcel): Person {
return Person(parcel)
}
override fun newArray(size: Int): Array {
return arrayOfNulls(size)
}
}
}
可以看到上面的代码包含很多模板代码(boilerplate code),这不是我们希望看到的。我们可以通过使用Android Studio来生成模板代码来避免编写它,但是我们仍然需要维护它。只是继承了Parcelable,我们的Person类就从1行代码变成了28行代码。如果在实际项目中这样做,不知道会有什么后果。如果我们给Person新加个address的属性,那么我们至少要更改构造器和writeToParcel这两个方法。有没有感觉很累?累就对了。
利用Parcelize
Parcelize来拯救你了。JetBrains在Kotlin 1.1.4 release版本中引入了它,那有怎么样?官方的说法是:
An automatic Parcelable implementation generator. Declare the serialized properties in a primary constructor and add a
@Parcelize
annotation, andwriteToParcel()
/createFromParcel()
methods will be created automatically
目前为止,它和Kotlin Coroutine一样也是实验性的特性,若要使用的话需要在app模块的build.gradle文件中添加下面代码:
androidExtensions {
experimental = true
}
然后我们的Person代码如下:
@Parcelize
data class PersonParcelize(val name: String,
val age: Int,
val email: String,
val phone: Long) : Parcelable
惊讶吗?没有任何Parcelable的模板代码了。所有Parcelable的实现都会通过注解处理器处理而我们不需要关心它们,也不需要编写它们,更改数据模型的时候也不需要更改太多代码。
去掉了28行代码,得到一个简洁且易于阅读的模型。换行符只是为了让代码看起来更好,你可以忽略换行符,你可以很容易地将它分为两行代码,一个用于注释,另一个用于类定义。
Kotlin再一次做了一件了不起的工作,帮助我们摆脱了不必要的样板代码。我越来越喜欢这门语言了,你有同感吗?:)
尽管如此,关于Parcelize还有一个小问题。目前,Android Studio出现了一个问题,它显示了一个不完整的Parcelable接口实现的错误:这是IDE本身的一个已知的bug,你可以忽略它而可以正常运行。你可以跟踪这个问题。目前它处于“开发”状态。
注意: 在本文评论的第一条中,AndroidDeveloperLB提到了两个问题。第一个问题只存在1.1.4版本中,第二个问题还存在1.1.5版本。请使用最新的kotlin版本来避免这样的问题。第一个问题出现的情况比较少,当你在Parcelable中使用Serializable对象的时候会触发第一个问题,但是我不清楚我为什么要这样做。
第二个问题似乎更加严重和常见,因为apk无法安装到Andorid 4.4以下的设备。
好了,所有的parcels已经讲完 :)。如果你喜欢本文给一些 或者分享你的想法和评论。代码在这里:Series Github project,在parcelize包下。See you at number 6
翻译自Parcelable in Kotlin? Here comes Parcelize。翻译不好或者错误的地方请留言。