加载器

加载器自 Android 9 (API 级别 28) 起已弃用。处理数据加载同时管理 Activity 和 Fragment 生命周期时，推荐的方法是结合使用 ViewModel 对象和 LiveData。ViewModel 像加载器一样可以在配置更改时存活，但样板代码更少。LiveData 提供了一种生命周期感知的数据加载方式，您可以在多个 ViewModel 中重复使用。您还可以使用 MediatorLiveData 组合 LiveData。任何可观测查询，例如来自 Room 数据库的查询，都可以用于观测数据的更改。

ViewModel 和 LiveData 也适用于无法访问 LoaderManager 的情况，例如在 Service 中。两者结合使用提供了一种简便方法来访问您的应用所需的数据，而无需处理 UI 生命周期。要了解有关 LiveData 的更多信息，请参阅 LiveData 概览。要了解有关 ViewModel 的更多信息，请参阅 ViewModel 概览。

Loader API 允许您从内容提供器或其他数据源加载数据，以在 FragmentActivity 或 Fragment 中显示。

如果没有加载器，您可能会遇到以下一些问题：

  • 如果您直接在 activity 或 fragment 中获取数据，您的用户可能会因为从 UI 线程执行潜在的慢查询而遇到响应迟缓的问题。
  • 如果您从另一个线程获取数据（例如使用 AsyncTask），那么您将负责通过各种 activity 或 fragment 生命周期事件（例如 onDestroy() 和配置更改）来管理该线程和 UI 线程。

加载器解决了这些问题并带来了其他好处：

  • 加载器在单独的线程上运行，以防止 UI 缓慢或无响应。
  • 加载器通过在事件发生时提供回调方法来简化线程管理。
  • 加载器在配置更改后仍会保留并缓存结果，以防止重复查询。
  • 加载器可以实现一个观察者来监控底层数据源中的变化。例如，CursorLoader 会自动注册一个 ContentObserver，以便在数据更改时触发重新加载。

Loader API 摘要

在应用中使用加载器时，可能会涉及多个类和接口。它们总结在下表中：

类/接口 描述
LoaderManager 一个抽象类，与 FragmentActivity 或 Fragment 相关联，用于管理一个或多个 Loader 实例。每个 activity 或 fragment 只有一个 LoaderManager，但一个 LoaderManager 可以管理多个加载器。

要获取 LoaderManager，请从 activity 或 fragment 中调用 getSupportLoaderManager()。

要开始从加载器加载数据，请调用 initLoader() 或 restartLoader()。系统会自动确定具有相同整数 ID 的加载器是否已存在，然后创建新加载器或重用现有加载器。
LoaderManager.LoaderCallbacks 此接口包含在加载器事件发生时调用的回调方法。该接口定义了三个回调方法：
  • onCreateLoader(int, Bundle)：当系统需要创建新加载器时调用。在您的代码中，创建一个 Loader 对象并将其返回给系统。
  • onLoadFinished(Loader<D>, D)：当加载器完成数据加载时调用。您通常会在代码中向用户显示数据。
  • onLoaderReset(Loader<D>)：当先前创建的加载器正在重置时调用，例如当您调用 destroyLoader(int) 或 activity 或 fragment 被销毁时，使其数据不可用。在您的代码中，移除对加载器数据的任何引用。
您的 activity 或 fragment 通常会实现此接口，并在您调用 initLoader() 或 restartLoader() 时注册。
Loader 加载器执行数据加载。此类是抽象类，作为所有加载器的基类。您可以直接子类化 Loader，或使用以下内置子类之一来简化实现：

以下部分将向您展示如何在应用中使用这些类和接口。

在应用中使用加载器

本节介绍如何在 Android 应用中使用加载器。使用加载器的应用通常包括以下内容：

启动加载器

LoaderManager 在 FragmentActivity 或 Fragment 中管理一个或多个 Loader 实例。每个 activity 或 fragment 只有一个 LoaderManager。

您通常在 activity 的 onCreate() 方法或 fragment 的 onCreate() 方法中初始化 Loader。操作如下：

