加载器

原文(英文)地址

从Android P（API 28）开始，已经弃用了Loader。在Activity和Fragment的生命周期中处理加载数据的推荐做法是使用ViewModels和LiveData的组合。 ViewModels可以承受像Loaders这样的配置更改，但具有更少的样板（boilerplate）。 LiveData提供了一种生命周期感知的加载数据的方法，您可以在多个ViewModel中重复使用。您还可以使用MediatorLiveData组合LiveData，并且可以使用任何可观察的查询（例如来自Room数据库的查询）来观察对数据的更改。 ViewModels和LiveData也可用于无法访问LoaderManager,的情况，例如Service中。配合使用这两者可以轻松访问应用程序所需的数据，而无需处理UI生命周期。要了解有关LiveData的更多信息，请参阅 LiveData guide，了解有关ViewModel的更多信息，请参阅ViewModel guide。

Loader API允许您从Content provider或其他数据源加载数据，以便在FragmentActivity或Fragment中显示。如果您不理解为什么需要Loader API来执行这个看似微不足道的操作，那么首先要考虑一些不使用加载器时可能遇到的问题：

如果直接在Activity或Fragment中获取数据，则由于在UI线程执行可能较慢的查询，您的用户将不能及时得到响应。
如果您从另一个线程（可能使用AsyncTask）获取数据，那么您负责通过各种Activity或Fragment生命周期事件（例如onDestroy（）和配置更改）来管理线程和UI线程。

装载器解决了这些问题，并包含其他优点，例如：

加载程序在不同的线程上运行，以防止janky或无响应的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子类化，也可以使用以下内置子类之一来简化实现： AsyncTaskLoader :一个抽象加载器，它提供AsyncTask以在单独的线程上执行加载操作。 CursorLoader ：AsyncTaskLoader的具体子类，用于从ContentProvider异步加载数据。它查询ContentResolver并返回一个Cursor。

以下内容会向您介绍如何在您的应用中使用这些类和接口。

在应用中使用加载器

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

FragmentActivity或Fragment。
LoaderManager的一个实例。
用于加载ContentProvider支持的数据的CursorLoader。或者，您可以实现自己的Loader或AsyncTaskLoader子类来从其他来源加载数据。
LoaderManager.LoaderCallbacks的实现。您可以在此处创建新的加载器并管理对现有加载器的引用。
一种显示加载程序数据的方法，例如SimpleCursorAdapter。
使用CursorLoader时的数据源，如ContentProvider。

开启一个Loader

在一个FragmentActivity或者Fragment中的LoaderManager可以管理一个或多个Loader实例，在一个Activity或Fragment中只能有一个LoadManager。

你可以在Activity的onCreate()方法或者Fragment的onCreateView()方法中初始化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
一个LoaderManag.LoaderCallbacks的实现，LoaderManager调用他来报告加载器事件。在这个例子中，本地类实现了LoaderManager.LoaderCallbacks接口，因此它将本身作为参数传递进去。

initLoader（）方法确保加载器初始化并处于活动状态。它有两种可能的结果：

如果ID指定的加载器已存在，则重用最后创建的加载器。
如果ID指定的加载器不存在，initLoader（）将触发LoaderManager.LoaderCallbacks中的onCreateLoader（）。这是您实例化并返回新加载器的代码。有关更多讨论，请参阅onCreateLoader一节。

在任何一种情况下，给定的LoaderManager.LoaderCallbacks实现都与加载器相关联，并在加载器状态改变时被调用。如果在调用时initLoader（）时调用者处于该Loader的启动状态，并且请求的加载器已经存在并且已生成其数据，则系统立即调用onLoadFinished（）（在initLoader（）期间），因此您必须为此做好准备发生。有关此回调的更多讨论，请参阅onLoadFinished

请注意，initLoader（）方法返回已创建的Loader，但您无需捕获对它的引用。 LoaderManager自动管理Loader的生命周期。 LoaderManager会在必要时启动和停止加载，并维护加载器及其相关内容的状态。这意味着，您很少直接与加载器交互。您一般应该使用LoaderManager.LoaderCallbacks中的方法在特定事件发生时干预加载过程。有关此主题的更多讨论，请参阅 Using the LoaderManager Callbacks.。

重启加载器

当您像如上所述使用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交互。

Loader，特别是CursorLoader，应该在停止后保留其数据。这允许应用程序将数据保存在Activity或Fragment的onStop（）和onStart（）方法中，这样当用户返回应用程序时，他们不必等待数据重新加载。您可以使用LoaderManager.LoaderCallbacks方法知道何时创建新的加载器，并告知应用程序何时停止使用加载器的数据。

LoaderManager.LoaderCallbacks包括以下方法：

onCreateLoader（） - 实例化并返回给定ID的新Loader。
onLoadFinished（） - 在先前创建的加载器完成其加载时调用。
onLoaderReset（） - 在重置先前创建的加载器时调用，从而使其数据不可用。

以下各节将更详细地介绍这些方法。

onCreateLoader()

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

在此示例中，onCreateLoader（）回调方法创建CursorLoader。您必须使用其构造函数方法构建CursorLoader，构建时需要提供ContentProvider查询时所需的完整信息。具体来说，它需要：

uri - 要检索的内容的URI。
projection - 要返回的列的列表。传递null将返回所有列，这是低效的。
selection - 一个过滤器，声明要返回哪些行，格式化为SQL WHERE子句（不包括WHERE本身）。传递null将返回给定URI的所有行。
selectionArgs - 您可以在选择中包含？s，它将被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()

当先前创建的加载器完成其加载时，将调用此方法。保证在释放为此加载器提供的最后一个数据之前调用此方法。此时你应该移除旧数据的所有使用（因为它将很快发布（release）），但不应该自己发布数据，因为它的加载器拥有它并将处理它。

一旦知道应用程序不再使用它，加载程序就会释放数据。例如，如果数据是来自CursorLoader的游标（Cursor），则不应自行调用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()

当重置先前创建的加载器时调用此方法，从而使其数据不可用。此回调可让您找出数据即将发布的时间，以便您可以删除对它的引用。

此实现使用null值调用swapCursor（）：

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

例子

作为示例，这里是Fragmrnt的完整实现，其显示包含针对联系人Content provider的查询结果的ListView。它使用CursorLoader来管理provider上的查询。

对于访问用户联系人的应用程序，如此示例所示，其manifest必须包含权限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 onActivityCreated(savedInstanceState: Bundle?) {
        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 = 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

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

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

加载器.md

加载器.md

加载器

Loader API摘要

在应用中使用加载器

开启一个Loader

重启加载器

使用LoaderManager回调

onCreateLoader()

onLoadFinished()

onLoaderReset()

例子

更多例子

Files

加载器.md

Latest commit

History

加载器.md

File metadata and controls

加载器

Loader API摘要

在应用中使用加载器

开启一个Loader

重启加载器

使用LoaderManager回调

onCreateLoader()

onLoadFinished()

onLoaderReset()

例子

更多例子