Introduzidos no Android 3.0, os carregadores facilitam o carregamento assíncrono de dados em uma atividade ou fragmento. Os carregadores têm as seguintes características:
Há várias classes e interfaces que podem ser envolvidas no uso de carregadores em um aplicativo. Elas são resumidas nesta tabela:
| Classe/Interface | Descrição |
|---|---|
| {@link android.app.LoaderManager} | Uma classe abstrata associada a {@link android.app.Activity} ou
{@link android.app.Fragment} para gerenciar uma ou mais instâncias de {@link
android.content.Loader}. Isto ajuda um aplicativo a gerenciar
operações executadas por longos períodos juntamente com o ciclo de vida de {@link android.app.Activity}
ou {@link android.app.Fragment}; o uso mais comum disto é com
{@link android.content.CursorLoader}. No entanto, os aplicativos têm a liberdade de criar
os próprios carregadores para outros tipos de dados.
Há apenas um {@link android.app.LoaderManager} por atividade ou fragmento. No entanto, um {@link android.app.LoaderManager} pode ter vários carregadores. |
| {@link android.app.LoaderManager.LoaderCallbacks} | Uma interface de retorno de chamada para um cliente interagir com {@link android.app.LoaderManager}. Por exemplo, usa-se o método de retorno de chamada {@link android.app.LoaderManager.LoaderCallbacks#onCreateLoader onCreateLoader()} para criar um novo carregador. |
| {@link android.content.Loader} | Uma classe abstrata que realiza carregamento assíncrono de dados. Esta é a classe de base de um carregador. Geralmente, você usaria {@link android.content.CursorLoader}, mas é possível implementar subclasse própria. Enquanto os carregadores estiverem ativos, devem monitorar a origem dos dados e fornecer novos resultados quando o conteúdo for alterado. |
| {@link android.content.AsyncTaskLoader} | Um carregador abstrato que fornece uma {@link android.os.AsyncTask} para realizar o trabalho. |
| {@link android.content.CursorLoader} | Uma subclasse de {@link android.content.AsyncTaskLoader} que consulta {@link android.content.ContentResolver} e retorna um {@link android.database.Cursor}. Esta classe implementa o protocolo {@link android.content.Loader} de forma padrão para cursores de consulta, compilando em {@link android.content.AsyncTaskLoader} para realizar a consulta de cursor em um encadeamento de segundo plano para que a IU do aplicativo não seja bloqueada. Usar este carregador é a melhor maneira de carregar dados de forma assíncrona a partir de um {@link android.content.ContentProvider}, em vez de realizar uma consulta gerenciada pelas APIs da atividade ou do fragmento. |
As classes e interfaces na tabela acima são os componentes essenciais que você usará para implementar um carregador no aplicativo. Você não precisará de todos eles para cada carregador criado, mas sempre precisará de uma referência a {@link android.app.LoaderManager} para inicializar um carregador e uma implementação de uma classe {@link android.content.Loader}, como {@link android.content.CursorLoader}. As seguintes seções mostram como usar essas classes e interfaces em um aplicativo.
Esta seção descreve como usar os carregadores em um aplicativo do Android. Um aplicativo que usa os carregadores, geralmente, inclui o seguinte:
O {@link android.app.LoaderManager} gerencia uma ou mais instâncias de {@link android.content.Loader} dentro de uma {@link android.app.Activity} ou um {@link android.app.Fragment}. Há apenas um {@link android.app.LoaderManager} por atividade ou fragmento.
Geralmente, inicializa-se um {@link android.content.Loader} dentro do método {@link android.app.Activity#onCreate onCreate()} da atividade, ou dentro do método {@link android.app.Fragment#onActivityCreated onActivityCreated()} do fragmento. Faça isso da seguinte maneira:
// Prepare the loader. Either re-connect with an existing one, // or start a new one. getLoaderManager().initLoader(0, null, this);
O método {@link android.app.LoaderManager#initLoader initLoader()} recebe os seguintes parâmetros:
null neste exemplo).A chamada de {@link android.app.LoaderManager#initLoader initLoader()} garante que o carregador foi inicializado e que está ativo. Ela possui dois possíveis resultados:
Em qualquer um dos casos, a implementação de {@link android.app.LoaderManager.LoaderCallbacks} fornecida é associada ao carregador e será chamada quando o estado do carregador mudar. Se, no momento desta chamada, o autor dela estiver no estado inicializado e o carregador solicitado já existir e tiver gerado seus dados, o sistema chamará {@link android.app.LoaderManager.LoaderCallbacks#onLoadFinished onLoadFinished()} imediatamente (durante{@link android.app.LoaderManager#initLoader initLoader()}), então prepare-se para tais situações. Consulte onLoadFinished para obter mais informações sobre este retorno de chamada
Observe que o método {@link android.app.LoaderManager#initLoader initLoader()} retorna o {@link android.content.Loader} que é criado, mas você não precisará capturar uma referência para ele. O {@link android.app.LoaderManager} gerencia a vida do carregador automaticamente. O {@link android.app.LoaderManager} inicia e interrompe o carregamento quando necessário, além de manter o estado do carregador e do conteúdo associado. À medida que isso ocorre, você raramente interage com os carregadores diretamente (para ver um exemplo de métodos para aprimorar o comportamento de um carregador, consulte o exemplo de LoaderThrottle). Geralmente, usam-se os métodos {@link android.app.LoaderManager.LoaderCallbacks} para intervir no processo de carregamento quando determinados eventos ocorrem. Para obter mais informações sobre este assunto, consulte Uso dos retornos de chamada de LoaderManager.
Ao usar {@link android.app.LoaderManager#initLoader initLoader()}, como mostrado acima, ele usará um carregador existente com o ID especificado, se houver um. Caso contrário, um carregador será criado. No entanto, às vezes, você quer descartar os dados antigos e começar do início.
Para descartar os dados antigos, use {@link android.app.LoaderManager#restartLoader restartLoader()}. Por exemplo, esta implementação de {@link android.widget.SearchView.OnQueryTextListener} reinicia o carregador quando a consulta do usuário é alterada. O carregador precisa ser reiniciado para que possa usar o filtro de busca revisado para realizar uma nova consulta:
public boolean onQueryTextChanged(String newText) {
// Called when the action bar search text has changed. Update
// the search filter, and restart the loader to do a new query
// with this filter.
mCurFilter = !TextUtils.isEmpty(newText) ? newText : null;
getLoaderManager().restartLoader(0, null, this);
return true;
}
{@link android.app.LoaderManager.LoaderCallbacks} é uma interface de retorno de chamada que permite que um cliente interaja com o {@link android.app.LoaderManager}.
Carregadores, em determinado {@link android.content.CursorLoader}, devem reter os dados após serem interrompidos. Isto permite que os aplicativos mantenham os dados dos métodos {@link android.app.Activity#onStop onStop()} e {@link android.app.Activity#onStart onStart()} do fragmento ou da atividade para que, quando os usuários voltarem a um aplicativo, não tenham que esperar o recarregamento dos dados. Você usa os métodos {@link android.app.LoaderManager.LoaderCallbacks} para saber quando deve criar um novo carregador, e para dizer ao aplicativo quando deve interromper o uso dos dados de um carregador.
{@link android.app.LoaderManager.LoaderCallbacks} inclui esses métodos:
Esses métodos são descritos com mais informações nas seguintes seções.
Ao tentar acessar um carregador (por exemplo, por meio de {@link android.app.LoaderManager#initLoader initLoader()}), ele verifica se o carregador especificado pelo ID existe. Se não existir, ele ativa o método {@link android.app.LoaderManager.LoaderCallbacks} {@link android.app.LoaderManager.LoaderCallbacks#onCreateLoader onCreateLoader()}. É aqui que você pode criar um novo carregador. Geralmente, será um {@link android.content.CursorLoader}, mas é possível implementar a própria subclasse de {@link android.content.Loader}.
Nesse exemplo, o método de retorno de chamada de {@link android.app.LoaderManager.LoaderCallbacks#onCreateLoader onCreateLoader()} cria um {@link android.content.CursorLoader}. Você deve compilar {@link android.content.CursorLoader} usando o método construtor, que exige um conjunto completo de informações necessárias para realizar uma consulta ao {@link android.content.ContentProvider}. Especificamente, ele precisa de:
null retornará todas as colunas, o que é ineficiente. null retornará todas as linhas da URI em questão. null
usará a ordem de classificação padrão, que pode ser desordenada.Por exemplo:
// If non-null, this is the current filter the user has provided.
String mCurFilter;
...
public Loader<Cursor> onCreateLoader(int id, Bundle args) {
// This is called when a new Loader needs to be created. This
// sample only has one Loader, so we don't care about the ID.
// First, pick the base URI to use depending on whether we are
// currently filtering.
Uri baseUri;
if (mCurFilter != null) {
baseUri = Uri.withAppendedPath(Contacts.CONTENT_FILTER_URI,
Uri.encode(mCurFilter));
} else {
baseUri = Contacts.CONTENT_URI;
}
// Now create and return a CursorLoader that will take care of
// creating a Cursor for the data being displayed.
String select = "((" + Contacts.DISPLAY_NAME + " NOTNULL) AND ("
+ Contacts.HAS_PHONE_NUMBER + "=1) AND ("
+ Contacts.DISPLAY_NAME + " != '' ))";
return new CursorLoader(getActivity(), baseUri,
CONTACTS_SUMMARY_PROJECTION, select, null,
Contacts.DISPLAY_NAME + " COLLATE LOCALIZED ASC");
}
Este método é chamado quando um carregador anteriormente criado terminar o seu carregamento. Este método certamente será chamado antes da liberação dos últimos dados que forem fornecidos por este carregador. Neste ponto, você deve remover todo o uso dos dados antigos (já que serão liberados em breve), mas não deve fazer a liberação dos dados, já que pertencem ao carregador e ele lidará com isso.
O carregador liberará os dados quando souber que o aplicativo não está mais usando-os. Por exemplo, se os dados forem um cursor de um {@link android.content.CursorLoader}, você não deve chamar {@link android.database.Cursor#close close()} por conta própria. Se o cursor estiver sendo colocado em um {@link android.widget.CursorAdapter}, você deve usar o método {@link android.widget.SimpleCursorAdapter#swapCursor swapCursor()} para que o antigo {@link android.database.Cursor} não seja fechado. Por exemplo:
// This is the Adapter being used to display the list's data.
SimpleCursorAdapter mAdapter; ... public void onLoadFinished(Loader<Cursor> loader, Cursor data) { // Swap the new cursor in. (The framework will take care of closing the // old cursor once we return.) mAdapter.swapCursor(data); }
Este método é chamado quando um carregador anteriormente criado é reiniciado, tornando os dados indisponíveis. Este retorno de chamada permite que você descubra quando os dados estão prestes a serem liberados para que seja possível remover a referência a eles.
Esta implementação chama
{@link android.widget.SimpleCursorAdapter#swapCursor swapCursor()}
com um valor de null:
// This is the Adapter being used to display the list's data.
SimpleCursorAdapter mAdapter;
...
public void onLoaderReset(Loader<Cursor> loader) {
// This is called when the last Cursor provided to onLoadFinished()
// above is about to be closed. We need to make sure we are no
// longer using it.
mAdapter.swapCursor(null);
}
Como exemplo, a seguir há uma implementação completa de um {@link android.app.Fragment} que exibe uma {@link android.widget.ListView} contendo os resultados de uma consulta aos provedores de conteúdo de contatos. Ela usa um {@link android.content.CursorLoader} para gerenciar a consulta no provedor.
Para um aplicativo acessar os contatos de um usuário, como neste exemplo, o manifesto deverá incluir a permissão {@link android.Manifest.permission#READ_CONTACTS READ_CONTACTS}.
public static class CursorLoaderListFragment extends ListFragment
implements OnQueryTextListener, LoaderManager.LoaderCallbacks<Cursor> {
// This is the Adapter being used to display the list's data.
SimpleCursorAdapter mAdapter;
// If non-null, this is the current filter the user has provided.
String mCurFilter;
@Override public void onActivityCreated(Bundle savedInstanceState) {
super.onActivityCreated(savedInstanceState);
// Give some text to display if there is no data. In a real
// application this would come from a resource.
setEmptyText("No phone numbers");
// We have a menu item to show in action bar.
setHasOptionsMenu(true);
// Create an empty adapter we will use to display the loaded data.
mAdapter = new SimpleCursorAdapter(getActivity(),
android.R.layout.simple_list_item_2, null,
new String[] { Contacts.DISPLAY_NAME, Contacts.CONTACT_STATUS },
new int[] { android.R.id.text1, android.R.id.text2 }, 0);
setListAdapter(mAdapter);
// Prepare the loader. Either re-connect with an existing one,
// or start a new one.
getLoaderManager().initLoader(0, null, this);
}
@Override public void onCreateOptionsMenu(Menu menu, MenuInflater inflater) {
// Place an action bar item for searching.
MenuItem item = menu.add("Search");
item.setIcon(android.R.drawable.ic_menu_search);
item.setShowAsAction(MenuItem.SHOW_AS_ACTION_IF_ROOM);
SearchView sv = new SearchView(getActivity());
sv.setOnQueryTextListener(this);
item.setActionView(sv);
}
public boolean onQueryTextChange(String newText) {
// Called when the action bar search text has changed. Update
// the search filter, and restart the loader to do a new query
// with this filter.
mCurFilter = !TextUtils.isEmpty(newText) ? newText : null;
getLoaderManager().restartLoader(0, null, this);
return true;
}
@Override public boolean onQueryTextSubmit(String query) {
// Don't care about this.
return true;
}
@Override public void onListItemClick(ListView l, View v, int position, long id) {
// Insert desired behavior here.
Log.i("FragmentComplexList", "Item clicked: " + id);
}
// These are the Contacts rows that we will retrieve.
static final String[] CONTACTS_SUMMARY_PROJECTION = new String[] {
Contacts._ID,
Contacts.DISPLAY_NAME,
Contacts.CONTACT_STATUS,
Contacts.CONTACT_PRESENCE,
Contacts.PHOTO_ID,
Contacts.LOOKUP_KEY,
};
public Loader<Cursor> onCreateLoader(int id, Bundle args) {
// This is called when a new Loader needs to be created. This
// sample only has one Loader, so we don't care about the ID.
// First, pick the base URI to use depending on whether we are
// currently filtering.
Uri baseUri;
if (mCurFilter != null) {
baseUri = Uri.withAppendedPath(Contacts.CONTENT_FILTER_URI,
Uri.encode(mCurFilter));
} else {
baseUri = Contacts.CONTENT_URI;
}
// Now create and return a CursorLoader that will take care of
// creating a Cursor for the data being displayed.
String select = "((" + Contacts.DISPLAY_NAME + " NOTNULL) AND ("
+ Contacts.HAS_PHONE_NUMBER + "=1) AND ("
+ Contacts.DISPLAY_NAME + " != '' ))";
return new CursorLoader(getActivity(), baseUri,
CONTACTS_SUMMARY_PROJECTION, select, null,
Contacts.DISPLAY_NAME + " COLLATE LOCALIZED ASC");
}
public void onLoadFinished(Loader<Cursor> loader, Cursor data) {
// Swap the new cursor in. (The framework will take care of closing the
// old cursor once we return.)
mAdapter.swapCursor(data);
}
public void onLoaderReset(Loader<Cursor> loader) {
// This is called when the last Cursor provided to onLoadFinished()
// above is about to be closed. We need to make sure we are no
// longer using it.
mAdapter.swapCursor(null);
}
}
Há alguns exemplos variados na ApiDemos que ilustra o uso de carregadores:
Para obter mais informações sobre o download e a instalação de exemplos de SDK, consulte Obtenção dos exemplos.