Kotlin

supportLoaderManager.initLoader(0, null, this)

Java

// Prepare the loader.  Either re-connect with an existing one,
// or start a new one.
getSupportLoaderManager().initLoader(0, null, this);

initLoader() 方法接受以下参数：

  • 标识加载器的唯一 ID。在此示例中，ID 为 0。
  • 构造时提供给加载器的可选参数（本例中为 null）。
  • 一个 LoaderManager.LoaderCallbacks 实现，LoaderManager 会调用它来报告加载器事件。在本例中，本地类实现了 LoaderManager.LoaderCallbacks 接口，因此它传入了自身的引用，即 this。

initLoader() 调用可确保加载器已初始化并处于活动状态。它有两种可能的结果：

  • 如果由 ID 指定的加载器已存在，则会重用上次创建的加载器。
  • 如果由 ID 指定的加载器不存在，initLoader() 会触发 LoaderManager.LoaderCallbacks 方法 onCreateLoader()。在此方法中，您需要实现实例化并返回新加载器的代码。如需了解更多讨论，请参阅关于 onCreateLoader 的部分。

无论哪种情况，给定的 LoaderManager.LoaderCallbacks 实现都将与加载器关联，并在加载器状态更改时调用。如果在此调用时，调用者处于其已启动状态，并且请求的加载器已存在并已生成其数据，则系统会立即在 initLoader() 期间调用 onLoadFinished()。您必须为此做好准备。有关此回调的更多讨论，请参阅关于 onLoadFinished 的部分。

initLoader() 方法返回创建的 Loader，但您无需捕获对其的引用。LoaderManager 会自动管理加载器的生命周期。LoaderManager 会在必要时启动和停止加载，并维护加载器及其相关内容的状态。

这意味着，您很少直接与加载器交互。您最常使用 LoaderManager.LoaderCallbacks 方法在特定事件发生时干预加载过程。有关此主题的更多讨论，请参阅使用 LoaderManager 回调部分。

重启加载器

当您使用 initLoader() 时（如前一节所示），如果存在指定 ID 的加载器，它会使用该加载器。如果不存在，则会创建一个新的。但有时您可能希望丢弃旧数据并重新开始。

要丢弃旧数据，请使用 restartLoader()。例如，以下 SearchView.OnQueryTextListener 的实现会在用户查询更改时重启加载器。加载器需要重启才能使用修改后的搜索过滤器执行新的查询。

Kotlin

fun onQueryTextChanged(newText: String?): Boolean {
    // 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.
    curFilter = if (newText?.isNotEmpty() == true) newText else null
    supportLoaderManager.restartLoader(0, null, this)
    return true
}

Java

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.
    curFilter = !TextUtils.isEmpty(newText) ? newText : null;
    getSupportLoaderManager().restartLoader(0, null, this);
    return true;
}

使用 LoaderManager 回调

LoaderManager.LoaderCallbacks 是一个回调接口，允许客户端与 LoaderManager 交互。

加载器，特别是 CursorLoader，在停止后应保留其数据。这使得应用能够在 activity 或 fragment 的 onStop() 和 onStart() 方法之间保留数据，以便用户返回应用时无需等待数据重新加载。

您可以使用 LoaderManager.LoaderCallbacks 方法来了解何时创建新加载器以及何时通知应用停止使用加载器的数据。

LoaderManager.LoaderCallbacks 包含以下方法：

  • onLoaderReset()：当先前创建的加载器正在重置时调用，从而使其数据不可用。

这些方法将在以下部分中更详细地描述。

onCreateLoader

当您尝试访问加载器时，例如通过 initLoader()，它会检查由 ID 指定的加载器是否存在。如果不存在，它会触发 LoaderManager.LoaderCallbacks 方法 onCreateLoader()。这是您创建新加载器的地方。通常这是一个 CursorLoader，但您可以实现自己的 Loader 子类。

