Kotlin自定义View之DataBinding

Kotlin使用DataBinding时难免有自定义View的需求，本文简要说明下自定义View后如何把自定义的 attr与DataBinding关联。

一、演示数据

CustomKotlinView .kt

class CustomKotlinView @JvmOverloads constructor(
    context: Context, attrs: AttributeSet? = null, defStyleAttr: Int = 0
) : AppCompatTextView(context, attrs, defStyleAttr) {

    private var cString: String = ""

    private fun initAttributeSet(attrs: AttributeSet?) {
        attrs ?: return
        context.obtainStyledAttributes(attrs, R.styleable.CustomKotlinView).use { typedArray ->
            cString= typedArray.getString(R.styleable.CustomKotlinView_customString) ?: ""
        }
        updateCustomString()
    }

    private fun updateCustomString() {
        text = cString
    }
    
    fun update(s: String) {
        cString = s
        updateCustomString()
    }

    init {
        initAttributeSet(attrs)
    }
}

attr.xml

    <declare-styleable name="CustomKotlinView">
        <attr name="customString" format="string" localization="suggested" />
    </declare-styleable>

layout_custom.xml

...
    <com.itxca.devicelx.wiget.CustomKotlinView
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        app:customString="@{viewmodel.clientData.ipAddress}" />
...

---

好了，现在如果你直接运行，必然会收获一个DataBinderMapperImpl.java的异常。因为DataBinding并不认识app:customString，这里关联主要有两种方法，setXXX()大法和@BindingAdapter

二、setXXX()大法

最简单的方式，给attr定义的属性名新增一个对应的set函数，
开始改造CustomKotlinView.kt

class CustomKotlinView @JvmOverloads constructor(
    context: Context, attrs: AttributeSet? = null, defStyleAttr: Int = 0
) : AppCompatTextView(context, attrs, defStyleAttr) {

    ... 简略代码
    
    /**
     * 定义一个public 的 setAttr函数，我这里的为R.styleable.CustomKotlinView_customString，那么就setCustomString(param)
     * @param string 这里需要attr定义的类型（参数为可空类型，否则将收到意外惊喜）
     */
    fun setCustomString(s: String?) {
        s ?: return
        this.cString= s
        updateCustomString()
    }
    
    ... 简略代码
}

定义一个public 的 set<attr>函数，我这里的定义attr名称为R.styleable.CustomKotlinView_customString，那么就是函数名为setCustomString(param)，参数@param 为attr定义的类型

注意：参数需定义为可空类型，否则将收到意外惊喜

同时，因为Kotlin特性，public var 会自动生成get/set，所以还可以简化为var customString:String?

class CustomKotlinView @JvmOverloads constructor(
    context: Context, attrs: AttributeSet? = null, defStyleAttr: Int = 0
) : AppCompatTextView(context, attrs, defStyleAttr) {

    ... 简略代码
    
    /**
     * kotlin 会自动生成get&set
     */
    var customString: String? = ""
        set(value) {
            value ?: return
            cString = value
            updateCustomString()
            field = value
        }
    
    ... 简略代码
}

三、@BindingAdapter

以上的两种方法都很方便和快速，但遇到不能修改的第三方View（任何障碍都可用一个中间层解决，但该处不做讨论），显然定义函数和变量就不适用了。如果想扩展第三方View支持DataBinding，则需使用到@BindingAdapter注解。

class CustomKotlinView @JvmOverloads constructor(
    context: Context, attrs: AttributeSet? = null, defStyleAttr: Int = 0
) : AppCompatTextView(context, attrs, defStyleAttr) {

    ... 简略代码
    
    fun update(s: String) {
        cString = s
        updateCustomString()
    }

    ... 简略代码
}

// 注意，这里是顶级函数。

/**
 * Java 思想，第一个参为你的自定义View，第二个参为attr定义的参数类型
 * 当然在Kotlin中也能使用
 */
//@BindingAdapter("customString")
//fun externalBindingCustomKotlinView(customKotlinView: CustomKotlinView, s: String?) {
//    s ?: return
//    customKotlinView.update(s)
//}

/**
 * Kotlin 思想，扩展函数
 */
@BindingAdapter("customString")
fun CustomKotlinView.kotlinExternalBindingCustomKotlinView(s:String?){
    s?:return
    update(s)
}

使用@BindingAdapter注解一个静态函数，@BindingAdapter(value)第一个参数value就是你定义的attr。这个函数需要两个参数，第一个为对应的自定义View，第二个为attr定义的参数类型。当然在Kotlin内也可使用自定义View的扩展函数实现（Decompile to java后其实扩展函数也是把this移动到了第一个参数，其它参数向后移动一位）。
注意定义@BindingAdapter需要public static，对应Kotlin就是顶级函数（未包含在任何class内的函数）。

---

未定义setXXX()或@BindingAdapter时常见错误：

...\app\build\generated\source\kapt\debug\com\itxca\devicelx\DataBinderMapperImpl.java:9: 错误: 找不到符号
import *.databinding.ActivityClientDetailsBindingImpl;                                   

原文地址，转载请注明：https://blog.csdn.net/hx7013/article/details/115732344