Vinculação de visualizações   Parte do Android Jetpack.

A vinculação de visualizações facilita a programação de códigos que interagem com visualizações. Quando a vinculação de visualizações é ativada em um módulo, ela gera uma classe de vinculação para cada arquivo de layout XML presente nesse módulo. Uma instância de uma classe de vinculação contém referências diretas a todas as visualizações que têm um ID no layout correspondente.

Na maioria dos casos, a vinculação de visualizações substitui findViewById.

Configurar

A vinculação de visualizações é ativada em um módulo por base de módulo. Para ativar a vinculação de visualizações em um módulo, defina a opção de build viewBinding como true no arquivo build.gradle no nível do módulo, conforme mostrado no exemplo abaixo:

Groovy

android {
    ...
    buildFeatures {
        viewBinding true
    }
}

Kotlin

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

Se você quer que um arquivo de layout seja ignorado ao gerar classes de vinculação, adicione o atributo tools:viewBindingIgnore="true" à visualização raiz do arquivo de layout:

<LinearLayout
        ...
        tools:viewBindingIgnore="true" >
    ...
</LinearLayout>

Uso

Se a vinculação de visualizações estiver ativada para um módulo, uma classe de vinculação será gerada para cada arquivo de layout XML que ele contiver. Cada classe de vinculação contém referências à visualização raiz e a todas as visualizações que têm um ID. O nome da classe de vinculação é gerado pela conversão do nome do arquivo XML em letras minúsculas concatenadas e da adição da palavra "Binding" ao final.

Por exemplo, considere um arquivo de layout chamado result_profile.xml que contém o seguinte:

<LinearLayout ... >
    <TextView android:id="@+id/name" />
    <ImageView android:cropToPadding="true" />
    <Button android:id="@+id/button"
        android:background="@drawable/rounded_button" />
</LinearLayout>

A classe de vinculação gerada terá o nome ResultProfileBinding. Essa classe tem dois campos: um TextView chamado name e um Button chamado button. A ImageView no layout não tem ID. Portanto, não há referência a ela na classe de vinculação.

Cada classe de vinculação também inclui um método getRoot(), que disponibiliza uma referência direta para a visualização raiz do arquivo de layout correspondente. Neste exemplo, o método getRoot() na classe ResultProfileBinding retorna a visualização raiz LinearLayout.

As seções a seguir demonstram o uso de classes de vinculação geradas em atividades e fragmentos.

Usar a vinculação de visualizações em atividades

Para configurar uma instância da classe de vinculação para uso com uma atividade, siga as seguintes etapas no método onCreate() da atividade:

  1. Chame o método estático inflate() incluído na classe de vinculação gerada. Isso cria uma instância da classe de vinculação para a atividade usar.
  2. Receba uma referência para a visualização raiz chamando o método getRoot() ou usando a sintaxe de propriedade do Kotlin (link em inglês).
  3. Transmita a visualização raiz para setContentView() para torná-la a visualização ativa na tela.

Essas etapas são mostradas no exemplo a seguir:

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);
}

Agora, você pode usar a instância da classe de vinculação para referenciar qualquer uma das visualizações:

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()
});

Usar a vinculação de visualizações em fragmentos

Para configurar uma instância da classe de vinculação a ser usada com um fragmento, siga as etapas a seguir no método onCreateView() do fragmento:

  1. Chame o método estático inflate() incluído na classe de vinculação gerada. Isso cria uma instância da classe de vinculação para o uso do fragmento.
  2. Receba uma referência para a visualização raiz chamando o método getRoot() ou usando a sintaxe de propriedade do Kotlin (link em inglês).
  3. Retorne a visualização raiz do método onCreateView() para torná-la a visualização ativa na tela.

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;
}

Agora, você pode usar a instância da classe de vinculação para referenciar qualquer uma das visualizações:

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()
});

Dar dicas para diferentes configurações

