การเชื่อมโยงข้อมูลพร็อพเพอร์ตี้ เป็นส่วนหนึ่งของ Android Jetpack
การเชื่อมโยงมุมมองเป็นฟีเจอร์ที่ช่วยให้เขียนโค้ดที่โต้ตอบกับมุมมองได้ง่ายขึ้น เมื่อเปิดใช้การเชื่อมโยงมุมมองในโมดูล ระบบจะสร้างคลาสการเชื่อมโยงสำหรับไฟล์เลย์เอาต์ XML แต่ละไฟล์ที่อยู่ในโมดูลนั้น อินสแตนซ์ของคลาสการเชื่อมโยงประกอบด้วยการอ้างอิงโดยตรงไปยังมุมมองทั้งหมดที่มีรหัสในเลย์เอาต์ที่เกี่ยวข้อง
ในกรณีส่วนใหญ่ การเชื่อมโยงข้อมูลพร็อพเพอร์ตี้จะแทนที่ findViewById
ตั้งค่า
การเชื่อมโยงมุมมองจะเปิดใช้ตามโมดูล หากต้องการเปิดใช้การเชื่อมโยงมุมมองในโมดูล ให้ตั้งค่าตัวเลือกบิลด์ viewBinding เป็น true ในไฟล์ build.gradle ระดับโมดูล ดังที่แสดงในตัวอย่างต่อไปนี้
ดึงดูด
android { ... buildFeatures { viewBinding true } }
Kotlin
android { ... buildFeatures { viewBinding = true } }
หากต้องการให้ระบบละเว้นไฟล์เลย์เอาต์ขณะสร้างคลาสการเชื่อมโยง ให้เพิ่มแอตทริบิวต์ tools:viewBindingIgnore="true" ลงในมุมมองรูทของไฟล์เลย์เอาต์นั้น
<LinearLayout
...
tools:viewBindingIgnore="true" >
...
</LinearLayout>
การใช้งาน
หากเปิดใช้การเชื่อมโยงมุมมองสำหรับโมดูล ระบบจะสร้างคลาสการเชื่อมโยงสำหรับไฟล์เลย์เอาต์ XML แต่ละไฟล์ที่โมดูลมี คลาสการเชื่อมโยงแต่ละคลาสจะมีการอ้างอิงไปยังมุมมองรูทและมุมมองทั้งหมดที่มีรหัส ชื่อของคลาสการเชื่อมโยงจะสร้างขึ้นโดยการแปลงชื่อไฟล์ XML เป็น Pascal Case และเพิ่มคำว่า "Binding" ต่อท้าย
ตัวอย่างเช่น ลองพิจารณาไฟล์เลย์เอาต์ชื่อ result_profile.xml ที่มีข้อมูลต่อไปนี้
<LinearLayout ... >
<TextView android:id="@+id/name" />
<ImageView android:cropToPadding="true" />
<Button android:id="@+id/button"
android:background="@drawable/rounded_button" />
</LinearLayout>
คลาสการเชื่อมโยงที่สร้างขึ้นจะเรียกว่า ResultProfileBinding คลาสนี้มี 2 ฟิลด์ ได้แก่ TextView ชื่อ name และ Button ชื่อ button ImageView ในเลย์เอาต์ไม่มีรหัส จึงไม่มีการอ้างอิงถึงในคลาสการเชื่อมโยง
คลาสการเชื่อมโยงทุกคลาสยังมีเมธอด getRoot() ซึ่งให้ข้อมูลอ้างอิงโดยตรงสำหรับมุมมองรูทของไฟล์เลย์เอาต์ที่เกี่ยวข้อง ในตัวอย่างนี้ เมธอด getRoot() ในคลาส ResultProfileBinding จะแสดงผลมุมมองรูท LinearLayout
ส่วนต่อไปนี้จะสาธิตการใช้คลาสการเชื่อมโยงที่สร้างขึ้นในกิจกรรมและ Fragment
ใช้การเชื่อมโยงมุมมองในกิจกรรม
หากต้องการตั้งค่าอินสแตนซ์ของคลาสการเชื่อมโยงเพื่อใช้กับกิจกรรม ให้ทำตามขั้นตอนต่อไปนี้ในเมธอด onCreate() ของกิจกรรม
- เรียกใช้เมธอด
inflate()แบบคงที่ซึ่งรวมอยู่ในคลาสการเชื่อมโยงที่สร้างขึ้น ซึ่งจะสร้างอินสแตนซ์ของคลาสการเชื่อมโยงสำหรับกิจกรรมที่จะใช้ - รับข้อมูลอ้างอิงไปยังมุมมองรูทโดยเรียกใช้เมธอด
getRoot()หรือใช้ไวยากรณ์พร็อพเพอร์ตี้ Kotlin - ส่งมุมมองรูทไปยัง
setContentView()เพื่อทำให้เป็นมุมมองแอ็กทีฟบนหน้าจอ
ขั้นตอนเหล่านี้แสดงในตัวอย่างต่อไปนี้
Kotlin
private lateinit var binding: ResultProfileBinding
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
binding = ResultProfileBinding.inflate(layoutInflater)
val view = binding.root
setContentView(view)
}
Java
private ResultProfileBinding binding;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
binding = ResultProfileBinding.inflate(getLayoutInflater());
View view = binding.getRoot();
setContentView(view);
}
ตอนนี้คุณสามารถใช้อินสแตนซ์ของคลาสการเชื่อมโยงเพื่ออ้างอิงมุมมองใดก็ได้ ดังนี้
Kotlin
binding.name.text = viewModel.name
binding.button.setOnClickListener { viewModel.userClicked() }
Java
binding.name.setText(viewModel.getName());
binding.button.setOnClickListener(new View.OnClickListener() {
viewModel.userClicked()
});
ใช้การเชื่อมโยงข้อมูลพร็อพเพอร์ตี้ใน Fragment
หากต้องการตั้งค่าอินสแตนซ์ของคลาสการเชื่อมโยงเพื่อใช้กับ Fragment ให้ทำตามขั้นตอนต่อไปนี้ในเมธอด onCreateView() ของ Fragment
- เรียกใช้เมธอด
inflate()แบบคงที่ซึ่งรวมอยู่ในคลาสการเชื่อมโยงที่สร้างขึ้น ซึ่งจะสร้างอินสแตนซ์ของคลาสการเชื่อมโยงเพื่อให้ Fragment ใช้งาน - รับข้อมูลอ้างอิงไปยังมุมมองรูทโดยเรียกใช้เมธอด
getRoot()หรือใช้ไวยากรณ์พร็อพเพอร์ตี้ Kotlin - แสดงผลมุมมองรูทจากเมธอด
onCreateView()เพื่อทำให้เป็นมุมมองแอ็กทีฟบนหน้าจอ
Kotlin
private var _binding: ResultProfileBinding? = null
// This property is only valid between onCreateView and
// onDestroyView.
private val binding get() = _binding!!
override fun onCreateView(
inflater: LayoutInflater,
container: ViewGroup?,
savedInstanceState: Bundle?
): View? {
_binding = ResultProfileBinding.inflate(inflater, container, false)
val view = binding.root
return view
}
override fun onDestroyView() {
super.onDestroyView()
_binding = null
}
Java
private ResultProfileBinding binding;
@Override
public View onCreateView (LayoutInflater inflater,
ViewGroup container,
Bundle savedInstanceState) {
binding = ResultProfileBinding.inflate(inflater, container, false);
View view = binding.getRoot();
return view;
}
@Override
public void onDestroyView() {
super.onDestroyView();
binding = null;
}
ตอนนี้คุณสามารถใช้อินสแตนซ์ของคลาสการเชื่อมโยงเพื่ออ้างอิงมุมมองใดก็ได้ ดังนี้
Kotlin
binding.name.text = viewModel.name
binding.button.setOnClickListener { viewModel.userClicked() }
Java
binding.name.setText(viewModel.getName());
binding.button.setOnClickListener(new View.OnClickListener() {
viewModel.userClicked()
});
ระบุคำแนะนำสำหรับการกำหนดค่าต่างๆ
เมื่อคุณประกาศมุมมองในการกำหนดค่าหลายรายการ บางครั้งการใช้ประเภทมุมมองที่แตกต่างกันก็เหมาะสม ทั้งนี้ขึ้นอยู่กับเลย์เอาต์นั้นๆ ข้อมูลโค้ดต่อไปนี้แสดงตัวอย่างของกรณีนี้
# in res/layout/example.xml
<TextView android:id="@+id/user_bio" />
# in res/layout-land/example.xml
<EditText android:id="@+id/user_bio" />
ในกรณีนี้ คุณอาจคาดหวังให้คลาสที่สร้างขึ้นแสดงฟิลด์ userBio ของประเภท TextView เนื่องจาก TextView เป็นคลาสพื้นฐานทั่วไป เนื่องจากข้อจำกัดทางเทคนิค เครื่องมือสร้างโค้ดการเชื่อมโยงมุมมองจึงไม่สามารถระบุข้อมูลนี้ได้ และจะสร้างช่อง View แทน ซึ่งจะต้องแคสต์ฟิลด์ในภายหลังด้วย binding.userBio as TextView
เพื่อหลีกเลี่ยงข้อจำกัดนี้ การเชื่อมโยงมุมมองจึงรองรับแอตทริบิวต์ tools:viewBindingType ซึ่งช่วยให้คุณบอกคอมไพเลอร์ได้ว่าจะใช้ประเภทใดในโค้ดที่สร้างขึ้น
ในตัวอย่างก่อนหน้านี้ คุณสามารถใช้แอตทริบิวต์นี้เพื่อทำให้คอมไพเลอร์สร้างฟิลด์เป็น TextView ได้ ดังนี้
# in res/layout/example.xml (unchanged)
<TextView android:id="@+id/user_bio" />
# in res/layout-land/example.xml
<EditText android:id="@+id/user_bio" tools:viewBindingType="TextView" />
ในอีกตัวอย่างหนึ่ง สมมติว่าคุณมีเลย์เอาต์ 2 แบบ แบบหนึ่งมี BottomNavigationView และอีกแบบมี NavigationRailView ทั้ง 2 คลาสจะขยาย NavigationBarView ซึ่งมีรายละเอียดการใช้งานส่วนใหญ่ หากโค้ดของคุณไม่จำเป็นต้องทราบว่าคลาสย่อยใดอยู่ในเลย์เอาต์ปัจจุบัน คุณสามารถใช้ tools:viewBindingType เพื่อตั้งค่าประเภทที่สร้างขึ้นเป็น NavigationBarView ในทั้ง 2 เลย์เอาต์ได้ ดังนี้
# in res/layout/navigation_example.xml
<BottomNavigationView android:id="@+id/navigation" tools:viewBindingType="NavigationBarView" />
# in res/layout-w720/navigation_example.xml
<NavigationRailView android:id="@+id/navigation" tools:viewBindingType="NavigationBarView" />
การเชื่อมโยงมุมมองไม่สามารถตรวจสอบค่าของแอตทริบิวต์นี้เมื่อสร้างโค้ด ค่าต้องเป็นไปตามเงื่อนไขต่อไปนี้เพื่อหลีกเลี่ยงข้อผิดพลาดขณะคอมไพล์และข้อผิดพลาดขณะรันไทม์
- ค่าต้องเป็นคลาสที่รับค่ามาจาก
android.view.View ค่าต้องเป็นคลาสใหญ่สุดของแท็กที่วางอยู่ ตัวอย่างเช่น ค่าต่อไปนี้จะใช้ไม่ได้
<TextView tools:viewBindingType="ImageView" /> <!-- ImageView is not related to TextView. --> <TextView tools:viewBindingType="Button" /> <!-- Button is not a superclass of TextView. -->ประเภทสุดท้ายต้องได้รับการแก้ไขอย่างสอดคล้องกันในการกำหนดค่าทั้งหมด
ความแตกต่างจาก findViewById
การเชื่อมโยงมุมมองมีข้อดีที่สำคัญเหนือกว่าการใช้ findViewById ดังนี้
- ความปลอดภัยของค่า Null: เนื่องจากการเชื่อมโยงมุมมองจะสร้างการอ้างอิงโดยตรงไปยังมุมมอง จึงไม่มีความเสี่ยงที่จะเกิด Null Pointer Exception เนื่องจากรหัสมุมมองไม่ถูกต้อง
นอกจากนี้ เมื่อมุมมองปรากฏในการกำหนดค่าบางอย่างของเลย์เอาต์เท่านั้น ช่องที่มีการอ้างอิงในคลาสการเชื่อมโยงจะทำเครื่องหมายด้วย
@Nullable - ความปลอดภัยในการกำหนดประเภท: ช่องในคลาสการเชื่อมโยงแต่ละคลาสมีประเภทที่ตรงกับมุมมองที่อ้างอิงในไฟล์ XML ซึ่งหมายความว่าไม่มีความเสี่ยงที่จะเกิดข้อยกเว้นการแคสต์คลาส
ความแตกต่างเหล่านี้หมายความว่าความไม่เข้ากันระหว่างเลย์เอาต์และโค้ดจะส่งผลให้บิลด์ล้มเหลวในเวลาคอมไพล์แทนที่จะเป็นรันไทม์
การเปรียบเทียบกับการเชื่อมโยงข้อมูล
ทั้ง View Binding และการเชื่อมโยงข้อมูลจะสร้างคลาสการเชื่อมโยงที่คุณใช้อ้างอิงมุมมองได้โดยตรง อย่างไรก็ตาม การเชื่อมโยงมุมมองมีไว้เพื่อจัดการ Use Case ที่ง่ายกว่าและให้ประโยชน์ต่อไปนี้เหนือกว่าการเชื่อมโยงข้อมูล
- การคอมไพล์ที่เร็วขึ้น: การเชื่อมโยงมุมมองไม่จำเป็นต้องมีการประมวลผลคำอธิบายประกอบ จึงทำให้เวลาคอมไพล์เร็วขึ้น
- ใช้งานง่าย: การเชื่อมโยงมุมมองไม่จำเป็นต้องใช้ไฟล์เลย์เอาต์ XML ที่ติดแท็กเป็นพิเศษ จึงนำไปใช้ในแอปได้รวดเร็วยิ่งขึ้น เมื่อเปิดใช้การเชื่อมโยงมุมมองในโมดูล ระบบจะใช้การเชื่อมโยงมุมมองกับเลย์เอาต์ทั้งหมดของโมดูลนั้นโดยอัตโนมัติ
ในทางกลับกัน การเชื่อมโยงมุมมองมีข้อจำกัดต่อไปนี้เมื่อเทียบกับการเชื่อมโยงข้อมูล
- การเชื่อมโยงมุมมองไม่รองรับตัวแปรเลย์เอาต์หรือนิพจน์เลย์เอาต์ จึงไม่สามารถใช้เพื่อประกาศเนื้อหา UI แบบไดนามิกจากไฟล์เลย์เอาต์ XML ได้โดยตรง
- การเชื่อมโยงมุมมองไม่รองรับการเชื่อมโยงข้อมูลแบบ 2 ทาง
เนื่องจากข้อควรพิจารณาเหล่านี้ ในบางกรณีจึงควรใช้ทั้งการเชื่อมโยงมุมมองและการเชื่อมโยงข้อมูลในโปรเจ็กต์ คุณสามารถใช้การเชื่อมโยงข้อมูลในเลย์เอาต์ที่ต้องใช้ฟีเจอร์ขั้นสูง และใช้การเชื่อมโยงข้อมูลพร็อพเพอร์ตี้ในเลย์เอาต์ที่ไม่ต้องใช้ฟีเจอร์ขั้นสูง
แหล่งข้อมูลเพิ่มเติม
ดูข้อมูลเพิ่มเติมเกี่ยวกับการเชื่อมโยงมุมมองได้ที่แหล่งข้อมูลเพิ่มเติมต่อไปนี้
บล็อก
วิดีโอ
แนะนำสำหรับคุณ
- หมายเหตุ: ข้อความลิงก์จะแสดงเมื่อ JavaScript ปิดอยู่
- ย้ายข้อมูลจาก Kotlin Synthetics ไปยัง Jetpack View Binding
- เลย์เอาต์และนิพจน์การเชื่อมโยง
- สถาปัตยกรรมแอป: เลเยอร์ของ UI - เริ่มต้นใช้งาน - นักพัฒนาแอป Android