‫View binding   בארגז הכלים Android Jetpack.

כריכת תצוגה היא תכונה שמאפשרת לכתוב בקלות קוד שמקיים אינטראקציה עם תצוגות. אחרי שמפעילים את קישור התצוגה במודול, נוצרת מחלקת קישור לכל קובץ פריסה ב-XML שקיים במודול הזה. מופע של מחלקת קישור מכיל הפניות ישירות לכל התצוגות שיש להן מזהה בפריסה המתאימה.

ברוב המקרים, קישור תצוגה מחליף את findViewById.

הגדרה

כריכת תצוגה מופעלת בכל מודול בנפרד. כדי להפעיל קישור תצוגה במודול, מגדירים את אפשרות ה-build‏ viewBinding ל-true בקובץ build.gradle ברמת המודול, כמו בדוגמה הבאה:

מגניב

android {
    ...
    buildFeatures {
        viewBinding true
    }
}

Kotlin

android {
    ...
    buildFeatures {
        viewBinding = true
    }
}

אם רוצים להתעלם מקובץ פריסה בזמן יצירת מחלקות קישור, מוסיפים את המאפיין tools:viewBindingIgnore="true" לתצוגת הבסיס (root) של קובץ הפריסה:

<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. למחלקה הזו יש שני שדות: TextView בשם name ו-Button בשם button. ל-ImageView בפריסה אין מזהה, ולכן אין הפניה אליו במחלקת הקישור.

כל מחלקת קישור כוללת גם שיטת getRoot(), שמספקת הפניה ישירה לתצוגת הבסיס של קובץ הפריסה המתאים. בדוגמה הזו, השיטה getRoot() במחלקה ResultProfileBinding מחזירה את תצוגת הבסיס LinearLayout.

בקטעים הבאים מוסבר איך להשתמש במחלקות הקישור שנוצרו בפעילויות ובמקטעים.

שימוש בקישור תצוגה בפעילויות

כדי להגדיר מופע של מחלקת הקישור לשימוש עם פעילות, מבצעים את השלבים הבאים ב-method onCreate() של הפעילות:

  1. מפעילים את ה-method הסטטית inflate() שכלולה במחלקת הקישור שנוצרה. כך נוצר מופע של מחלקת הקישור שבו הפעילות יכולה להשתמש.
  2. מקבלים הפניה לתצוגת הבסיס על ידי קריאה ל-method‏ getRoot() או שימוש בתחביר המאפיינים של Kotlin.
  3. מעבירים את תצוגת הבסיס אל 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

כדי להגדיר מופע של מחלקת הקישור לשימוש עם מקטע, מבצעים את השלבים הבאים בשיטה onCreateView() של המקטע:

  1. מפעילים את ה-method הסטטית inflate() שכלולה במחלקת הקישור שנוצרה. כך נוצר מופע של מחלקת הקישור שבו הפרגמנט יכול להשתמש.
  2. מקבלים הפניה לתצוגת הבסיס על ידי קריאה ל-method‏ getRoot() או שימוש בתחביר המאפיינים של Kotlin.
  3. מחזירים את תצוגת הבסיס מהשיטה onCreateView() כדי להפוך אותה ל-Active View במסך.

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" />

דוגמה נוספת: נניח שיש לכם שני פריסות, אחת שמכילה BottomNavigationView ואחת שמכילה NavigationRailView. שתי המחלקות מרחיבות את NavigationBarView, שמכילה את רוב פרטי ההטמעה. אם לא צריך לדעת בקוד בדיוק איזו מחלקת משנה נמצאת בפריסה הנוכחית, אפשר להשתמש ב-tools:viewBindingType כדי להגדיר את הסוג שנוצר ל-NavigationBarView בשתי הפריסות:

# 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 בגלל מזהה תצוגה לא חוקי. בנוסף, כשתצוגה קיימת רק בחלק מההגדרות של פריסה, השדה שמכיל את ההפניה שלה במחלקת הקישור מסומן ב-@Nullable.
  • מניעת שגיאות הקלדה: השדות בכל מחלקת קישור הם מסוגים שתואמים לתצוגות שאליהן הם מפנים בקובץ ה-XML. זה אומר שאין סיכון לחריגה בהמרה של מחלקה.

ההבדלים האלה גורמים לכך שחוסר התאמה בין הפריסה לקוד יגרום לכשל ב-build בזמן הקימפול ולא בזמן הריצה.

השוואה עם קישור נתונים

גם View binding וגם data binding יוצרים מחלקות קישור שאפשר להשתמש בהן כדי להפנות ישירות לתצוגות. עם זאת, קישור תצוגה מיועד לטפל בתרחישים פשוטים יותר, והוא מספק את היתרונות הבאים על פני קישור נתונים:

  • קימפול מהיר יותר: קישור תצוגה לא דורש עיבוד אנוטציות, ולכן משך הזמן לקימפול קצר יותר.
  • קלות השימוש: כדי להשתמש בכריכת תצוגה, לא צריך לתייג באופן מיוחד קובצי פריסה ב-XML, ולכן קל יותר להטמיע אותה באפליקציות. אחרי שמפעילים את כריכת התצוגה במודול, היא חלה באופן אוטומטי על כל הפריסות של המודול.

מצד שני, לכריכת תצוגה יש את המגבלות הבאות בהשוואה לכריכת נתונים:

בגלל השיקולים האלה, במקרים מסוימים כדאי להשתמש גם בקישור תצוגה וגם בקישור נתונים בפרויקט. אפשר להשתמש בקישור נתונים בפריסות שדורשות תכונות מתקדמות, ולהשתמש בקישור תצוגה בפריסות שלא דורשות תכונות כאלה.

מקורות מידע נוספים

למידע נוסף על קישור תצוגה, אפשר לעיין במקורות המידע הבאים:

בלוגים

סרטונים