Ao declarar visualizações em várias configurações, às vezes faz sentido usar um tipo de visualização diferente, dependendo do layout específico. O snippet de código abaixo mostra um exemplo disso:

# in res/layout/example.xml

<TextView android:id="@+id/user_bio" />

# in res/layout-land/example.xml

<EditText android:id="@+id/user_bio" />

Nesse caso, a classe gerada pode expor um campo userBio do tipo TextView, porque TextView é a classe base comum. Devido a limitações técnicas, o gerador de código de vinculação de visualização não pode determinar isso e gera um campo View. Isso requer o casting do campo mais tarde com binding.userBio as TextView.

Para contornar essa limitação, a vinculação de visualização oferece suporte a um atributo tools:viewBindingType, permitindo que você informe ao compilador o tipo a ser usado no código gerado. No exemplo anterior, é possível usar esse atributo para fazer com que o compilador gere o campo como um 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" />

Em outro exemplo, suponha que você tenha dois layouts, um que contém um BottomNavigationView e outro que contém um NavigationRailView. Ambas as classes estendem NavigationBarView, que contém a maioria dos detalhes de implementação. Se o código não precisar saber exatamente qual subclasse está presente no layout atual, use tools:viewBindingType para definir o tipo gerado como NavigationBarView nos dois layouts:

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

A vinculação de visualização não pode validar o valor desse atributo ao gerar o código. Para evitar erros de tempo de compilação e de execução, o valor precisa atender às seguintes condições:

  • O valor precisa ser uma classe herdada de android.view.View.

  • O valor precisa ser uma superclasse da tag em que ele está colocado. Por exemplo, os seguintes valores não funcionam:

      <TextView tools:viewBindingType="ImageView" /> <!-- ImageView is not related to TextView. -->
  <TextView tools:viewBindingType="Button" /> <!-- Button is not a superclass of TextView. -->

  • O tipo final precisa ser resolvido de forma consistente em todas as configurações.

Diferenças de findViewById

A vinculação de visualizações tem vantagens importantes em relação ao uso de findViewById:

  • Segurança de nulos:como a vinculação de visualizações cria referências diretas a visualizações, não há risco de uma exceção de ponteiro nulo devido a um ID de visualização inválido. Além disso, quando uma visualização está presente apenas em algumas configurações de um layout, o campo que contém a referência dela na classe de vinculação é marcado com @Nullable.
  • Segurança de tipo:os campos em cada classe de vinculação têm tipos correspondentes às visualizações referenciadas no arquivo XML. Isso significa que não há risco de uma exceção de transmissão de classe.

Essas diferenças significam que as incompatibilidades entre o layout e o código resultam em uma falha no momento da compilação, não no momento da execução.

Comparação com a vinculação de dados

A vinculação de visualizações e a vinculação de dados geram classes de vinculação que podem ser usadas para referenciar visualizações diretamente. No entanto, a vinculação de visualizações processa casos de uso mais simples e oferece os seguintes benefícios em relação à vinculação de dados:

  • Compilação mais rápida:a vinculação de visualizações não exige processamento de anotações, por isso os tempos de compilação são mais rápidos.
  • Facilidade de uso:a vinculação de visualizações não requer arquivos de layout XML com tags especiais. Portanto, é mais rápido adotá-la nos apps. Depois de ativar a vinculação de visualizações em um módulo, ela será aplicada automaticamente a todos os layouts desse módulo.

Por outro lado, a vinculação de visualizações tem as seguintes limitações em comparação com a vinculação de dados:

Devido a essas limitações, em alguns casos é melhor usar tanto a vinculação de visualizações quanto a vinculação de dados em um projeto. Você pode usar a vinculação de dados em layouts que exigem recursos avançados e a vinculação de visualizações em layouts que não exigem.

Outros recursos

Para saber mais sobre a vinculação de visualizações, consulte os seguintes recursos:

Blogs

Vídeos