关闭

Android中的Loaders机制

49人阅读 评论(0) 收藏 举报

Loaders机制在Android 3.0版本后引入。Loaders机制使一个Activity或者一个Fragment更加容易异步加载数据。Loaders有如下的特性:

Ø  它们适用于任何Activity和Fragment;

Ø  它们提供了异步加载数据的机制;

Ø  它们检测数据源,当数据源内容改变时它们能够传递新的结果;

Ø  当配置改变后需要重新创建时,它们会重新连接到最后一个loader的游标。这样,它们不需要重新查询它们的数据。


1 Loader API 总结

在app里可以使用与loaders相关的很多的类和接口。总结如下:

Class/Interface

描述

LoaderManager

一个与Activity和Fragment有关联的抽象类,用于管理一个或多个Loader实例。这有助于app管理长运行操作。使用它的最显著的例子是CursorLoader。每个Activity或Fragment只能有一个LoaderManager。而一个LoaderManager可以有多个loaders。

LoaderManager.LoaderCallbacks

提供给客户端的一个callback接口,用于和LoaderManager进行交互。例如,你可以使用onCreateLoader() callback来创建一个新的loader。

AsyncTaskLoader

一个抽象Loader,提供一个AsyncTask进行工作。

CursorLoader

AsyncTaskLoader的子类,用于向ContentResover请求,返回一个Cursor。这个类以标准的游标查询方式实现了Loader协议,建立了AsyncTaskLoader,使用一个后台线程来进行游标查询,不会阻塞app的UI。因此,使用这个loader是从ContentProvider加载异步数据的最好的方式。

上述的class和interface是你在app里实现一个loader所需要的组件。你不必使用所有的组件,但是你通常需要一个LoaderManager的引用(用于初始化一个loader)和一个Loader实现类(例如CursorLoader)。


2 在APP里使用Loaders

一个App里,典型的使用loaders包含的内容如下:

一个Activity或一个Fragment。

一个LoaderManager的实例。

一个CursorLoader,从一个ContentProvider里加载数据。

一个LoaderManager.LoaderCallbacks的实现。在这你创建新的loader,和管理已经存在的loaders。

一种显示loader加载数据的方式,例如SimpleCursorAdapter。

一种数据源,例如一个Conterprovider(当使用CursorLoader)。


2.1 启动一个Loader

在一个Activity或Fragment里,LoaderManager管理一个或多个loader实例。每个Activity或Fragment只有一个LoaderManager。

你可要在Activity里的onCreate()方法里,或者在Fragment里的onActivityCreated()方法里初始化一个loader。例如:

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

initLoader()方法有三个参数:

Ø  一个标志loader的ID。

Ø  提供给loader构造函数的参数,可选。

Ø  一个LoaderManager.LoaderCallbacks的实现。

 

initLoader()的调用确保了一个loader被初始化和激活。它有两种结果:

如果标志loader的ID已经存在,则最后创建的loader被复用。

如果标志loader的ID不存在,initLoader()会激发LoaderManager.LoaderCallbacks的方法onCreateLoader()。

在这两种情形下,给定的LoaderManager.LoaderCallbacks实例被关联到loader,并且当loader状态变化时被调用。如果调用者正处于其开始状态并且被请求的loader已经存在,且已产生了数据,那么系统立即调用onLoadFinished()(在initLoader()调用期间),所以你必须准备好这种情况的发生。

 

记住,intiLoader()会返回一个创建的loader,但是你不需要来获取它的引用。LoadeManager会自动管理loader的生命周期。LoaderManager会开始loading,结束loading,维护loader的状态,以及相关的内容。这意味着,你几乎不用直接和loaders进行交互。当有特定事件发生时,你仅仅需要使用LoaderManager.LoaderCallbacks方法来干预loading的过程。


2.2 重启一个loader

当你调用一个initLoader(),如上述所示,你会得到一个ID已经存在的loader,或者创建一个新的loader。但是有时候,你想丢弃掉你的旧数据,重新开始。

要丢弃掉你的旧数据,你要调用restartLoader()。例如,SearchView.OnQueryTextListener的实现重启了loader,当用户的查询发生变化时。loader需要重启,是由于它要使用修改过的搜索过滤器来进行新的查询:

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


2.3 使用LoaderManagerCallbacks

LoaderManager.LoaderCallbacks是callback接口,给client提供与LoaderManager交互的接口。

Loaders,特别是CursorLoader,在被停止后期望能够维持它们的数据。这允许apps在actvitiy或fragemnt的onStop()和onStart()方法里能够保持它们的数据,它们不需要等待数据重新被加载。你使用LoaderManager.LoaderCallbacks方法,知道什么时候该创建一个新的loader,告诉apps什么时候该停止使用一个loader的数据。

 

LoaderManager.LoaderCallbacks包含了三个方法:

onCreateLoader()--- 实例化和返回一个新创建的给定ID的loader

onLoadFinished()--- 当一个创建好的loader完成了load,调用此函数

onLoaderReset()--- 当一个创建好的loader要被reset,调用此函数,这样导致它的数据无效


2.3.1 onCreateLoader

当你尝试访问一个loader(例如,通过initLoader()),它会检查给定的loader的ID是否存在。如果不存在,它会触发LoaderManager.LoaderCallbacks里的方法onCreateLoader(),来创建一个新的loader。典型的例子是CursorLoader。

在这个例子里,onCreateLoader()回调函数创建一个CursorLoader。你必须使用CursorLoader的构造函数,它需要一些额外的信息用于查询一个ContentProvider。它需要:

uri--- 取得内容的URI。

projection--- 要返回的列的list。传递null则返回所有的列,这种做法不够高效。

selectionArgs--- 你也许要在selection里包含 ?s,被selectionArgs里的值替换。

sortOrder--- 行的排序由SQL ORDER BY语句来格式化。传递null则返回默认的排序,也许无序。

例如:

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


2.3.2 onLoadFinished

当一个创建好的loader结束了它的load,此方法被调用。这个方法确保在释放loader维持的数据之前调用。在这个点上,你应当移除所有对旧数据的使用(因为旧数据不久就要被释放),不用释放旧数据,loader会完成旧数据的释放。

 

loader一旦知道app不再使用它,它就会释放掉数据。例如,如果数据是来自CursorLoader里的一个cursor,你不应当自己调用close()。如果一个cursor正在放置到一个CursorAdapter,你应当使用swapCursor()方法,这样旧的Cursor就不会被关掉。

例如:

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

2.3.3onLoaderReset

当建立好的loader正在被重启时,此方法被调用,这样让loader的数据置于无效状态。这个回调函数让你发现什么时候数据要被释放掉,在这个点上你可要移除对它的引用。

例如:

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


3 样例

这个样例是一个Fragment的实现,它使用ListView显示了通讯录查询的结果,使用CursorLoader来管理通讯录Provider的查询。app若需要访问通讯录,你需要在mainfest里添加权限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);
      }
  }

 

更多的样例请参考API Demos里的"LoaderCursor"和"LoaderThrottle"。

0
0

查看评论
* 以上用户言论只代表其个人观点,不代表CSDN网站的观点或立场
    最新评论