【转】Android PullToRefresh （ListView GridView 下拉刷新） 使用详解

最近项目用到下拉刷新，上来加载更多，这里对PullToRefresh这控件进行了解和使用。

以下内容转载自：http://blog.csdn.net/lmj623565791/article/details/38238749

群里一哥们今天聊天偶然提到这个git hub上的控件：pull-to-refresh ，有兴趣的看下，例子中的功能极其强大，支持很多控件。本篇博客详细给大家介绍下ListView和GridView利用pull-to-rerfesh 实现下拉刷新和上拉加载更多。

1、ListView下拉刷新快速入门

pull-to-refresh对ListView进行了封装，叫做：PullToRefreshListView，用法和listview没什么区别，下面看demo.

布局文件：

1. <RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
2. xmlns:tools="http://schemas.android.com/tools"
3. android:layout_width="match_parent"
4. android:layout_height="match_parent" >
5. <com.handmark.pulltorefresh.library.PullToRefreshListView
6. xmlns:ptr="http://schemas.android.com/apk/res-auto"
7. android:id="@+id/pull_refresh_list"
8. android:layout_width="fill_parent"
9. android:layout_height="fill_parent"
10. android:cacheColorHint="#00000000"
11. android:divider="#19000000"
12. android:dividerHeight="4dp"
13. android:fadingEdge="none"
14. android:fastScrollEnabled="false"
15. android:footerDividersEnabled="false"
16. android:headerDividersEnabled="false"
17. android:smoothScrollbar="true" >
18. </com.handmark.pulltorefresh.library.PullToRefreshListView>
19. </RelativeLayout>

声明了一个PullToRefreshListView，里面所有的属性都是ListView的，没有任何其他属性，当然了PullToRefreshListView也提供了很多配置的属性，后面会详细介绍。

Activity的代码:

1. package com.example.zhy_pulltorefreash_chenyoca;
2. import java.util.LinkedList;
3. import android.app.Activity;
4. import android.os.AsyncTask;
5. import android.os.Bundle;
6. import android.text.format.DateUtils;
7. import android.widget.ArrayAdapter;
8. import android.widget.ListView;
9. import com.handmark.pulltorefresh.library.PullToRefreshBase;
10. import com.handmark.pulltorefresh.library.PullToRefreshBase.OnRefreshListener;
11. import com.handmark.pulltorefresh.library.PullToRefreshListView;
12. public class PullToRefreshListActivity extends Activity
13. {
14. private LinkedList<String> mListItems;
15. /**
16. * 上拉刷新的控件
17. */
18. private PullToRefreshListView mPullRefreshListView;
19. private ArrayAdapter<String> mAdapter;
20. private int mItemCount = 9;
21. @Override
22. protected void onCreate(Bundle savedInstanceState)
23. {
24. super.onCreate(savedInstanceState);
25. setContentView(R.layout.activity_main);
26. // 得到控件
27. mPullRefreshListView = (PullToRefreshListView) findViewById(R.id.pull_refresh_list);
28. //初始化数据
29. initDatas();
30. //设置适配器
31. mAdapter = new ArrayAdapter<String>(this,
32. android.R.layout.simple_list_item_1, mListItems);
33. mPullRefreshListView.setAdapter(mAdapter);
34. // 设置监听事件
35. mPullRefreshListView
36. .setOnRefreshListener(new OnRefreshListener<ListView>()
37. {
38. @Override
39. public void onRefresh(
40. PullToRefreshBase<ListView> refreshView)
41. {
42. String label = DateUtils.formatDateTime(
43. getApplicationContext(),
44. System.currentTimeMillis(),
45. DateUtils.FORMAT_SHOW_TIME
46. | DateUtils.FORMAT_SHOW_DATE
47. | DateUtils.FORMAT_ABBREV_ALL);
48. // 显示最后更新的时间
49. refreshView.getLoadingLayoutProxy()
50. .setLastUpdatedLabel(label);
51. // 模拟加载任务
52. new GetDataTask().execute();
53. }
54. });
55. }
56. private void initDatas()
57. {
58. // 初始化数据和数据源
59. mListItems = new LinkedList<String>();
60. for (int i = 0; i < mItemCount; i++)
61. {
62. mListItems.add("" + i);
63. }
64. }
65. private class GetDataTask extends AsyncTask<Void, Void, String>
66. {
67. @Override
68. protected String doInBackground(Void... params)
69. {
70. try
71. {
72. Thread.sleep(2000);
73. } catch (InterruptedException e)
74. {
75. }
76. return "" + (mItemCount++);
77. }
78. @Override
79. protected void onPostExecute(String result)
80. {
81. mListItems.add(result);
82. mAdapter.notifyDataSetChanged();
83. // Call onRefreshComplete when the list has been refreshed.
84. mPullRefreshListView.onRefreshComplete();
85. }
86. }
87. }

