Android智能下拉刷新框架-SmartRefreshLayout

<!-- [](https://www.android.com) --> <!-- [](https://github.com/scwang90) -->

English | 中文

正如名字所说，SmartRefreshLayout是一个“聪明”或者“智能”的下拉刷新布局，由于它的“智能”，它不只是支持所有的View，还支持多层嵌套的视图结构。它继承自ViewGroup 而不是FrameLayout或LinearLayout，提高了性能。 也吸取了现在流行的各种刷新布局的优点，包括谷歌官方的 SwipeRefreshLayout，其他第三方的 Ultra-Pull-To-Refresh、TwinklingRefreshLayout 。还集成了各种炫酷的 Header 和 Footer。 SmartRefreshLayout的目标是打造一个强大，稳定，成熟的下拉刷新框架，并集成各种的炫酷、多样、实用、美观的Header和Footer。

特点功能:

• 支持多点触摸
• 支持淘宝二楼和二级刷新
• 支持嵌套多层的视图结构 Layout (LinearLayout,FrameLayout...)
• 支持所有的 View（AbsListView、RecyclerView、WebView....View）
• 支持自定义并且已经集成了很多炫酷的 Header 和 Footer.
• 支持和ListView的无缝同步滚动 和 CoordinatorLayout 的嵌套滚动 .
• 支持自动刷新、自动上拉加载（自动检测列表惯性滚动到底部，而不用手动上拉）.
• 支持自定义回弹动画的插值器，实现各种炫酷的动画效果.
• 支持设置主题来适配任何场景的App，不会出现炫酷但很尴尬的情况.
• 支持设多种滑动方式：平移、拉伸、背后固定、顶层固定、全屏
• 支持所有可滚动视图的越界回弹

传送门

• 属性文档
• 常见问题
• 智能之处
• 更新日志
• 博客文章
• 源码下载
• 多点触摸
• 自定义Header

Demo

下载 APK-Demo

项目演示

|个人首页|微博列表| |:---:|:---:| |||

|餐饮美食|个人中心| |:---:|:---:| |||

样式演示 Style

|Delivery|DropBox| |:---:|:---:| ||| |Refresh-your-delivery|Dropbox-Refresh|

上面这两个是我自己实现的，下面的是我把github上其它优秀的Header进行的整理和集合还有优化：

|BezierRadar|BezierCircle| |:---:|:---:| ||| |Pull To Refresh|Pull Down To Refresh|

|FlyRefresh|Classics| |:---:|:---:| ||| |FlyRefresh|ClassicsHeader|

|Phoenix|Taurus| |:---:|:---:| ||| |Yalantis/Phoenix|Yalantis/Taurus

|BattleCity|HitBlock| |:---:|:---:| ||| |FunGame/BattleCity|FunGame/HitBlock

|WaveSwipe|Material| |:---:|:---:| ||| |WaveSwipeRefreshLayout|MaterialHeader

|StoreHouse|WaterDrop| |:---:|:---:| ||| |CRefreshLayout|WaterDrop

看到这么多炫酷的Header，是不是觉得很棒？这时你或许会担心这么多的Header集成在一起，但是平时只会用到一个，是不是要引入很多无用的代码和资源？ 请放心，我已经把刷新布局分成三个包啦，用到的时候自行引用就可以啦！

• SmartRefreshLayout 刷新布局核心实现，自带ClassicsHeader（经典）、BezierRadarHeader（贝塞尔雷达）两个 Header.
• SmartRefreshHeader 各种Header的集成，除了Layout自带的Header，其它都在这个包中.
• SmartRefreshFooter 各种Footer的集成，除了Layout自带的Footer，其它都在这个包中.

简单用例

1.在 build.gradle 中添加依赖

//1.1.0 API改动过大，老用户升级需谨慎
compile 'com.scwang.smartrefresh:SmartRefreshLayout:1.1.0-alpha-7'
compile 'com.scwang.smartrefresh:SmartRefreshHeader:1.1.0-alpha-7'//没有使用特殊Header，可以不加这行
compile 'com.android.support:appcompat-v7:25.3.1'//版本 23以上（必须）

//1.0.5 当1.1.0出现问题可以回退到1.0.5.1
compile 'com.scwang.smartrefresh:SmartRefreshLayout:1.0.5.1'
compile 'com.scwang.smartrefresh:SmartRefreshHeader:1.0.5.1'//没有使用特殊Header，可以不加这行
compile 'com.android.support:appcompat-v7:25.3.1'//版本 23以上（必须）
compile 'com.android.support:design:25.3.1'//版本随意（非必须，引用可以解决无法预览问题）

2.在XML布局文件中添加 SmartRefreshLayout

<?xml version="1.0" encoding="utf-8"?>
<com.scwang.smartrefresh.layout.SmartRefreshLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:id="@+id/refreshLayout"
    android:layout_width="match_parent"
    android:layout_height="match_parent">
    <android.support.v7.widget.RecyclerView
        android:id="@+id/recyclerView"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:overScrollMode="never"
        android:background="#fff" />
</com.scwang.smartrefresh.layout.SmartRefreshLayout>

3.在 Activity 或者 Fragment 中添加代码

RefreshLayout refreshLayout = (RefreshLayout)findViewById(R.id.refreshLayout);
refreshLayout.setOnRefreshListener(new OnRefreshListener() {
    @Override
    public void onRefresh(RefreshLayout refreshlayout) {
        refreshlayout.finishRefresh(2000/*,false*/);//传入false表示刷新失败
    }
});
refreshLayout.setOnLoadMoreListener(new OnLoadMoreListener() {
    @Override
    public void onLoadMore(RefreshLayout refreshlayout) {
        refreshlayout.finishLoadMore(2000/*,false*/);//传入false表示加载失败
    }
});

使用指定的 Header 和 Footer

1.方法一 全局设置

public class App extends Application {
    //static 代码段可以防止内存泄露
    static {
        //设置全局的Header构建器
        SmartRefreshLayout.setDefaultRefreshHeaderCreator(new DefaultRefreshHeaderCreator() {
                @Override
                public RefreshHeader createRefreshHeader(Context context, RefreshLayout layout) {
                    layout.setPrimaryColorsId(R.color.colorPrimary, android.R.color.white);//全局设置主题颜色
                    return new ClassicsHeader(context);//.setTimeFormat(new DynamicTimeFormat("更新于 %s"));//指定为经典Header，默认是 贝塞尔雷达Header
                }
            });
        //设置全局的Footer构建器
        SmartRefreshLayout.setDefaultRefreshFooterCreator(new DefaultRefreshFooterCreator() {
                @Override
                public RefreshFooter createRefreshFooter(Context context, RefreshLayout layout) {
                    //指定为经典Footer，默认是 BallPulseFooter
                    return new ClassicsFooter(context).setDrawableSize(20);
                }
            });
    }
}

注意：方法一 设置的Header和Footer的优先级是最低的，如果同时还使用了方法二、三，将会被其它方法取代

2.方法二 XML布局文件指定

<com.scwang.smartrefresh.layout.SmartRefreshLayout
    xmlns:app="http://schemas.android.com/apk/res-auto"
    android:id="@+id/refreshLayout"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:background="#444444"
    app:srlPrimaryColor="#444444"
    app:srlAccentColor="@android:color/white"
    app:srlEnablePreviewInEditMode="true">
    <!--srlAccentColor srlPrimaryColor 将会改变 Header 和 Footer 的主题颜色-->
    <!--srlEnablePreviewInEditMode 可以开启和关闭预览功能-->
    <com.scwang.smartrefresh.layout.header.ClassicsHeader
        android:layout_width="match_parent"
        android:layout_height="wrap_content"/>
    <TextView
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:padding="@dimen/padding_common"
        android:background="@android:color/white"
        android:text="@string/description_define_in_xml"/>
    <com.scwang.smartrefresh.layout.footer.ClassicsFooter
        android:layout_width="match_parent"
        android:layout_height="wra