คลาสการเชื่อมโยงที่สร้าง

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

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

ระบบจะสร้างคลาสการเชื่อมโยงสำหรับไฟล์เลย์เอาต์แต่ละไฟล์ โดยค่าเริ่มต้น ชื่อของคลาสคือชื่อของไฟล์เลย์เอาต์ที่แปลงเป็น Pascal Case โดยเพิ่มคำต่อท้าย Binding เข้าไป ตัวอย่างเช่น หากชื่อไฟล์เลย์เอาต์คือ activity_main.xml คลาสที่สร้างขึ้นที่เกี่ยวข้องจะเป็น ActivityMainBinding คลาสนี้จะเก็บการเชื่อมโยงทั้งหมดจากพร็อพเพอร์ตี้เลย์เอาต์ไปยังมุมมองของเลย์เอาต์ และรู้วิธีกำหนดค่าสำหรับนิพจน์การเชื่อมโยง

สร้างออบเจ็กต์การเชื่อมโยง

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

Kotlin

override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)

    val binding: MyLayoutBinding = MyLayoutBinding.inflate(layoutInflater)

    setContentView(binding.root)
}

Java

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    MyLayoutBinding binding = MyLayoutBinding.inflate(getLayoutInflater());

    setContentView(binding.root);
}

มีเมธอด inflate() เวอร์ชันอื่นที่รับออบเจ็กต์ ViewGroup นอกเหนือจากออบเจ็กต์ LayoutInflater ดังที่แสดงในตัวอย่างต่อไปนี้

Kotlin

val binding: MyLayoutBinding = MyLayoutBinding.inflate(getLayoutInflater(), viewGroup, false)

Java

MyLayoutBinding binding = MyLayoutBinding.inflate(getLayoutInflater(), viewGroup, false);

หากเลย์เอาต์ถูกขยายโดยใช้กลไกอื่น คุณสามารถเชื่อมโยงเลย์เอาต์แยกต่างหากได้ดังนี้

Kotlin

val binding: MyLayoutBinding = MyLayoutBinding.bind(viewRoot)

Java

MyLayoutBinding binding = MyLayoutBinding.bind(viewRoot);

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

Kotlin

val viewRoot = LayoutInflater.from(this).inflate(layoutId, parent, attachToParent)
val binding: ViewDataBinding? = DataBindingUtil.bind(viewRoot)

Java

View viewRoot = LayoutInflater.from(this).inflate(layoutId, parent, attachToParent);
ViewDataBinding binding = DataBindingUtil.bind(viewRoot);

หากคุณใช้รายการการเชื่อมโยงข้อมูลภายในอะแดปเตอร์ Fragment, ListView หรือ RecyclerView คุณอาจต้องการใช้เมธอด inflate() ของคลาสการเชื่อมโยงหรือคลาส DataBindingUtil ดังที่แสดงในตัวอย่างโค้ดต่อไปนี้

Kotlin

val listItemBinding = ListItemBinding.inflate(layoutInflater, viewGroup, false)
// or
val listItemBinding = DataBindingUtil.inflate(layoutInflater, R.layout.list_item, viewGroup, false)

Java

ListItemBinding binding = ListItemBinding.inflate(layoutInflater, viewGroup, false);
// or
ListItemBinding binding = DataBindingUtil.inflate(layoutInflater, R.layout.list_item, viewGroup, false);

ยอดดูที่มีรหัส

ไลบรารีการเชื่อมโยงข้อมูลจะสร้างช่องที่เปลี่ยนแปลงไม่ได้ในคลาสการเชื่อมโยงสำหรับแต่ละมุมมองที่มีรหัสในเลย์เอาต์ ตัวอย่างเช่น ไลบรารีการเชื่อมโยงข้อมูลจะสร้างช่อง firstName และ lastName ของประเภท TextView จากเลย์เอาต์ต่อไปนี้

<layout xmlns:android="http://schemas.android.com/apk/res/android">
   <data>
       <variable name="user" type="com.example.User"/>
   </data>
   <LinearLayout
       android:orientation="vertical"
       android:layout_width="match_parent"
       android:layout_height="match_parent">
       <TextView android:layout_width="wrap_content"
           android:layout_height="wrap_content"
           android:text="@{user.firstName}"
   android:id="@+id/firstName"/>
       <TextView android:layout_width="wrap_content"
           android:layout_height="wrap_content"
           android:text="@{user.lastName}"
  android:id="@+id/lastName"/>
   </LinearLayout>