在以下示例中，onCreateLoader() 回调方法使用其构造函数创建了一个 CursorLoader，该构造函数需要执行对 ContentProvider 查询所需的所有信息。具体来说，它需要以下内容：

  • uri：要检索内容的 URI。
  • projection：要返回的列的列表。传递 null 将返回所有列，这效率低下。
  • selection：声明要返回哪些行的过滤器，格式为 SQL WHERE 子句（不包括 WHERE 本身）。传递 null 将返回给定 URI 的所有行。
  • selectionArgs：如果您在 selection 中包含 ?，它们将按其在 selection 中出现的顺序替换为 selectionArgs 中的值。这些值以字符串形式绑定。
  • sortOrder：如何对行进行排序，格式为 SQL ORDER BY 子句（不包括 ORDER BY 本身）。传递 null 将使用默认排序顺序，这可能是不定序的。

Kotlin

// If non-null, this is the current filter the user has provided.
private var curFilter: String? = null
...
override fun onCreateLoader(id: Int, args: Bundle?): Loader<Cursor> {
    // 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.
    val baseUri: Uri = if (curFilter != null) {
        Uri.withAppendedPath(ContactsContract.Contacts.CONTENT_URI, Uri.encode(curFilter))
    } else {
        ContactsContract.Contacts.CONTENT_URI
    }

    // Now create and return a CursorLoader that will take care of
    // creating a Cursor for the data being displayed.
    val select: String = "((${Contacts.DISPLAY_NAME} NOTNULL) AND (" +
            "${Contacts.HAS_PHONE_NUMBER}=1) AND (" +
            "${Contacts.DISPLAY_NAME} != ''))"
    return (activity as? Context)?.let { context ->
        CursorLoader(
                context,
                baseUri,
                CONTACTS_SUMMARY_PROJECTION,
                select,
                null,
                "${Contacts.DISPLAY_NAME} COLLATE LOCALIZED ASC"
        )
    } ?: throw Exception("Activity cannot be null")
}

Java

// If non-null, this is the current filter the user has provided.
String curFilter;
...
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 (curFilter != null) {
        baseUri = Uri.withAppendedPath(Contacts.CONTENT_FILTER_URI,
                  Uri.encode(curFilter));
    } 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");
}

onLoadFinished

当先前创建的加载器完成加载时，会调用此方法。此方法保证在此加载器提供的最新数据被释放之前调用。此时，请移除所有对旧数据的使用，因为它们即将被释放。但不要自行释放数据，加载器拥有它并会处理。

一旦加载器知道应用不再使用数据，它就会释放数据。例如，如果数据是来自 CursorLoader 的游标，请不要自行调用其上的 close()。如果游标被放置在 CursorAdapter 中，请使用 swapCursor() 方法，这样旧的 Cursor 就不会被关闭，如以下示例所示：

Kotlin

private lateinit var adapter: SimpleCursorAdapter
...
override fun onLoadFinished(loader: Loader<Cursor>, data: Cursor?) {
    // Swap the new cursor in. (The framework will take care of closing the
    // old cursor once we return.)
    adapter.swapCursor(data)
}

Java

// This is the Adapter being used to display the list's data.
SimpleCursorAdapter adapter;
...
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.)
    adapter.swapCursor(data);
}

onLoaderReset

当先前创建的加载器正在重置时，会调用此方法，从而使其数据不可用。此回调可让您了解数据何时即将被释放，以便您可以移除对其的引用。

此实现调用 swapCursor()，并传入 null 值。

Kotlin

private lateinit var adapter: SimpleCursorAdapter
...
override fun onLoaderReset(loader: Loader<Cursor>) {
    // 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.
    adapter.swapCursor(null)
}

Java

// This is the Adapter being used to display the list's data.
SimpleCursorAdapter adapter;
...
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.
    adapter.swapCursor(null);
}

示例

例如，这是一个 Fragment 的完整实现，它显示一个 ListView，其中包含针对联系人内容提供器查询的结果。它使用 CursorLoader 来管理对提供器的查询。

由于此示例来自访问用户联系人的应用，因此其清单必须包含 READ_CONTACTS 权限。

Kotlin

