為什么需要擴展函數(shù)?
在很多公司一些比較穩(wěn)定良好的庫都是 Java 開發(fā)的明吩,也完全沒必要去用 Kotlin 語言重寫蓝晒。但是想要擴展庫的接口和功能,這時候擴展函數(shù)可能就會派上用場说订。使用 Kotlin 的擴展函數(shù)還有一個好處就是沒有副作用灵临,不會對原有庫代碼或功能產(chǎn)生影響。
先來一個擴展函數(shù)的例子讼载,來實現(xiàn)一個給 Android 中 TextView 組件設置加粗的擴展函數(shù):
// 擴展函數(shù)的定義
fun TextView.isBold() = this.apply {
paint.isFakeBoldText = true
}
// 擴展函數(shù)的調(diào)用
activity.find<TextView>(R.id.course_comment_tv_score).isBold()
擴展函數(shù)的語法
Kotlin 的擴展函數(shù)可以毫無副作用給原有庫的類增加屬性和方法轿秧,比如例子中 TextView,我們根本沒有去動 TextView 源碼咨堤,但是卻給它增加一個擴展函數(shù)菇篡。具有那么強大功能,到底它背后原理是什么呢一喘?下面我們來深入學習下它的語法以及語法背后的原理驱还。
擴展函數(shù)的定義
Kotlin 可以為一個不能修改的或來自第三方庫中的類編寫一個新的函數(shù)。 這個新增的函數(shù)就像那個原始類本來就有的函數(shù)一樣凸克,可以用普通的方法調(diào)用议蟆,這種機制的函數(shù)稱為擴展函數(shù)。
// 擴展函數(shù)定義
fun TextView.isBold() = this.apply {
paint.isFakeBoldText = true
}
擴展函數(shù)的分析
擴展函數(shù)只需要把擴展的類或者接口名稱萎战,放到即將要添加的函數(shù)名前面咐容。這個類或者名稱就叫做接收者類型,類的名稱與函數(shù)之間用 .
調(diào)用連接蚂维。this
指代的就是接收者對象戳粒,它可以訪問擴展的這個類可訪問的函數(shù)或?qū)傩?/strong>路狮。
擴展函數(shù)的背后原理
擴展函數(shù)實際上就是一個對應 Java 中的靜態(tài)函數(shù),這個靜態(tài)函數(shù)參數(shù)為接收者類型的對象蔚约,然后利用這個對象就可以訪問這個類中的成員屬性和方法了览祖,并且最后返回一個這個接收者類型對象本身。這樣在外部感覺和使用類的成員函數(shù)是一樣的:
// 這個類名就是頂層文件名+“Kt”后綴
public final class ExtendsionTextViewKt {
// 擴展函數(shù) isBold 對應實際上是 Java 中的靜態(tài)函數(shù)炊琉,并且傳入一個接收者類型對象作為參數(shù)
@NotNull
public static final TextView isBold(@NotNull TextView $receiver) {
Intrinsics.checkParameterIsNotNull($receiver, "$receiver");
$receiver.getPaint().setFakeBoldText(true); // 設置加粗
return $receiver; // 最后返回這個接收者對象自身展蒂,以致于我們在Kotlin中完全可以使用 this 替代接收者對象或者直接不寫。
}
}
擴展函數(shù)的使用場景
擴展函數(shù)的使用場景主要就是毫無副作用給原有庫的類增加函數(shù)苔咪,增強類的行為锰悼。比如 Android 中給所有 View 組件增加常見動畫、給 ImageView 組件增加一個加載網(wǎng)絡圖片函數(shù)团赏、給 SpannableStringBuilder
增加 bold
加粗箕般、italic
斜體、color
顏色等一系列 Span
的設置以及很多需要重復設置模板代碼場景都可以使用擴展函數(shù)舔清。
擴展函數(shù)的使用示例
示例1: Android 中給 ImageView 組件增加一個 loadUrl 的擴展函數(shù),不再需要繁瑣 Glide 的調(diào)用体谒,只需簡單一行 loadUrl 代碼的調(diào)用就能實現(xiàn)加載圖片功能:
// loadUrl擴展函數(shù)接收者類型是ImageView
fun ImageView.loadUrl(requestManager: RequestManager = Glide.with(context)
, url: String = ""
, urls: List<String> = listOf(url)) {
// this 指代的是ImageView這個接收者對象實例, 這里this也可以省略
requestManager.view(this).url(urls).start()
}
// 使用擴展函數(shù)來加載多張圖片的調(diào)用方式
// imageView直接調(diào)用loadUrl像是給ImageView增加一個網(wǎng)絡圖片加載函數(shù)一樣抒痒,調(diào)用非常簡單。
course_cover_iv1.loadUrl("https://www.imooc.com/test1.png")
course_cover_iv2.loadUrl("https://www.imooc.com/test2.png")
course_cover_iv3.loadUrl("https://www.imooc.com/test3.png")
// 不使用擴展函數(shù)來加載多張圖片的調(diào)用方式
Glide.with(context)
.view(course_cover_iv1)
.url("https://www.imooc.com/test1.png")
.start()
Glide.with(context)
.view(course_cover_iv2)
.url("https://www.imooc.com/test2.png")
.start()
Glide.with(context)
.view(course_cover_iv3)
.url("https://www.imooc.com/test3.png")
.start()
示例2: Android 中給 View 組件增加一個 animAlpha 透明動畫的擴展函數(shù)傀广,不需要每次都去重新寫屬性動畫的配置彩届,只需要簡單一行代碼調(diào)用 View 中的方法即可。像是給原本就不具備透明動畫 View 組件無縫地提供一個動畫的功能:
// animAlpha 擴展函數(shù)接收者類型是 View,也就是 View 的子類都可以直接使用 animAlpha 函數(shù)
fun View.animAlpha(
duration: Long = 600,
alpha: Float = 0f,
delay: Long = 0,
animatorEnd: ((Animator?) -> Unit)? = null
) {
this.animate() // this 指代的是 View 這個接收者對象實例, 這里 this 也可以省略
.setDuration(duration)
.setInterpolator(AccelerateDecelerateInterpolator())
.setStartDelay(delay)
.alpha(alpha)
.setListener(object : Animator.AnimatorListener {
override fun onAnimationRepeat(animation: Animator?) {
}
override fun onAnimationEnd(animation: Animator?) {
animatorEnd?.invoke(animation)
}
override fun onAnimationCancel(animation: Animator?) {
}
override fun onAnimationStart(animation: Animator?) {
}
})
.start()
}
// animAlphaVisible 擴展函數(shù)贮聂,設置 View 組件的顯示和消失透明度動畫坯墨,通過i sVisible 控制
fun View.animAlphaVisible(
isVisible: Boolean,
duration: Long = 600,
animatorEnd: ((Animator?) -> Unit)? = null
) {
// 擴展函數(shù)內(nèi)部再調(diào)用擴展函數(shù) animAlpha
animAlpha(duration, alpha = if (isVisible) 1f else 0f, animatorEnd = animatorEnd)
}
// 擴展函數(shù) animAlpha 調(diào)用
mEditText.animAlpha(alpha = 0.2f) // EditText 組件通過最開始透明度變化到 alpha 為 0.2f
// 擴展函數(shù) animAlphaVisible 調(diào)用
mIv.animAlphaVisible(isVisible = true) // ImageView 組件設置透明度顯示的動畫
mTv.animAlphaVisible(isVisible = false) // TextView 組件設置透明度消失的動畫
擴展函數(shù)需要注意的點
擴展函數(shù)不能像成員函數(shù)那樣被子類重寫捣染;
擴展函數(shù)不能訪問原始類中私有成員屬性或成員函數(shù)停巷;
擴展函數(shù)的本質(zhì)通過傳入對象實例榕栏,委托對象來訪問成員函數(shù)蕾各,所以它的訪問權限和對象訪問權限一致。
擴展函數(shù)與成員函數(shù)的區(qū)別
擴展函數(shù)在外部調(diào)用方式來看和類的成員函數(shù)是一致式曲,但是兩者卻有著本質(zhì)的區(qū)別。
擴展函數(shù)和成員函數(shù)使用方式類似兰伤,可以直接訪問被擴展類的方法和屬性钧排。(原理: 傳入了一個擴展類的對象,內(nèi)部實際上是用實例對象去訪問擴展類的方法和屬性)恨溜;
擴展函數(shù)不能打破擴展類的封裝性,不能像成員函數(shù)一樣直接訪問內(nèi)部私有函數(shù)和屬性判族。(原理: 原理很簡單项戴,擴展函數(shù)訪問實際是類的對象訪問,由于類的對象實例不能訪問內(nèi)部私有函數(shù)和屬性沃缘,自然擴展函數(shù)也就不能訪問內(nèi)部私有函數(shù)和屬性了)则吟;
擴展函數(shù)實際上是一個靜態(tài)函數(shù)是處于類的外部,而成員函數(shù)則是類的內(nèi)部函數(shù)氓仲;
父類成員函數(shù)可以被子類重寫,而擴展函數(shù)則不行晰洒。
擴展函數(shù)使用經(jīng)驗
雖然擴展函數(shù)功能十分強大啥箭,但是記住千萬不要濫用擴展函數(shù),并不是所有場景定義都合適定義成擴展函數(shù)砌滞。定義成擴展函數(shù)需要抓住以下三個點:
第一,這個函數(shù)需要被很多地方復用贝润,定義成擴展函數(shù)減少很多重復模板代碼;
第二华畏,這個函數(shù)具有擴展的原始類尊蚁,如果沒有那么就不適合定義成擴展函數(shù),它經(jīng)常很容易會和頂層函數(shù)使用場景弄混枝誊;
第三,如果需要擴展一個原始類的行為時候用擴展函數(shù)绝骚,如果是擴展一個原始類的狀態(tài)的時候建議使用擴展屬性祠够。
總結
擴展函數(shù)的本質(zhì)是一個對應 Java 中的靜態(tài)函數(shù),這個靜態(tài)函數(shù)參數(shù)為接收者類型的對象止剖,然后利用這個對象就可以訪問這個類中的成員屬性和方法了落君,并且最后返回一個這個接收者類型對象本身。這樣在外部感覺和使用類的成員函數(shù)是一樣的皮获。另外纹冤,擴展函數(shù)與成員函數(shù)的相同點和不同點也是擴展函數(shù)中的重點。
參考:
Kotlin 擴展函數(shù)