工作中用到了,翻譯一下,原文地址:http://kotlinlang.org/docs/tutorials/android-plugin.html
作者:Yan Zhulanow
本教程介紹了Kotlin Android Extensions的使用彤委,用以提高對Android開發(fā)的支持。
在本教程中,我們將介紹Kotlin Android Extensions插件使用所需的步驟,從而提高Android的開發(fā)體驗苦始。
View Binding
背景介紹
每一個Android程序猿都非常了解findViewById() 方法。毫無疑問慌申,他會導(dǎo)致一些潛在的錯誤(如陌选,強(qiáng)轉(zhuǎn)異常)而且難以閱讀和維護(hù),非常令人討厭蹄溉。盡管有一些庫可以解決這個問題咨油,但是這些庫都需要為每一個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的擴(kuò)展屬性,它與activity_main.xml中聲明的類型相同(所以它是一個TextView)
Kotlin Android Extensions 的使用
配置
在本教程中餐弱,我們將使用Gradle宴霸,但使用IntelliJ IDEA項目結(jié)構(gòu)或Maven也可以完成相同的任務(wù)囱晴。有關(guān)設(shè)置Gradle以使用Kotlin的詳細(xì)信息膏蚓,請參閱使用Gradle。
Android擴(kuò)展是IntelliJ IDEA和Android Studio的Kotlin插件的一部分畸写。你不需要安裝額外的插件驮瞧。
你所需要做的就是在你module下的build.gradle文件中添加如下代碼:
apply plugin:'kotlin-android-extensions'
導(dǎo)入合成的組件
它可以非常方便的一次導(dǎo)入所有合成的組件。
importkotlinx.android.synthetic.main.<layout>.*
假如layout是activity_main.xml枯芬,那我們就導(dǎo)入 kotlinx.android.synthetic.main.activity_main.*
如果我們想調(diào)用View的一些屬性论笔,我們還應(yīng)該導(dǎo)入 kotlinx.android.synthetic.main.activity_main.view.*.
這樣,我們就可以調(diào)用調(diào)用相應(yīng)的擴(kuò)展組件千所,這些擴(kuò)展組件是以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生成器淫痰,這些功能還沒有應(yīng)用到生產(chǎn)環(huán)境最楷,如果你想使用他們,需要打開實驗?zāi)J健T赽uild.gradle 中添加以下代碼
androidExtensions {
experimental = true
}
視圖界面的支持
Android Extensions 插件支持不同類型的視圖界面籽孙,最基本的就是acitivity烈评,fragment,view犯建。
事實上,你可以把任意一個類變成視圖界面,只要你實現(xiàn)LayoutContainer 接口
import kotlinx.android.extensions.LayoutContainer
class ViewHolder(override val containerView: View) : ViewHolder(containerView), LayoutContainer {
fun setup(title: String) {
itemTitle.text = "Hello World!"
}
}
注意谷扣,你需要打開實驗?zāi)J絹硎褂肔ayoutContainer
渠道支持
Android Extensions 插件支持Android 不同的渠道焙畔,比如你有一個free的渠道
android {
productFlavors {
free {
versionName "1.0-free"
}
}
}
你可以通過以下代碼導(dǎo)入 free/res/layout/activity_free.xml 所有生成的屬性
import kotlinx.android.synthetic.free.activity_free.*
在實驗?zāi)J较拢憧梢灾付ㄈ我庖粋€變體的名字犹菇,不僅僅是渠道德迹,例如freeDebug,F(xiàn)reeRelease
視圖緩存
調(diào)用findviewbyid() 很耗時揭芍,尤其是在復(fù)雜多層次的視圖界面里胳搞。所以Android Extensions 通過緩存視圖來減少findviewbyid()的調(diào)用。
下面的例子称杨,findviewbyid()只會被調(diào)用一次肌毅。
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
}
我們不知道這個函數(shù)是否只會被我們的來源的活動或簡單的Java活動調(diào)用。因此姑原,即使前面的示例中的MyActivity實例作為接收者傳遞悬而,我們也不使用緩存。
改變視圖緩存策略
你可以全局或者針對某個界面的改變視圖的緩存策略锭汛,這也需要打開實驗?zāi)J?br>
全局的視圖緩存策略可以在build.gradle 中設(shè)置
androidExtensions {
defaultCacheImplementation = "HASH_MAP" // also SPARSE_ARRAY, NONE
}
默認(rèn)情況下笨奠,Android Extensions 插件使用HashMap儲存,您也可以切換到SparseArray唤殴,或者關(guān)閉儲存般婆, 當(dāng)您僅使用Android擴(kuò)展的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 實現(xiàn)生成器作為實驗功能配名。
首先啤咽,啟用Parcelable 支持 Apply the kotlin-android-extensions ,然后打開實驗功能宇整。
使用
使用@Parcelize 注解這個類芋膘,Parcelable就會自動實現(xiàn)
import kotlinx.android.parcel.Parcelize
@Parcelize
class User(val firstName: String, val lastName: String, val age: Int): Parcelable
@Parcelize 需要所有的屬性在主構(gòu)造方法中聲明,如果在類中聲明的話贴彼,Android Extensions 會發(fā)出警告器仗。此外童番,如果某些主構(gòu)造函數(shù)參數(shù)不是屬性剃斧,則不能應(yīng)用@Parcelize幼东。
如果你的類需要更高級的序列化邏輯,你可以把它寫在一個內(nèi)部類中:
@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 也支持) 和所有實現(xiàn) Parcelable 的類;
--所有支持類型的集合: 比如 List (mapped to ArrayList), Set (mapped to LinkedHashSet), Map (mapped to LinkedHashMap);
--還包括一些具體實現(xiàn)的集合: ArrayList, LinkedList, SortedSet, NavigableSet, HashSet, LinkedHashSet, TreeSet, SortedMap, NavigableMap, HashMap, LinkedHashMap, TreeMap, ConcurrentHashMap;
--所有支持類型的數(shù)組
--所有支持類型為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注釋應(yīng)用外部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)