Android智能下拉刷新框架-SmartRefreshLayout

转载： Android智能下拉刷新框架-SmartRefreshLayout

English | 中文

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

SmartRefreshLayout

github 由于你懂的原因，下载速度缓慢，图片也无法查看，可以跳转 SmartRefreshLayout

特点功能:

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

传送门

Demo

下载 APK-Demo

项目演示

个人首页	微博列表
image	image

餐饮美食	个人中心
image	image

样式演示 Style

Delivery	DropBox
image	image
Refresh-your-delivery	Dropbox-Refresh

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

BezierRadar	BezierCircle
image	image
Pull To Refresh	Pull Down To Refresh

FlyRefresh	Classics
image	image
FlyRefresh	ClassicsHeader

Phoenix	Taurus
FunGame/BattleCity	image
Yalantis/Phoenix	Yalantis/Taurus

BattleCity	HitBlock
[ BattleCity	image
FunGame/BattleCity	FunGame/HitBlock

WaveSwipe	Material
image	image
WaveSwipeRefreshLayout	MaterialHeader

StoreHouse	WaterDrop
image	image
CRefreshLayout	WaterDrop

看到这么多炫酷的Header，是不是觉得很棒？这时你或许会担心这么多的Header集成在一起，但是平时只会用到一个，是不是要引入很多无用的代码和资源？ V2.x 版本已经把依赖库拆分成8个包啦，用到的时候自行引用就可以啦！

refresh-layout-kernel 核心必须依赖
refresh-header-classics 经典刷新头
refresh-header-radar 雷达刷新头
refresh-header-falsify 虚拟刷新头
refresh-header-material 谷歌刷新头
refresh-header-two-level 二级刷新头
refresh-footer-ball 球脉冲加载
refresh-footer-classics 经典加载

简单用例

1.在 build.gradle 中添加依赖

【V1.1.0】如果正在使用1.x 版本请调转，当前2.0 版本已经重定制，不支持升级，请在新项目中使用。

V2.x 相对于 V1.x 对包名做了修改如：com.scwang.smartrefresh 改为 com.scwang.smart.refresh。建议在新项目中使用，如果项目升级，java，xml 中都需要做包名替换，比较麻烦。但主要改动还是对 Smart 进行分包，减小不必要的依赖，比如不使用二级刷新就不依赖，避免代码冗余。但是未对 SmartRefreshHeader 分包，里面有十多个Header，建议需要使用哪个就复制哪个的源码到项目中。当然：大家也可以在讨论区讨论投票，选出里面使用频率比较高的Header，然后单独分离出来。

compile 'com.android.support:appcompat-v7:25.3.1'                   //必须 25.3.1 以上

// 注意：分包之后不会有默认的Header和Footer需要手动添加！还是原来的三种方法！
implementation  'com.scwang.smart:refresh-layout-kernel:2.0.1'      //核心必须依赖
implementation  'com.scwang.smart:refresh-header-classics:2.0.1'    //经典刷新头
implementation  'com.scwang.smart:refresh-header-radar:2.0.1'       //雷达刷新头
implementation  'com.scwang.smart:refresh-header-falsify:2.0.1'     //虚拟刷新头
implementation  'com.scwang.smart:refresh-header-material:2.0.1'    //谷歌刷新头
implementation  'com.scwang.smart:refresh-header-two-level:2.0.1'   //二级刷新头
implementation  'com.scwang.smart:refresh-footer-ball:2.0.1'        //球脉冲加载
implementation  'com.scwang.smart:refresh-footer-classics:2.0.1'    //经典加载

如果使用 AndroidX 先在 gradle.properties 中添加，两行都不能少噢~

android.useAndroidX=true
android.enableJetifier=true

需要依赖 androidx.appcompat

implementation 'androidx.appcompat:appcompat:1.0.0'                 //必须 1.0.0 以上

implementation  'com.scwang.smart:refresh-layout-kernel:2.0.1'      //核心必须依赖
implementation  'com.scwang.smart:refresh-header-classics:2.0.1'    //经典刷新头
implementation  'com.scwang.smart:refresh-header-radar:2.0.1'       //雷达刷新头
implementation  'com.scwang.smart:refresh-header-falsify:2.0.1'     //虚拟刷新头
implementation  'com.scwang.smart:refresh-header-material:2.0.1'    //谷歌刷新头
implementation  'com.scwang.smart:refresh-header-two-level:2.0.1'   //二级刷新头
implementation  'com.scwang.smart:refresh-footer-ball:2.0.1'        //球脉冲加载
implementation  'com.scwang.smart:refresh-footer-classics:2.0.1'    //经典加载

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

<?xml version="1.0" encoding="utf-8"?>
<com.scwang.smart.refresh.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">
    <com.scwang.smart.refresh.header.ClassicsHeader
        android:layout_width="match_parent"
        android:layout_height="wrap_content"/>
    <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.smart.refresh.footer.ClassicsFooter
        android:layout_width="match_parent"
        android:layout_height="wrap_content"/>
</com.scwang.smart.refresh.layout.SmartRefreshLayout>

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

RefreshLayout refreshLayout = (RefreshLayout)findViewById(R.id.refreshLayout);
refreshLayout.setRefreshHeader(new ClassicsHeader(this));
refreshLayout.setRefreshFooter(new ClassicsFooter(this));
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.smart.refresh.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.smart.refresh.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/dimenPaddingCommon"
        android:background="@android:color/white"
        android:text="@string/description_define_in_xml"/>
    <com.scwang.smart.refresh.footer.ClassicsFooter
        android:layout_width="match_parent"
        android:layout_height="wrap_content"/>
</com.scwang.smart.refresh.layout.SmartRefreshLayout>

注意：方法二 XML设置的Header和Footer的优先级是中等的，会被方法三覆盖。而且使用本方法的时候，Android Studio 会有预览效果，如下图：

不过不用担心，只是预览效果，运行的时候只有下拉才会出现~

3.方法三 Java代码设置

final RefreshLayout refreshLayout = (RefreshLayout) findViewById(R.id.refreshLayout);
//设置 Header 为 贝塞尔雷达 样式
refreshLayout.setRefreshHeader(new BezierRadarHeader(this).setEnableHorizontalDrag(true));
//设置 Footer 为 球脉冲 样式
refreshLayout.setRefreshFooter(new BallPulseFooter(this).setSpinnerStyle(SpinnerStyle.Scale));

4.更多使用说明

混淆

SmartRefreshLayout 不需要添加混淆过滤代码，并且已经混淆测试通过，如果你在项目的使用中混淆之后出现问题，请及时通知我。

友情链接

github/Loror
github/faith-hb/WidgetCase
github/Bamboy120315/Freedom
github/TommyLemon/APIJSON
github/dengyuhan
github/zrp2017
github/fly803/BaseProject
github/razerdp
github/SuperChenC/s-mvp
github/KingJA/LoadSir
github/jianshijiuyou
github/zxy198717
github/addappcn
github/RainliFu
github/sugarya
github/stormzhang

其他作品

MultiWaveHeader
SmartRefreshHorizontal
诗和远方

感谢

SwipeRefreshLayout
Ultra-Pull-To-Refresh
TwinklingRefreshLayout
BeautifulRefreshLayout