Wiązanie widoków Jest częścią Android Jetpack.
Wiązanie widoków to funkcja, która ułatwia pisanie kodu wchodzącego w interakcje z widokami. Po włączeniu wiązania widoku w module generuje ono klasę wiązania dla każdego pliku układu XML obecnego w tym module. Instancja klasy wiązania zawiera bezpośrednie odwołania do wszystkich widoków, które mają identyfikator w odpowiednim układzie.
W większości przypadków wiązanie widoków zastępuje findViewById.
Konfiguracja
Wiązanie widoków jest włączane na poziomie poszczególnych modułów. Aby włączyć wiązanie widoku w module, ustaw opcję kompilacji viewBinding na true w pliku build.gradle na poziomie modułu, jak w tym przykładzie:
Dynamiczny
android { ... buildFeatures { viewBinding true } }
Kotlin
android { ... buildFeatures { viewBinding = true } }
Jeśli chcesz, aby plik układu był ignorowany podczas generowania klas wiązania, dodaj atrybut tools:viewBindingIgnore="true" do widoku głównego tego pliku układu:
<LinearLayout
...
tools:viewBindingIgnore="true" >
...
</LinearLayout>
Wykorzystanie
Jeśli w module jest włączone wiązanie widoku, dla każdego pliku układu XML, który zawiera moduł, generowana jest klasa wiązania. Każda klasa wiązania zawiera odwołania do widoku głównego i wszystkich widoków, które mają identyfikator. Nazwa klasy wiązania jest generowana przez przekonwertowanie nazwy pliku XML na format PascalCase i dodanie na końcu słowa „Binding”.
Rozważmy na przykład plik układu o nazwie result_profile.xml, który zawiera te elementy:
<LinearLayout ... >
<TextView android:id="@+id/name" />
<ImageView android:cropToPadding="true" />
<Button android:id="@+id/button"
android:background="@drawable/rounded_button" />
</LinearLayout>
Wygenerowana klasa wiązania ma nazwę ResultProfileBinding. Ta klasa ma 2 pola: TextView o nazwie name i Button o nazwie button. Element ImageView w układzie nie ma identyfikatora, więc nie ma do niego odwołania w klasie wiązania.
Każda klasa wiązania zawiera też metodę getRoot(), która zapewnia bezpośrednie odwołanie do widoku głównego odpowiedniego pliku układu. W tym przykładzie metoda getRoot() w klasie ResultProfileBinding zwraca widok główny LinearLayout.
W sekcjach poniżej pokazujemy, jak używać wygenerowanych klas wiązania w aktywnościach i fragmentach.
Używanie powiązania widoku w aktywnościach
Aby skonfigurować instancję klasy wiązania do użycia z aktywnością, wykonaj te czynności w metodzie onCreate() aktywności:
- Wywołaj statyczną metodę
inflate()zawartą w wygenerowanej klasie powiązania. Spowoduje to utworzenie instancji klasy powiązania, której będzie używać aktywność. - Uzyskaj odwołanie do widoku głównego, wywołując metodę
getRoot()lub używając składni właściwości Kotlin. - Przekaż widok główny do
setContentView(), aby stał się aktywnym widokiem na ekranie.
Te kroki są przedstawione w tym przykładzie:
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);
}
Możesz teraz używać instancji klasy wiązania, aby odwoływać się do dowolnego widoku:
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()
});
Używanie powiązania widoku we fragmentach
Aby skonfigurować instancję klasy wiązania do użycia z fragmentem, wykonaj te czynności w metodzie onCreateView() fragmentu:
- Wywołaj statyczną metodę
inflate()zawartą w wygenerowanej klasie powiązania. Spowoduje to utworzenie instancji klasy wiązania, której będzie używać fragment. - Uzyskaj odwołanie do widoku głównego, wywołując metodę
getRoot()lub używając składni właściwości Kotlin. - Zwróć widok główny z metody
onCreateView(), aby stał się aktywnym widokiem na ekranie.
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;
}
Możesz teraz używać instancji klasy wiązania, aby odwoływać się do dowolnego widoku:
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()
});
Podawanie wskazówek dotyczących różnych konfiguracji
Gdy deklarujesz widoki w wielu konfiguracjach, czasami warto użyć innego typu widoku w zależności od konkretnego układu. Poniższy fragment kodu pokazuje przykład:
# in res/layout/example.xml
<TextView android:id="@+id/user_bio" />
# in res/layout-land/example.xml
<EditText android:id="@+id/user_bio" />
W tym przypadku można oczekiwać, że wygenerowana klasa będzie udostępniać pole userBio typu TextView, ponieważ TextView jest wspólną klasą bazową. Ze względu na ograniczenia techniczne generator kodu powiązania widoku nie może tego określić i generuje pole View. Wymaga to późniejszego rzutowania pola za pomocą funkcji binding.userBio as TextView.
Aby obejść to ograniczenie, powiązanie widoku obsługuje atrybut tools:viewBindingType, który pozwala poinformować kompilator, jakiego typu ma używać w wygenerowanym kodzie.
W poprzednim przykładzie możesz użyć tego atrybutu, aby kompilator wygenerował pole jako 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" />
W innym przykładzie załóżmy, że masz 2 układy: jeden zawiera element BottomNavigationView, a drugi – NavigationRailView. Obie klasy rozszerzają klasę NavigationBarView, która zawiera większość szczegółów implementacji. Jeśli Twój kod nie musi dokładnie wiedzieć, która podklasa jest obecna w bieżącym układzie, możesz użyć tools:viewBindingType, aby ustawić wygenerowany typ na NavigationBarView w obu układach:
# 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" />
Podczas generowania kodu funkcja View binding nie może zweryfikować wartości tego atrybutu. Aby uniknąć błędów czasu kompilowania i błędów środowiska wykonawczego, wartość musi spełniać te warunki:
- Wartość musi być klasą dziedziczącą z
android.view.View. Wartość musi być klasą nadrzędną tagu, na którym jest umieszczona. Na przykład te wartości nie będą działać:
<TextView tools:viewBindingType="ImageView" /> <!-- ImageView is not related to TextView. --> <TextView tools:viewBindingType="Button" /> <!-- Button is not a superclass of TextView. -->Typ końcowy musi być spójny we wszystkich konfiguracjach.
Różnice w porównaniu z findViewById
Wiązanie widoku ma istotne zalety w porównaniu z używaniem metody findViewById:
- Bezpieczeństwo wartości null: ponieważ wiązanie widoków tworzy bezpośrednie odwołania do widoków, nie ma ryzyka wystąpienia wyjątku wskaźnika o wartości null z powodu nieprawidłowego identyfikatora widoku.
Dodatkowo, gdy widok jest obecny tylko w niektórych konfiguracjach układu, pole zawierające jego odwołanie w klasie wiązania jest oznaczone adnotacją
@Nullable. - Zabezpieczenia wpisywania: pola w każdej klasie powiązania mają typy odpowiadające widokom, do których odwołują się w pliku XML. Oznacza to, że nie ma ryzyka wystąpienia wyjątku rzutowania klasy.
Te różnice oznaczają, że niezgodności między układem a kodem powodują niepowodzenie kompilacji w czasie kompilowania, a nie w czasie działania.
Porównanie z wiązaniem danych
Zarówno wiązanie widoków, jak i wiązanie danych generują klasy wiązania, których możesz używać do bezpośredniego odwoływania się do widoków. Wiązanie widoków jest jednak przeznaczone do obsługi prostszych przypadków użycia i zapewnia następujące korzyści w porównaniu z wiązaniem danych:
- Szybsza kompilacja: wiązanie widoku nie wymaga przetwarzania adnotacji, więc czas kompilowania jest krótszy.
- Łatwość użycia: wiązanie widoków nie wymaga specjalnie oznaczonych tagami plików układu XML, dzięki czemu można je szybciej wdrożyć w aplikacjach. Gdy włączysz wiązanie widoków w module, zostanie ono automatycznie zastosowane do wszystkich układów tego modułu.
Z drugiej strony wiązanie widoku ma te ograniczenia w porównaniu z wiązaniem danych:
- Wiązanie widoków nie obsługuje zmiennych ani wyrażeń układu, więc nie można go używać do deklarowania dynamicznej zawartości interfejsu bezpośrednio z plików układu XML.
- Wiązanie widoku nie obsługuje dwukierunkowego wiązania danych.
Z tego powodu w niektórych przypadkach najlepiej jest używać w projekcie zarówno wiązania widoku, jak i wiązania danych. Możesz używać wiązania danych w układach, które wymagają funkcji zaawansowanych, a wiązania widoków w układach, które ich nie wymagają.
Dodatkowe materiały
Więcej informacji o powiązaniu widoku znajdziesz w tych materiałach:
Blogi
Filmy
Polecane dla Ciebie
- Uwaga: tekst linku jest wyświetlany, gdy język JavaScript jest wyłączony.
- Migracja z syntetyków Kotlina do wiązania widoków Jetpack
- Układy i wyrażenia wiążące
- Architektura aplikacji: warstwa interfejsu – Pierwsze kroki – Deweloperzy aplikacji na Androida