การเชื่อมโยงอะแดปเตอร์

อะแดปเตอร์การเชื่อมโยงมีหน้าที่รับผิดชอบในการเรียกใช้เฟรมเวิร์กที่เหมาะสมเพื่อตั้งค่า ตัวอย่างหนึ่งคือการตั้งค่าพร็อพเพอร์ตี้ เช่น การเรียกใช้เมธอด setText() อีกตัวอย่างหนึ่งคือการตั้งค่า Listener เหตุการณ์ เช่น การเรียกใช้เมธอด setOnClickListener()

ไลบรารีการเชื่อมโยงข้อมูลช่วยให้คุณระบุการเรียกใช้เมธอดเพื่อตั้งค่า ระบุตรรกะการเชื่อมโยงของคุณเอง และระบุประเภทของออบเจ็กต์ที่แสดงผลโดยใช้อะแดปเตอร์ได้

ตั้งค่าแอตทริบิวต์

เมื่อใดก็ตามที่ค่าที่เชื่อมโยงมีการเปลี่ยนแปลง คลาสการเชื่อมโยงที่สร้างขึ้นจะต้องเรียกใช้เมธอด Setter ในมุมมองที่มีนิพจน์การเชื่อมโยง คุณสามารถให้ไลบรารีการเชื่อมโยงข้อมูลกำหนดเมธอดโดยอัตโนมัติ หรือจะประกาศเมธอดอย่างชัดแจ้งหรือระบุตรรกะที่กำหนดเองเพื่อเลือกเมธอดก็ได้

การเลือกวิธีการโดยอัตโนมัติ

สำหรับชื่อแอตทริบิวต์ example ไลบรารีจะค้นหาเมธอด setExample(arg) โดยอัตโนมัติซึ่งยอมรับประเภทที่เข้ากันได้เป็นอาร์กิวเมนต์ ระบบจะไม่พิจารณาเนมสเปซของแอตทริบิวต์ ระบบจะใช้เฉพาะชื่อและประเภทแอตทริบิวต์เมื่อค้นหาวิธีการ

ตัวอย่างเช่น เมื่อระบุนิพจน์ android:text="@{user.name}" ไลบรารีจะค้นหาเมธอด setText(arg) ที่ยอมรับประเภทที่ user.getName() แสดงผล หากประเภทการแสดงผลของ user.getName() คือ String ไลบรารีจะมองหาเมธอด setText() ที่ยอมรับอาร์กิวเมนต์ String หากนิพจน์แสดงผลเป็น int ไลบรารีจะค้นหาวิธี setText() ที่ยอมรับอาร์กิวเมนต์ int นิพจน์ต้องแสดงผลประเภทที่ถูกต้อง คุณสามารถแคสต์ค่าที่แสดงผลได้หากจำเป็น

การเชื่อมโยงข้อมูลจะทำงานแม้ว่าจะไม่มีแอตทริบิวต์ที่มีชื่อที่ระบุอยู่ก็ตาม คุณสามารถสร้างแอตทริบิวต์สำหรับ Setter ใดก็ได้โดยใช้การเชื่อมโยงข้อมูล เช่น คลาสการสนับสนุน DrawerLayout ไม่มีแอตทริบิวต์ แต่มีเมธอด Setter จำนวนมาก เลย์เอาต์ต่อไปนี้จะใช้เมธอด setScrimColor(int) และ addDrawerListener(DrawerListener) เป็น Setter สำหรับแอตทริบิวต์ app:scrimColor และ app:drawerListener ตามลำดับโดยอัตโนมัติ

<androidx.drawerlayout.widget.DrawerLayout
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"
    app:scrimColor="@{@color/scrim}"
    app:drawerListener="@{fragment.drawerListener}">

ระบุชื่อเมธอดที่กำหนดเอง

