Kotlin Android Extensions的使用

工作中用到了,翻译一下,原文地址:http://kotlinlang.org/docs/tutorials/android-plugin.html

作者:Yan Zhulanow

本教程介绍了Kotlin Android Extensions的使用,用以提高对Android开发的支持。

在本教程中,我们将介绍Kotlin Android Extensions插件使用所需的步骤,从而提高Android的开发体验。

View Binding

背景介绍

每一个Android程序猿都非常了解findViewById() 方法。毫无疑问,他会导致一些潜在的错误(如,强转异常)而且难以阅读和维护,非常令人讨厌。尽管有一些库可以解决这个问题,但是这些库都需要为每一个view 添加注解。

Kotlin Android Extensions插件使我们能够获得与其中一些库相同的体验,但是无需添加任何额外的代码。

例如下面的代码

<pre>

// Using R.layout.activity_main from the 'main' source setimportkotlinx.android.synthetic.main.activity_main.*

classMyActivity:Activity(){overridefunonCreate(savedInstanceState:Bundle?){super.onCreate(savedInstanceState)setContentView(R.layout.activity_main)

// Instead of findViewById(R.id.textView)

textView.setText("Hello, world!")

}

}

</pre>

textView是Activity的扩展属性,它与activity_main.xml中声明的类型相同(所以它是一个TextView)

Kotlin Android Extensions 的使用

配置

在本教程中,我们将使用Gradle,但使用IntelliJ IDEA项目结构或Maven也可以完成相同的任务。有关设置Gradle以使用Kotlin的详细信息,请参阅使用Gradle

Android扩展是IntelliJ IDEA和Android Studio的Kotlin插件的一部分。你不需要安装额外的插件。

你所需要做的就是在你module下的build.gradle文件中添加如下代码:

apply plugin:'kotlin-android-extensions'

导入合成的组件

它可以非常方便的一次导入所有合成的组件。

importkotlinx.android.synthetic.main.<layout>.*

假如layout是activity_main.xml,那我们就导入 kotlinx.android.synthetic.main.activity_main.*

如果我们想调用View的一些属性,我们还应该导入 kotlinx.android.synthetic.main.activity_main.view.*.

这样,我们就可以调用调用相应的扩展组件,这些扩展组件是以XML文件中的View命名的属性。(就是view的id)例如下面的view
<TextView
android:id="@+id/hello"
android:layout_width="fill_parent"
android:layout_height="wrap_content"/>
就会有一个叫hello的属性:
<code>activity.hello.text = "Hello World!"</code>

实验功能

Android Extensions 插件包括几个实验功能,比如Parcelable生成器,这些功能还没有应用到生产环境,如果你想使用他们,需要打开实验模式。在build.gradle 中添加以下代码
androidExtensions {
experimental = true
}

视图界面的支持
Android Extensions 插件支持不同类型的视图界面,最基本的就是acitivity,fragment,view。
事实上,你可以把任意一个类变成视图界面,只要你实现LayoutContainer 接口
import kotlinx.android.extensions.LayoutContainer

class ViewHolder(override val containerView: View) : ViewHolder(containerView), LayoutContainer {
fun setup(title: String) {
itemTitle.text = "Hello World!"
}
}

注意,你需要打开实验模式来使用LayoutContainer

渠道支持
Android Extensions 插件支持Android 不同的渠道,比如你有一个free的渠道
android {
productFlavors {
free {
versionName "1.0-free"
}
}
}
你可以通过以下代码导入 free/res/layout/activity_free.xml 所有生成的属性
import kotlinx.android.synthetic.free.activity_free.*
在实验模式下,你可以指定任意一个变体的名字,不仅仅是渠道,例如freeDebug,FreeRelease

视图缓存
调用findviewbyid() 很耗时,尤其是在复杂多层次的视图界面里。所以Android Extensions 通过缓存视图来减少findviewbyid()的调用。
下面的例子,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 Extensions 插件使用HashMap储存,您也可以切换到SparseArray,或者关闭储存, 当您仅使用Android扩展的Parcelable部分时,后者(SparseArray)特别有用。
同时,你也可以使用注解@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 Extensions 插件提供了Parcelable 实现生成器作为实验功能。
首先,启用Parcelable 支持 Apply the kotlin-android-extensions ,然后打开实验功能。

使用
使用@Parcelize 注解这个类,Parcelable就会自动实现
import kotlinx.android.parcel.Parcelize
@Parcelize
class User(val firstName: String, val lastName: String, val age: Int): Parcelable

@Parcelize 需要所有的属性在主构造方法中声明,如果在类中声明的话,Android Extensions 会发出警告。此外,如果某些主构造函数参数不是属性,则不能应用@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支持广泛的类型:
--基本类型,包括封箱的类型(Integer)
--Objects and enums;
--String, CharSequence;
--Exception;
--Size, SizeF, Bundle, IBinder, IInterface, FileDescriptor;
--SparseArray, SparseIntArray, SparseLongArray, SparseBooleanArray;
--所有的 Serializable (是的,Date 也支持) 和所有实现 Parcelable 的类;
--所有支持类型的集合: 比如 List (mapped to ArrayList), Set (mapped to LinkedHashSet), Map (mapped to LinkedHashMap);
--还包括一些具体实现的集合: ArrayList, LinkedList, SortedSet, NavigableSet, HashSet, LinkedHashSet, TreeSet, SortedMap, NavigableMap, HashMap, LinkedHashMap, TreeMap, ConcurrentHashMap;
--所有支持类型的数组
--所有支持类型为null的情况.

自定义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)

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 200,176评论 5 469
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,190评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 147,232评论 0 332
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,953评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,879评论 5 360
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,177评论 1 277
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,626评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,295评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,436评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,365评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,414评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,096评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,685评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,771评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,987评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,438评论 2 346
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,032评论 2 341

推荐阅读更多精彩内容