转自:http://ranseti.top/article/extensions
本教程介绍如何使用Kotlin Android扩展来改进对Android开发的支持。
在本教程中,我们将介绍使用Kotlin Android Extensions插件所需的步骤,从而增强Android的开发体验。
View绑定
背景
每个Android开发人员都知道findViewById()函数。 毫无疑问,这是一个难以阅读和支持的潜在错误和恶劣代码的来源。 虽然有几个库可用于解决这个问题,但是这些库需要为每个暴露的View注释字段。
Kotlin Android Extensions插件使我们能够获得与其中一些库相同的体验,而不必添加任何额外的代码。
实质上,这允许以下代码:
// Using R.layout.activity_main from the 'main' source set
import kotlinx.android.synthetic.main.activity_main.*
class MyActivity : Activity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main)
// Instead of findViewById<TextView>(R.id.textView)
textView.setText("Hello, world!")
}
}
使用Kotlin Android扩展
- 配置依赖关系
在本教程中,我们将使用Gradle,但使用IntelliJ IDEA项目结构或Maven也可以完成相同的任务。 有关设置Gradle以使用Kotlin的详细信息,请参阅使用Gradle。
Android扩展是IntelliJ IDEA和Android Studio的Kotlin插件的一部分。 你不需要安装额外的插件。
您只需在模块的build.gradle文件中启用Android扩展Gradle插件即可:
apply plugin: 'kotlin-android-extensions'
- 导入合成属性
一次性导入特定布局的所有小部件属性非常方便:
import kotlinx.android.synthetic.main.<layout>.*
因此,如果布局文件名是activity_main.xml,我们会导入kotlinx.android.synthetic.main.activity_main。*。
如果我们想调用View的综合属性,我们也应该导入kotlinx.android.synthetic.main.activity_main.view。*。
一旦我们这样做,我们就可以调用相应的扩展,它们是以XML文件中的视图命名的属性。 例如,对于这个view:
<TextView
android:id="@+id/hello"
android:layout_width="fill_parent"
android:layout_height="wrap_content"/>
将会有一个名为hello的属性:
activity.hello.text = "Hello World!"
- 实验模式(Experimental Mode)
Android扩展插件包含几个实验性功能,如LayoutContainer支持和Parcelable实现生成器。 这些功能尚未被视为生产准备,所以您需要打开build.gradle中的实验模式才能使用它们:
androidExtensions {
experimental = true
}
- LayoutContainer支持
Android扩展插件支持不同类型的容器。 最基本的是Activity,Fragment和View,但是通过实现LayoutContainer接口,你可以把(虚拟的)任何类转换成一个Android Extensions容器,例如:
import kotlinx.android.extensions.LayoutContainer
class ViewHolder(override val containerView: View) : ViewHolder(containerView), LayoutContainer {
fun setup(title: String) {
itemTitle.text = "Hello World!"
}
}
请注意,您需要打开实验标志才能使用LayoutContainer。
- Flavor支持
Android扩展插件支持Android风格。 假设你在build.gradle文件中有一个free的名字:
android {
productFlavors {
free {
versionName "1.0-free"
}
}
}
因此,您可以通过添加以下导入来导入free / res / layout / activity_free.xml布局的所有合成属性:
import kotlinx.android.synthetic.free.activity_free.*
在实验模式中,您可以指定任何变体名称(不仅味道),例如 freeDebug或freeRelease也可以工作。
- View 缓存(View Caching)
调用findViewById()可能会很慢,特别是在视图层次很大的情况下,所以Android扩展尝试通过在容器中缓存视图来最小化findViewById()调用。
默认情况下,Android扩展为在Kotlin中编写的每个容器(Activity,Fragment,View或LayoutContainer实现)添加一个隐藏缓存函数和一个存储字段。 该方法是相当小,所以它不会增加APK的大小。
在以下示例中,findViewById()仅调用一次:
class MyActivity : Activity()
fun MyActivity.a() {
textView.text = "Hidden view"
textView.visibility = View.INVISIBLE
}
但在以下情况下:
fun Activity.b() {
textView.text = "Hidden view"
textView.visibility = View.INVISIBLE
}
我们不知道这个函数是否只会被我们的来源的活动或简单的Java活动调用。 因此,即使前面的示例中的MyActivity实例作为接收者传递,我们也不使用缓存。
- 更改视图缓存策略
您可以更改全局或每个容器的缓存策略。 这也需要开启实验模式。
项目全局缓存策略在build.gradle文件中设置:
androidExtensions {
defaultCacheImplementation = "HASH_MAP" // also SPARSE_ARRAY, NONE
}
默认情况下,Android扩展插件使用HashMap作为后备存储,但是您可以切换到SparseArray实现,或者关闭缓存。 当您仅使用Android扩展的Parcelable部分时,后者特别有用。
另外,你可以使用@ContainerOptions注解一个容器来改变它的缓存策略:
import kotlinx.android.extensions.ContainerOptions
@ContainerOptions(cache = CacheImplementation.NO_CACHE)
class MyActivity : Activity()
fun MyActivity.a() {
// findViewById() will be called twice
textView.text = "Hidden view"
textView.visibility = View.INVISIBLE
}
Parcelable
从Kotlin 1.1.4开始,Android扩展插件提供了Parcelable实现生成器作为实验性功能。
- 启用Parcelable支持
如上所述应用kotlin-android-extensions Gradle插件并打开实验标志。
- 如何使用
使用@Parcelize对类进行注释,并自动生成一个Parcelable实现。
import kotlinx.android.parcel.Parcelize
@Parcelize
class User(val firstName: String, val lastName: String, val age: Int): Parcelable
@Parcelize需要在主构造函数中声明所有序列化的属性。 Android扩展将在每个属性上发出警告,并在类体中声明一个后台字段。 此外,如果某些主构造函数参数不是属性,则不能应用@Parcelize。
如果你的类需要更高级的序列化逻辑,你可以把它写在一个伴随类中:
@Parcelize
data class Value(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支持多种类型:
原始类型(及其盒装版本);
对象和枚举;
字符串,CharSequence;
例外;
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;
所有支持类型的数组;
所有受支持类型的可空版本。
- 自定义Parcelers
即使你的类型不被直接支持,你也可以为它编写一个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注释应用外部parcelers :
// Class-local parceler
@Parcelable
@TypeParceler<ExternalClass, ExternalClassParceler>()
class MyClass(val external: ExternalClass)
// Property-local parceler
@Parcelable
class MyClass(@TypeParceler<ExternalClass, ExternalClassParceler>() val external: ExternalClass)
// Type-local parceler
@Parcelable
class MyClass(val external: @WriteWith<ExternalClassParceler>() ExternalClass)