แอตทริบิวต์บางรายการมี Setter ที่ไม่ตรงกันตามชื่อ ในสถานการณ์เหล่านี้ คุณสามารถเชื่อมโยงแอตทริบิวต์กับ Setter ได้โดยใช้คำอธิบายประกอบ BindingMethods ระบบจะใช้คำอธิบายประกอบกับคลาสและอาจมีคำอธิบายประกอบ BindingMethod หลายรายการ โดยมี 1 รายการสำหรับแต่ละเมธอดที่เปลี่ยนชื่อ เมธอดการเชื่อมโยงคือคำอธิบายประกอบที่คุณเพิ่มลงในคลาสใดก็ได้ในแอป

ในตัวอย่างต่อไปนี้ แอตทริบิวต์ android:tint จะเชื่อมโยงกับเมธอด setImageTintList(ColorStateList) ไม่ใช่เมธอด setTint()

Kotlin

@BindingMethods(value = [
    BindingMethod(
        type = android.widget.ImageView::class,
        attribute = "android:tint",
        method = "setImageTintList")])

Java

@BindingMethods({
       @BindingMethod(type = "android.widget.ImageView",
                      attribute = "android:tint",
                      method = "setImageTintList"),
})

โดยปกติแล้ว คุณไม่จำเป็นต้องเปลี่ยนชื่อ Setter ในคลาสเฟรมเวิร์ก Android แอตทริบิวต์ได้รับการติดตั้งใช้งานแล้วโดยใช้รูปแบบการตั้งชื่อเพื่อค้นหาวิธีการจับคู่โดยอัตโนมัติ

ระบุตรรกะที่กำหนดเอง

แอตทริบิวต์บางรายการต้องใช้ตรรกะการเชื่อมโยงที่กำหนดเอง ตัวอย่างเช่น ไม่มี Setter ที่เชื่อมโยงสำหรับแอตทริบิวต์ android:paddingLeft แต่จะมีเมธอด setPadding(left, top, right, bottom) ให้แทน เมธอดอะแดปเตอร์การเชื่อมโยงแบบคงที่ที่มีคำอธิบายประกอบ BindingAdapter ช่วยให้คุณปรับแต่งวิธีเรียกใช้เมธอด Setter สำหรับแอตทริบิวต์ได้

แอตทริบิวต์ของคลาสเฟรมเวิร์ก Android มีคำอธิบายประกอบ BindingAdapter อยู่แล้ว ตัวอย่างต่อไปนี้แสดงอะแดปเตอร์การเชื่อมโยงสำหรับแอตทริบิวต์ paddingLeft

Kotlin

@BindingAdapter("android:paddingLeft")
fun setPaddingLeft(view: View, padding: Int) {
    view.setPadding(padding,
                view.getPaddingTop(),
                view.getPaddingRight(),
                view.getPaddingBottom())
}

Java

@BindingAdapter("android:paddingLeft")
public static void setPaddingLeft(View view, int padding) {
  view.setPadding(padding,
                  view.getPaddingTop(),
                  view.getPaddingRight(),
                  view.getPaddingBottom());
}

ประเภทพารามิเตอร์เป็นสิ่งสำคัญ พารามิเตอร์แรกจะกำหนดประเภทของมุมมองที่เชื่อมโยงกับแอตทริบิวต์ พารามิเตอร์ที่ 2 จะกำหนดประเภทที่ยอมรับในนิพจน์การเชื่อมโยงสำหรับแอตทริบิวต์ที่ระบุ

อะแดปเตอร์การเชื่อมโยงยังมีประโยชน์สำหรับการปรับแต่งประเภทอื่นๆ ด้วย ตัวอย่างเช่น คุณสามารถเรียกใช้ตัวโหลดที่กำหนดเองจากเทรดผู้ปฏิบัติงานเพื่อโหลดรูปภาพได้

นอกจากนี้ คุณยังสามารถใช้อะแดปเตอร์ที่รับหลายแอตทริบิวต์ได้ ดังที่แสดงในตัวอย่างต่อไปนี้

Kotlin

@BindingAdapter("imageUrl", "error")
fun loadImage(view: ImageView, url: String, error: Drawable) {
    Picasso.get().load(url).error(error).into(view)
}

Java