private val CONTACTS_SUMMARY_PROJECTION: Array<String> = arrayOf(
        Contacts._ID,
        Contacts.DISPLAY_NAME,
        Contacts.CONTACT_STATUS,
        Contacts.CONTACT_PRESENCE,
        Contacts.PHOTO_ID,
        Contacts.LOOKUP_KEY
)


class CursorLoaderListFragment :
        ListFragment(),
        SearchView.OnQueryTextListener,
        LoaderManager.LoaderCallbacks<Cursor> {

    // This is the Adapter being used to display the list's data.
    private lateinit var mAdapter: SimpleCursorAdapter

    // If non-null, this is the current filter the user has provided.
    private var curFilter: String? = null

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        // Prepare the loader.  Either re-connect with an existing one,
        // or start a new one.
        loaderManager.initLoader(0, null, this)
    }

    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
        super.onViewCreated(view, 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 = SimpleCursorAdapter(activity,
                android.R.layout.simple_list_item_2,
                null,
                arrayOf(Contacts.DISPLAY_NAME, Contacts.CONTACT_STATUS),
                intArrayOf(android.R.id.text1, android.R.id.text2),
                0
        )
        listAdapter = mAdapter
    }

    override fun onCreateOptionsMenu(menu: Menu, inflater: MenuInflater) {
        // Place an action bar item for searching.
        menu.add("Search").apply {
            setIcon(android.R.drawable.ic_menu_search)
            setShowAsAction(MenuItem.SHOW_AS_ACTION_IF_ROOM)
            actionView = SearchView(activity).apply {
                setOnQueryTextListener(this@CursorLoaderListFragment)
            }
        }
    }

    override fun onQueryTextChange(newText: String?): Boolean {
        // 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.
        curFilter = if (newText?.isNotEmpty() == true) newText else null
        loaderManager.restartLoader(0, null, this)
        return true
    }

    override fun onQueryTextSubmit(query: String): Boolean {
        // Don't care about this.
        return true
    }

    override fun onListItemClick(l: ListView, v: View, position: Int, id: Long) {
        // Insert desired behavior here.
        Log.i("FragmentComplexList", "Item clicked: $id")
    }

    override fun onCreateLoader(id: Int, args: Bundle?): Loader<Cursor> {
        // 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.
        val baseUri: Uri = if (curFilter != null) {
            Uri.withAppendedPath(Contacts.CONTENT_URI, Uri.encode(curFilter))
        } else {
            Contacts.CONTENT_URI
        }

        // Now create and return a CursorLoader that will take care of
        // creating a Cursor for the data being displayed.
        val select: String = "((${Contacts.DISPLAY_NAME} NOTNULL) AND (" +
                "${Contacts.HAS_PHONE_NUMBER}=1) AND (" +
                "${Contacts.DISPLAY_NAME} != ''))"
        return (activity as? Context)?.let { context ->
            CursorLoader(
                    context,
                    baseUri,
                    CONTACTS_SUMMARY_PROJECTION,
                    select,
                    null,
                    "${Contacts.DISPLAY_NAME} COLLATE LOCALIZED ASC"
            )
        } ?: throw Exception("Activity cannot be null")
    }

    override fun onLoadFinished(loader: Loader<Cursor>, data: Cursor) {
        // Swap the new cursor in.  (The framework will take care of closing the
        // old cursor once we return.)
        mAdapter.swapCursor(data)
    }

    override fun onLoaderReset(loader: Loader<Cursor>) {
        // 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)
    }
}

Java

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

    @Override public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        // Prepare the loader.  Either re-connect with an existing one,
        // or start a new one.
        getLoaderManager().initLoader(0, null, this);
    }

    @Override public void onViewCreated(@NonNull View view, Bundle savedInstanceState) {
        super.onViewCreated(view, 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);
    }

    @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.
        curFilter = !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 (curFilter != null) {
            baseUri = Uri.withAppendedPath(Contacts.CONTENT_FILTER_URI,
                    Uri.encode(curFilter));
        } 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);
    }
}

更多示例

以下示例演示了如何使用加载器：