</layout>

ไลบรารีจะดึงข้อมูลมุมมอง รวมถึงรหัสจากลำดับชั้นการแสดงผลในครั้งเดียว กลไกนี้อาจเร็วกว่าการเรียกใช้เมธอด findViewById() สำหรับทุกมุมมองในเลย์เอาต์

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

ตัวแปร

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

<data>
   <import type="android.graphics.drawable.Drawable"/>
   <variable name="user" type="com.example.User"/>
   <variable name="image" type="Drawable"/>
   <variable name="note" type="String"/>
</data>

ViewStubs

ออบเจ็กต์ ViewStub จะเริ่มต้นเป็นมุมมองที่มองไม่เห็น ซึ่งแตกต่างจากมุมมองปกติ เมื่อทำให้มองเห็นได้หรือขยายอย่างชัดเจน มุมมองนี้จะแทนที่ตัวเองในเลย์เอาต์ด้วยการขยายเลย์เอาต์อื่น

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

เมื่อขยายเลย์เอาต์อื่น คุณต้องสร้างการเชื่อมโยงสำหรับเลย์เอาต์ใหม่ ดังนั้น ViewStubProxy ต้องฟัง ViewStub OnInflateListener และสร้างการเชื่อมโยงเมื่อจำเป็น เนื่องจากมี Listener ได้เพียงรายการเดียวในแต่ละครั้ง ViewStubProxy จึงให้คุณตั้งค่า OnInflateListener ซึ่งจะเรียกใช้หลังจากสร้างการเชื่อมโยงแล้ว

การผูกมัดทันที

เมื่อตัวแปรหรือออบเจ็กต์ที่สังเกตได้มีการเปลี่ยนแปลง ระบบจะกำหนดเวลาให้การเชื่อมโยงเปลี่ยนแปลงก่อนเฟรมถัดไป อย่างไรก็ตาม มีบางครั้งที่ต้องดำเนินการเชื่อมโยงทันที หากต้องการบังคับให้ดำเนินการ ให้ใช้เมธอด executePendingBindings()

ตัวแปรแบบไดนามิก

บางครั้งอาจไม่ทราบคลาสการเชื่อมโยงที่เฉพาะเจาะจง ตัวอย่างเช่น RecyclerView.Adapter ที่ทำงานกับเลย์เอาต์ที่กำหนดเองจะไม่รู้จักคลาสการเชื่อมโยงที่เฉพาะเจาะจง โดยต้องกำหนดค่าการเชื่อมโยงระหว่างการเรียกใช้เมธอด onBindViewHolder()

ในตัวอย่างต่อไปนี้ เลย์เอาต์ทั้งหมดที่ RecyclerView ผูกไว้จะมีตัวแปร item ออบเจ็กต์ BindingHolder มีเมธอด getBinding() ที่แสดงผลคลาสพื้นฐาน ViewDataBinding

Kotlin

override fun onBindViewHolder(holder: BindingHolder, position: Int) {
    item: T = items.get(position)
    holder.binding.setVariable(BR.item, item);
    holder.binding.executePendingBindings();
}

Java

public void onBindViewHolder(BindingHolder holder, int position) {
    final T item = items.get(position);
    holder.getBinding().setVariable(BR.item, item);
    holder.getBinding().executePendingBindings();
}

ชุดข้อความเบื้องหลัง

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

ชื่อคลาสการเชื่อมโยงที่กำหนดเอง

โดยค่าเริ่มต้น ระบบจะสร้างคลาสการเชื่อมโยงตามชื่อไฟล์เลย์เอาต์ โดยขึ้นต้นด้วยตัวอักษรพิมพ์ใหญ่ นำขีดล่าง ( _ ) ออก เขียนตัวอักษรตัวถัดไปเป็นตัวพิมพ์ใหญ่ และต่อท้ายด้วยคำว่า Binding เช่น ไฟล์เลย์เอาต์ contact_item.xml จะสร้างคลาส ContactItemBinding คลาสจะอยู่ในแพ็กเกจ databinding ภายใต้แพ็กเกจโมดูล ตัวอย่างเช่น หากแพ็กเกจโมดูลคือ com.example.my.app คลาสการเชื่อมโยงจะอยู่ในแพ็กเกจ com.example.my.app.databinding

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

<data class="ContactItem">
    ...
</data>

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

<data class=".ContactItem">
    ...
</data>

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

<data class="com.example.ContactItem">
    ...
</data>

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

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