@BindingAdapter({"imageUrl", "error"})
public static void loadImage(ImageView view, String url, Drawable error) {
  Picasso.get().load(url).error(error).into(view);
}

คุณใช้อะแดปเตอร์ในเลย์เอาต์ได้ ดังที่แสดงในตัวอย่างต่อไปนี้ โปรดทราบว่า @drawable/venueError หมายถึงทรัพยากรในแอป การใส่ @{} ไว้รอบทรัพยากรจะทำให้เป็นนิพจน์การเชื่อมโยงที่ถูกต้อง

<ImageView app:imageUrl="@{venue.imageUrl}" app:error="@{@drawable/venueError}" />

ระบบจะเรียกใช้อะแดปเตอร์หากใช้ imageUrl และ error สำหรับออบเจ็กต์ ImageView โดย imageUrl เป็นสตริง และ error เป็น Drawable หากต้องการให้อะแดปเตอร์ถูกเรียกเมื่อมีการตั้งค่าแอตทริบิวต์ใดๆ ให้ตั้งค่าแฟล็ก requireAll ที่ไม่บังคับของอะแดปเตอร์เป็น false ดังที่แสดงในตัวอย่างต่อไปนี้

Kotlin

@BindingAdapter(value = ["imageUrl", "placeholder"], requireAll = false)
fun setImageUrl(imageView: ImageView, url: String?, placeHolder: Drawable?) {
    if (url == null) {
        imageView.setImageDrawable(placeholder);
    } else {
        MyImageLoader.loadInto(imageView, url, placeholder);
    }
}

Java

@BindingAdapter(value={"imageUrl", "placeholder"}, requireAll=false)
public static void setImageUrl(ImageView imageView, String url, Drawable placeHolder) {
  if (url == null) {
    imageView.setImageDrawable(placeholder);
  } else {
    MyImageLoader.loadInto(imageView, url, placeholder);
  }
}

เมธอด Binding Adapter สามารถรับค่าเก่าในเครื่องจัดการได้ เมธอดที่ใช้ค่าเก่าและค่าใหม่ต้องประกาศค่าเก่าทั้งหมดสำหรับแอตทริบิวต์ก่อน ตามด้วยค่าใหม่ ดังที่แสดงในตัวอย่างต่อไปนี้

Kotlin

@BindingAdapter("android:paddingLeft")
fun setPaddingLeft(view: View, oldPadding: Int, newPadding: Int) {
    if (oldPadding != newPadding) {
        view.setPadding(newPadding,
                    view.getPaddingTop(),
                    view.getPaddingRight(),
                    view.getPaddingBottom())
    }
}

Java

@BindingAdapter("android:paddingLeft")
public static void setPaddingLeft(View view, int oldPadding, int newPadding) {
  if (oldPadding != newPadding) {
      view.setPadding(newPadding,
                      view.getPaddingTop(),
                      view.getPaddingRight(),
                      view.getPaddingBottom());
   }
}

ตัวแฮนเดิลเหตุการณ์ใช้ได้กับอินเทอร์เฟซหรือคลาสนามธรรมที่มีเมธอดนามธรรม 1 รายการเท่านั้น ดังที่แสดงในตัวอย่างต่อไปนี้

Kotlin

@BindingAdapter("android:onLayoutChange")
fun setOnLayoutChangeListener(
        view: View,
        oldValue: View.OnLayoutChangeListener?,
        newValue: View.OnLayoutChangeListener?
) {
    if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.HONEYCOMB) {
        if (oldValue != null) {
            view.removeOnLayoutChangeListener(oldValue)
        }
        if (newValue != null) {
            view.addOnLayoutChangeListener(newValue)
        }
    }
}

Java

@BindingAdapter("android:onLayoutChange")
public static void setOnLayoutChangeListener(View view, View.OnLayoutChangeListener oldValue,
       View.OnLayoutChangeListener newValue) {
  if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.HONEYCOMB) {
    if (oldValue != null) {
      view.removeOnLayoutChangeListener(oldValue);
    }
    if (newValue != null) {
      view.addOnLayoutChangeListener(newValue);
    }
  }
}