代码极其简单，得到PullToRefreshListView控件，然后像ListView一样设置数据集。当然了，我们有下拉刷新，所以必须设置下拉刷新的回调：

setOnRefreshListener(new OnRefreshListener<ListView>(){}

我们在回调中模拟了一个异步任务，加载了一个Item。

效果图：

下拉时，执行我们的GetDataTask任务，任务执行完成后在onPostExecute中 调用mPullRefreshListView.onRefreshComplete();完成刷新。

是不是分分钟实现下拉刷新。当然了，你可能会有疑问，下拉刷新的指示器上的文字可以自定义吗？那个图片可以换成箭头吗？说好的上拉加载更多呢？后面会一一添加~

2、添加上拉加载更多

如过希望实现上拉加载更多，那么首先需要在布局文件的声明属性中添加一个属性，用于指定目前的下拉模式：

1. <RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
2. xmlns:tools="http://schemas.android.com/tools"
3. android:layout_width="match_parent"
4. android:layout_height="match_parent" >
5. <com.handmark.pulltorefresh.library.PullToRefreshListView
6. xmlns:ptr="http://schemas.android.com/apk/res-auto"
7. android:id="@+id/pull_refresh_list"
8. android:layout_width="fill_parent"
9. android:layout_height="fill_parent"
10. android:cacheColorHint="#00000000"
11. android:divider="#19000000"
12. android:dividerHeight="4dp"
13. android:fadingEdge="none"
14. android:fastScrollEnabled="false"
15. android:footerDividersEnabled="false"
16. android:headerDividersEnabled="false"
17. android:smoothScrollbar="true"
18. ptr:ptrMode="both" >
19. </com.handmark.pulltorefresh.library.PullToRefreshListView>
20. </RelativeLayout>

我们添加了一个属性：ptr:ptrMode="both" ，意思：上拉和下拉都支持。

可选值为：disabled（禁用下拉刷新），pullFromStart（仅支持下拉刷新），pullFromEnd（仅支持上拉刷新），both（二者都支持），manualOnly（只允许手动触发）

当然了，如果你不喜欢在布局文件中指定，完全可以使用代码设置，在onCreate里面写：mPullRefreshListView.setMode(Mode.BOTH);//设置你需要的模式

设置了模式为双向都支持，当然必须为上拉和下拉分别设置回调，请看下面的代码：

1. package com.example.zhy_pulltorefreash_chenyoca;
2. import java.util.LinkedList;
3. import android.app.Activity;
4. import android.os.AsyncTask;
5. import android.os.Bundle;
6. import android.text.format.DateUtils;
7. import android.util.Log;
8. import android.widget.ArrayAdapter;
9. import android.widget.ListView;
10. import com.handmark.pulltorefresh.library.PullToRefreshBase;
11. import com.handmark.pulltorefresh.library.PullToRefreshBase.Mode;
12. import com.handmark.pulltorefresh.library.PullToRefreshBase.OnRefreshListener;
13. import com.handmark.pulltorefresh.library.PullToRefreshBase.OnRefreshListener2;
14. import com.handmark.pulltorefresh.library.PullToRefreshListView;
15. public class PullToRefreshListActivity extends Activity
16. {
17. private LinkedList<String> mListItems;
18. /**
19. * 上拉刷新的控件
20. */
21. private PullToRefreshListView mPullRefreshListView;
22. private ArrayAdapter<String> mAdapter;
23. private int mItemCount = 9;
24. @Override
25. protected void onCreate(Bundle savedInstanceState)
26. {
27. super.onCreate(savedInstanceState);
28. setContentView(R.layout.activity_main);
29. // 得到控件
30. mPullRefreshListView = (PullToRefreshListView) findViewById(R.id.pull_refresh_list);
31. mPullRefreshListView.setMode(Mode.BOTH);
32. // 初始化数据
33. initDatas();
34. // 设置适配器
35. mAdapter = new ArrayAdapter<String>(this,
36. android.R.layout.simple_list_item_1, mListItems);
37. mPullRefreshListView.setAdapter(mAdapter);
38. mPullRefreshListView
39. .setOnRefreshListener(new OnRefreshListener2<ListView>()
40. {
41. @Override
42. public void onPullDownToRefresh(
43. PullToRefreshBase<ListView> refreshView)
44. {
45. Log.e("TAG", "onPullDownToRefresh");
46. //这里写下拉刷新的任务
47. new GetDataTask().execute();
48. }
49. @Override
50. public void onPullUpToRefresh(
51. PullToRefreshBase<ListView> refreshView)
52. {
53. Log.e("TAG", "onPullUpToRefresh");
54. //这里写上拉加载更多的任务
55. new GetDataTask().execute();
56. }
57. });
58. }
59. private void initDatas()
60. {
61. // 初始化数据和数据源
62. mListItems = new LinkedList<String>();
63. for (int i = 0; i < mItemCount; i++)
64. {
65. mListItems.add("" + i);
66. }
67. }
68. private class GetDataTask extends AsyncTask<Void, Void, String>
69. {
70. @Override
71. protected String doInBackground(Void... params)
72. {
73. try
74. {
75. Thread.sleep(2000);
76. } catch (InterruptedException e)
77. {
78. }
79. return "" + (mItemCount++);
80. }
81. @Override
82. protected void onPostExecute(String result)
83. {
84. mListItems.add(result);
85. mAdapter.notifyDataSetChanged();
86. // Call onRefreshComplete when the list has been refreshed.
87. mPullRefreshListView.onRefreshComplete();
88. }
89. }

和第一段的代码只有一个地方有区别，可能很难发现：
mPullRefreshListView.setOnRefreshListener(new

OnRefreshListener2<ListView>(){});注意这里的接口类型是OnRefreshListener2，多了个
2，和上面的不一样，这个接口包含两个方法，一个上拉回调，一个下拉回调。好了，这样我们就成功添加了上拉与下拉，并且分别可以控制其回调代码。

效果图：

咋样，是不是也很简单~注:如果你的上拉和下拉需求是执行一样的代码，那么你可以继续注册OnRefreshListener接口，上拉和下拉都会执行同一个方法。

接下来介绍如何使用带下拉刷新和加载更多的的GridView和自定义样式~

3、带下拉和上拉的GridView ( PullToRefreshGridView )

同样的pull-to-refresh把GridView封装为：PullToRefreshGridView 。用法和PullToRefreshListView一摸一样~

首先看主布局文件：

1. <?xml version="1.0" encoding="utf-8"?>
2. <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
3. android:layout_width="fill_parent"
4. android:layout_height="fill_parent"
5. android:orientation="vertical" >
6. <!-- The PullToRefreshGridView replaces a standard GridView widget. -->
7. <com.handmark.pulltorefresh.library.PullToRefreshGridView
8. xmlns:ptr="http://schemas.android.com/apk/res-auto"
9. android:id="@+id/pull_refresh_grid"
10. android:layout_width="fill_parent"
11. android:layout_height="fill_parent"
12. android:columnWidth="100dp"
13. android:gravity="center_horizontal"
14. android:horizontalSpacing="1dp"
15. android:numColumns="auto_fit"
16. android:stretchMode="columnWidth"
17. android:verticalSpacing="1dp"
18. ptr:ptrDrawable="@drawable/ic_launcher"
19. ptr:ptrMode="both" />
20. </LinearLayout>

PullToRefreshGridView 的item的布局文件：

1. <?xml version="1.0" encoding="utf-8"?>
2. <TextView xmlns:android="http://schemas.android.com/apk/res/android"
3. android:id="@+id/id_grid_item_text"
4. android:layout_width="100dp"
5. android:gravity="center"
6. android:textColor="#ffffff"
7. android:textSize="16sp"
8. android:background="#000000"
9. android:layout_height="100dp" />

接下来就是Activity的代码了：

1. public class PullToRefreshGridActivity extends Activity
2. {
3. private LinkedList<String> mListItems;
4. private PullToRefreshGridView mPullRefreshListView;
5. private ArrayAdapter<String> mAdapter;
6. private int mItemCount = 10;
7. @Override
8. protected void onCreate(Bundle savedInstanceState)
9. {
10. super.onCreate(savedInstanceState);
11. setContentView(R.layout.activity_ptr_grid);
12. // 得到控件
13. mPullRefreshListView = (PullToRefreshGridView) findViewById(R.id.pull_refresh_grid);
14. // 初始化数据和数据源
15. initDatas();
16. mAdapter = new ArrayAdapter<String>(this, R.layout.grid_item,
17. R.id.id_grid_item_text, mListItems);
18. mPullRefreshListView.setAdapter(mAdapter);
19. mPullRefreshListView
20. .setOnRefreshListener(new OnRefreshListener2<GridView>()
21. {
22. @Override
23. public void onPullDownToRefresh(
24. PullToRefreshBase<GridView> refreshView)
25. {
26. Log.e("TAG", "onPullDownToRefresh"); // Do work to
27. String label = DateUtils.formatDateTime(
28. getApplicationContext(),
29. System.currentTimeMillis(),
30. DateUtils.FORMAT_SHOW_TIME
31. | DateUtils.FORMAT_SHOW_DATE
32. | DateUtils.FORMAT_ABBREV_ALL);
33. // Update the LastUpdatedLabel
34. refreshView.getLoadingLayoutProxy()
35. .setLastUpdatedLabel(label);
36. new GetDataTask().execute();
37. }
38. @Override
39. public void onPullUpToRefresh(
40. PullToRefreshBase<GridView> refreshView)
41. {
42. Log.e("TAG", "onPullUpToRefresh"); // Do work to refresh
43. // the list here.
44. new GetDataTask().execute();
45. }
46. });
47. }
48. private void initDatas()
49. {
50. mListItems = new LinkedList<String>();
51. for (int i = 0; i < mItemCount; i++)
52. {
53. mListItems.add(i + "");
54. }
55. }
56. private class GetDataTask extends AsyncTask<Void, Void, Void>
57. {
58. @Override
59. protected Void doInBackground(Void... params)
60. {
61. try
62. {
63. Thread.sleep(2000);
64. } catch (InterruptedException e)
65. {
66. }
67. return null;
68. }
69. @Override
70. protected void onPostExecute(Void result)
71. {
72. mListItems.add("" + mItemCount++);
73. mAdapter.notifyDataSetChanged();
74. // Call onRefreshComplete when the list has been refreshed.
75. mPullRefreshListView.onRefreshComplete();
76. }
77. }

基本上上例没有任何区别，直接看效果图吧：

效果还是不错的，如果你比较细心会发现，那个下拉刷新的转圈的图片咋变成机器人了，那是因为我在布局文件里面设置了：

1. <com.handmark.pulltorefresh.library.PullToRefreshGridView
2. ptr:ptrDrawable="@drawable/ic_launcher"
3. ...
4. />

当然了这是旋转的效果，一般常用的还有，一个箭头倒置的效果，其实也很简单，一个属性：

ptr:ptrAnimationStyle="flip"

去掉 ptr:ptrDrawable="@drawable/ic_launcher"这个属性，如果你希望用下图默认的箭头，你也可以自定义。

添加后，箭头就是这个样子：

ptr:ptrAnimationStyle的取值：flip（翻转动画）， rotate（旋转动画） 。

ptr:ptrDrawable则就是设置图标了。

4、自定义下拉指示器文本内容等效果

可以在初始化完成mPullRefreshListView后，通过mPullRefreshListView.getLoadingLayoutProxy()可以得到一个ILoadingLayout对象，这个对象可以设置各种指示器中的样式、文本等。

1. ILoadingLayout startLabels = mPullRefreshListView
2. .getLoadingLayoutProxy();
3. startLabels.setPullLabel("你可劲拉，拉...");// 刚下拉时，显示的提示
4. startLabels.setRefreshingLabel("好嘞，正在刷新...");// 刷新时
5. startLabels.setReleaseLabel("你敢放，我就敢刷新...");// 下来达到一定距离时，显示的提示

如果你比较细心，会发现，前面我们设置上次刷新时间已经用到了：

// Update the LastUpdatedLabel
refreshView.getLoadingLayoutProxy().setLastUpdatedLabel(label);

现在的效果是：

默认是上拉和下拉的字同时改变的，如果我希望单独改变呢？

1. private void initIndicator()
2. {
3. ILoadingLayout startLabels = mPullRefreshListView
4. .getLoadingLayoutProxy(true, false);
5. startLabels.setPullLabel("你可劲拉，拉...");// 刚下拉时，显示的提示
6. startLabels.setRefreshingLabel("好嘞，正在刷新...");// 刷新时
7. startLabels.setReleaseLabel("你敢放，我就敢刷新...");// 下来达到一定距离时，显示的提示
8. ILoadingLayout endLabels = mPullRefreshListView.getLoadingLayoutProxy(
9. false, true);
10. endLabels.setPullLabel("你可劲拉，拉2...");// 刚下拉时，显示的提示
11. endLabels.setRefreshingLabel("好嘞，正在刷新2...");// 刷新时
12. endLabels.setReleaseLabel("你敢放，我就敢刷新2...");// 下来达到一定距离时，显示的提示
13. }

mPullRefreshListView.getLoadingLayoutProxy(true, false);接收两个参数，为true,false返回设置下拉的ILoadingLayout；为false,true返回设置上拉的。

5、常用的一些属性

当然了，pull-to-refresh在xml中还能定义一些属性：

ptrMode，ptrDrawable，ptrAnimationStyle这三个上面已经介绍过。

ptrRefreshableViewBackground 设置整个mPullRefreshListView的背景色

ptrHeaderBackground 设置下拉Header或者上拉Footer的背景色

ptrHeaderTextColor 用于设置Header与Footer中文本的颜色

ptrHeaderSubTextColor 用于设置Header与Footer中上次刷新时间的颜色

ptrShowIndicator如果为true会在mPullRefreshListView中出现icon，右上角和右下角，挺有意思的。

ptrHeaderTextAppearance ， ptrSubHeaderTextAppearance分别设置拉Header或者上拉Footer中字体的类型颜色等等。

ptrRotateDrawableWhilePulling当动画设置为rotate时，下拉是是否旋转。

ptrScrollingWhileRefreshingEnabled刷新的时候，是否允许ListView或GridView滚动。觉得为true比较好。

ptrListViewExtrasEnabled 决定了Header，Footer以何种方式加入mPullRefreshListView，true为headView方式加入，就是滚动时刷新头部会一起滚动。

最后2个其实对于用户体验还是挺重要的，如果设置的时候考虑下~。其他的属性自己选择就好。

注：上述属性很多都可以代码控制，如果有需要可以直接mPullRefreshListView.set属性名 查看

以上为pull-to-refresh所有支持的属性~~

定义了一堆的效果：

右上、右下那个图标就是ptrShowIndicator。好了，大家可以按照自己的需求对着上面的属性解释配置。

在github上下载的例子，是依赖3个项目的，一个基本的library_pullToRefresh，一个PullToRefreshViewPager，一个PullToRefreshListFragment ；

上面介绍的例子只依赖library_pullToRefresh，其他两个依赖不用导入。

好了，如果你觉得本篇博客对你有用，就点个赞~留个言吧

源码点击下载