ใช้เครื่องจัดการเหตุการณ์นี้ในเลย์เอาต์ดังนี้

<View android:onLayoutChange="@{() -> handler.layoutChanged()}"/>

เมื่อ Listener มีหลายเมธอด จะต้องแยกออกเป็น Listener หลายรายการ ตัวอย่างเช่น View.OnAttachStateChangeListener มี 2 เมธอด ได้แก่ onViewAttachedToWindow(View) และ onViewDetachedFromWindow(View) ไลบรารีมีอินเทอร์เฟซ 2 รายการเพื่อแยกความแตกต่างของแอตทริบิวต์และแฮนเดิลสำหรับแอตทริบิวต์เหล่านั้น ดังนี้

Kotlin

// Translation from provided interfaces in Java:
@TargetApi(Build.VERSION_CODES.HONEYCOMB_MR1)
interface OnViewDetachedFromWindow {
    fun onViewDetachedFromWindow(v: View)
}

@TargetApi(Build.VERSION_CODES.HONEYCOMB_MR1)
interface OnViewAttachedToWindow {
    fun onViewAttachedToWindow(v: View)
}

Java

@TargetApi(VERSION_CODES.HONEYCOMB_MR1)
public interface OnViewDetachedFromWindow {
  void onViewDetachedFromWindow(View v);
}

@TargetApi(VERSION_CODES.HONEYCOMB_MR1)
public interface OnViewAttachedToWindow {
  void onViewAttachedToWindow(View v);
}

เนื่องจากการเปลี่ยน Listener รายการหนึ่งอาจส่งผลต่ออีกรายการหนึ่ง คุณจึงต้องใช้อะแดปเตอร์ที่ใช้ได้กับแอตทริบิวต์อย่างใดอย่างหนึ่งหรือทั้ง 2 อย่าง คุณสามารถตั้งค่า requireAll เป็น false ในคำอธิบายประกอบเพื่อระบุว่าไม่จำเป็นต้องกำหนดนิพจน์การเชื่อมโยงให้กับทุกแอตทริบิวต์ ดังที่แสดงในตัวอย่างต่อไปนี้

Kotlin

@BindingAdapter(
        "android:onViewDetachedFromWindow",
        "android:onViewAttachedToWindow",
        requireAll = false
)
fun setListener(view: View, detach: OnViewDetachedFromWindow?, attach: OnViewAttachedToWindow?) {
    if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.HONEYCOMB_MR1) {
        val newListener: View.OnAttachStateChangeListener?
        newListener = if (detach == null && attach == null) {
            null
        } else {
            object : View.OnAttachStateChangeListener {
                override fun onViewAttachedToWindow(v: View) {
                    attach.onViewAttachedToWindow(v)
                }

                override fun onViewDetachedFromWindow(v: View) {
                    detach.onViewDetachedFromWindow(v)
                }
            }
        }

        val oldListener: View.OnAttachStateChangeListener? =
                ListenerUtil.trackListener(view, newListener, R.id.onAttachStateChangeListener)
        if (oldListener != null) {
            view.removeOnAttachStateChangeListener(oldListener)
        }
        if (newListener != null) {
            view.addOnAttachStateChangeListener(newListener)
        }
    }
}

Java

@BindingAdapter({"android:onViewDetachedFromWindow", "android:onViewAttachedToWindow"}, requireAll=false)
public static void setListener(View view, OnViewDetachedFromWindow detach, OnViewAttachedToWindow attach) {
    if (VERSION.SDK_INT >= VERSION_CODES.HONEYCOMB_MR1) {
        OnAttachStateChangeListener newListener;
        if (detach == null && attach == null) {
            newListener = null;
        } else {
            newListener = new OnAttachStateChangeListener() {
                @Override
                public void onViewAttachedToWindow(View v) {
                    if (attach != null) {
                        attach.onViewAttachedToWindow(v);
                    }
                }
                @Override
                public void onViewDetachedFromWindow(View v) {
                    if (detach != null) {
                        detach.onViewDetachedFromWindow(v);
                    }
                }
            };
        }

        OnAttachStateChangeListener oldListener = ListenerUtil.trackListener(view, newListener,
                R.id.onAttachStateChangeListener);
        if (oldListener != null) {
            view.removeOnAttachStateChangeListener(oldListener);
        }
        if (newListener != null) {
            view.addOnAttachStateChangeListener(newListener);
        }
    }
}

ตัวอย่างข้างต้นค่อนข้างซับซ้อนเนื่องจากคลาส View ใช้เมธอด addOnAttachStateChangeListener() และ removeOnAttachStateChangeListener() แทนเมธอด Setter สำหรับ OnAttachStateChangeListener คลาส android.databinding.adapters.ListenerUtil ช่วยติดตาม Listener เหล่านี้เพื่อให้สามารถนำออกใน Binding Adapter ได้

Conversion ของออบเจ็กต์

การแปลงออบเจ็กต์อัตโนมัติ

เมื่อมีการแสดงผล Object จากนิพจน์การเชื่อมโยง ไลบรารีจะเลือกวิธีการที่ใช้ในการตั้งค่าพร็อพเพอร์ตี้ ระบบจะแคสต์ Object เป็นประเภทพารามิเตอร์ของเมธอดที่เลือก ลักษณะการทำงานนี้สะดวกในแอปที่ใช้คลาส ObservableMap เพื่อจัดเก็บข้อมูล ดังที่แสดงในตัวอย่างต่อไปนี้

<TextView
   android:text='@{userMap["lastName"]}'
   android:layout_width="wrap_content"
   android:layout_height="wrap_content" />

ออบเจ็กต์ userMap ในนิพจน์จะแสดงผลค่า ซึ่งจะแคสต์เป็นประเภทพารามิเตอร์ที่พบในเมธอด setText(CharSequence) ที่ใช้ตั้งค่าแอตทริบิวต์ android:text โดยอัตโนมัติ หากประเภทพารามิเตอร์ไม่ชัดเจน ให้แคสต์ประเภทการแสดงผลในนิพจน์

Conversion ที่กำหนดเอง

ในบางสถานการณ์ คุณต้องใช้ Conversion ที่กำหนดเองระหว่างประเภทที่เฉพาะเจาะจง เช่น แอตทริบิวต์ android:background ของมุมมองต้องการ Drawable แต่ค่า color ที่ระบุเป็นจำนวนเต็ม ตัวอย่างต่อไปนี้แสดงแอตทริบิวต์ที่คาดหวัง Drawable แต่มีการระบุจำนวนเต็มแทน

<View
   android:background="@{isError ? @color/red : @color/white}"
   android:layout_width="wrap_content"
   android:layout_height="wrap_content"/>

เมื่อใดก็ตามที่คาดว่าจะมี Drawable และมีการแสดงผลจำนวนเต็ม ให้แปลง int เป็น ColorDrawable หากต้องการทำการแปลง ให้ใช้เมธอดแบบคงที่ที่มีคำอธิบายประกอบ BindingConversion ดังนี้

Kotlin

@BindingConversion
fun convertColorToDrawable(color: Int) = ColorDrawable(color)

Java

@BindingConversion
public static ColorDrawable convertColorToDrawable(int color) {
    return new ColorDrawable(color);
}

อย่างไรก็ตาม ประเภทค่าที่ระบุในนิพจน์การเชื่อมโยงต้องสอดคล้องกัน คุณไม่สามารถใช้ประเภทที่แตกต่างกันในนิพจน์เดียวกันได้ ดังตัวอย่างต่อไปนี้

// The @drawable and @color represent different value types in the same
// expression, which causes a build error.
<View
   android:background="@{isError ? @drawable/error : @color/white}"
   android:layout_width="wrap_content"
   android:layout_height="wrap_content"/>

แหล่งข้อมูลเพิ่มเติม

ดูข้อมูลเพิ่มเติมเกี่ยวกับการเชื่อมโยงข้อมูลได้ที่แหล่งข้อมูลต่อไปนี้

ตัวอย่าง

บล็อกโพสต์