SmoothRefreshLayout

English | 中文

一個(gè)高效的Android刷新庫，理論上支持所有的視圖，比官方的SwipeRefreshLayout更強(qiáng)大且使用方便.
本開源庫的部分代碼來自android-Ultra-Pull-To-Refresh.
非常感謝他提供的這么棒的開源項(xiàng)目！

特性:

• 理論上支持所有的視圖,且可根據(jù)具體需求高效適配.
• 支持多點(diǎn)觸摸.
• 支持嵌套滑動(dòng),完整實(shí)現(xiàn)了NestedScrollingChild，NestedScrollingParent 接口,玩轉(zhuǎn)CoordinatorLayout.
• 直接繼承自ViewGroup,擁有卓越的性能,支持類FameLayout的特性（Gravity、Margin).
• 支持自動(dòng)刷新、自動(dòng)上拉加載、到底自動(dòng)加載更多（不推薦，建議使用Adapter實(shí)現(xiàn)，可自定義到底判斷邏輯回調(diào)實(shí)現(xiàn)預(yù)加載更多）.
• 支持越界回彈.
• 支持刷新視圖自定樣式:STYLE_DEFAULT(默認(rèn)不改變大小)、STYLE_SCALE(動(dòng)態(tài)改變大小，一直會(huì)重測量并布局，所以性能會(huì)有損失)、STYLE_PIN(不會(huì)改變視圖大小，固定在頂部或者底部)、STYLE_FOLLOW_SCALE(先縱向跟隨移動(dòng)并且不改變視圖大小，大于視圖高度后動(dòng)態(tài)改變視圖大小且性能會(huì)有損失)、STYLE_FOLLOW_PIN(不會(huì)改變視圖大小，先縱向跟隨移動(dòng)，大于視圖高度后固定)、STYLE_FOLLOW_CENTER(不會(huì)改變視圖大小，先縱向跟隨移動(dòng)，大于視圖高度后讓視圖保持在移動(dòng)的距離中心點(diǎn)).
• 支持二級(jí)刷新事件（TwoLevelSmoothRefreshLayout）,PS:淘寶二樓、京東活動(dòng).
• 支持橫向刷新(HorizontalSmoothRefreshLayout).
• 支持ListView、GridView、RecyclerView加載更多的同步平滑滾動(dòng).
• 支持多狀態(tài)視圖:STATE_CONTENT(默認(rèn)狀態(tài))、STATE_ERROR(異常狀態(tài))、STATE_EMPTY(空狀態(tài))、STATE_CUSTOM(自定義狀態(tài)).
• 支持手勢:同步Fling(刷新視圖仍可見的情況下,會(huì)先回滾隱藏刷新視圖,而后向下傳遞Fling手勢).
• 支持作為可拉伸內(nèi)部視圖布局使用（類小米設(shè)置頁效果）.
• 豐富的回調(diào)接口和調(diào)試信息,可利用現(xiàn)有API實(shí)現(xiàn)豐富的效果.

演示程序

下載 Demo.apk

更新日志

老版本升級(jí)務(wù)必查看

更新日志

快照

• 測試?yán)焓湛s效果（1.6.2版本添加）
  

  test_scale_effect.gif

• 測試橫向拉伸收縮效果（1.6.2版本添加）
  

  test_horizontal_scale_effect.gif

• 測試橫向刷新（1.5.0版本添加）
  

  test_horizontal_refresh.gif

• 測試橫向RecyclerView刷新（1.5.0版本添加）
  

  test_horizontal_recyclerView.gif

• 測試多方向布局下的刷新
  

  test_multi_direction_views.gif

• 測試QQ瀏覽器樣式
  

  test_qq_web_browser_style.gif

• 測試QQ活動(dòng)樣式
  

  test_qq_style.gif

• 測試2級(jí)刷新
  

  test_two_level_refresh.gif

• 包含ListView
  

  with_listView.gif

• 包含RecyclerView
  

  with_recyclerView.gif

• 包含ViewPager
  

  with_viewPager.gif

• CoordinatorLayout
  

  with_recyclerView_in_coordinatorLayout.gif

• 越界回彈模式
  

  test_overScroll.gif

• 測試嵌套滑動(dòng)
  

  test_nested_scroll.gif

使用

Gradle

repositories {
    ...
    maven { url 'https://jitpack.io' }
}

dependencies {
    //核心基礎(chǔ)庫，包含絕大多數(shù)功能，擴(kuò)展庫必須依賴本庫（從1.6.0版本開始Core庫不再自帶刷新視圖實(shí)現(xiàn)，只包含核心功能）
    compile 'com.github.dkzwm.SmoothRefreshLayout:core:1.6.3.2'
    //默認(rèn)Classic樣式的刷新視圖實(shí)現(xiàn)庫(從1.6.0版本才有，是從老版本的Core庫中拆分出來的庫)
    compile 'com.github.dkzwm.SmoothRefreshLayout:ext-classic:1.6.3.2'
    //默認(rèn)Material樣式的刷新視圖實(shí)現(xiàn)庫(從1.6.0版本才有，是從老版本的Core庫中拆分出來的庫)
    compile 'com.github.dkzwm.SmoothRefreshLayout:ext-material:1.6.3.2'
    //工具類庫，帶有一些快捷配置工具（自動(dòng)滾動(dòng)刷新工具，快速設(shè)置AppBarLayout工具）
    compile 'com.github.dkzwm.SmoothRefreshLayout:ext-utils:1.6.3.2'
    //擴(kuò)展支持二級(jí)刷新庫
    compile 'com.github.dkzwm.SmoothRefreshLayout:ext-two-level:1.6.3.2'
    //擴(kuò)展支持橫向刷新庫
    compile 'com.github.dkzwm.SmoothRefreshLayout:ext-horizontal:1.6.3.2'
}

在Xml中配置

<?xml version="1.0" encoding="utf-8"?>
<me.dkzwm.widget.srl.SmoothRefreshLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    android:id="@+id/refreshLayout"
    android:layout_width="match_parent"
    android:layout_height="match_parent">
    <TextView
        android:layout_width="match_parent"
        android:layout_height="match_parent"/>
</me.dkzwm.widget.srl.SmoothRefreshLayout>

Java代碼配置

SmoothRefreshLayout refreshLayout = (SmoothRefreshLayout)findViewById(R.id.smoothRefreshLayout);
refreshLayout.setHeaderView(new ClassicHeader(this));
refreshLayout.setOnRefreshListener(new RefreshingListenerAdapter() {
    @Override
    public void onRefreshBegin(boolean isRefresh) {
        mHandler.postDelayed(new Runnable() {
            @Override
            public void run() {
                refreshLayout.refreshComplete();
            }
        }, 4000);
    }
});

自定義刷新視圖

接口定義

public interface IRefreshView <T extends IIndicator> {    

    byte TYPE_HEADER = 0;
    byte TYPE_FOOTER = 1;

    byte STYLE_DEFAULT = 0;
    byte STYLE_SCALE = 1;
    byte STYLE_PIN = 2;
    byte STYLE_FOLLOW_SCALE = 3;
    byte STYLE_FOLLOW_PIN = 4;
    byte STYLE_FOLLOW_CENTER = 5;

    /**
     * 返回是頭部視圖還是尾部視圖;
     */
    int getType();

    /**
     * 一般情況都是View實(shí)現(xiàn)本接口，所以返回this;
     */
    View getView();

    /**
     * 獲取視圖樣式，自1.4.8版本后支持6種樣式，STYLE_DEFAULT、STYLE_SCALE、STYLE_PIN、STYLE_FOLLOW_SCALE、STYLE_FOLLOW_PIN、STYLE_FOLLOW_CENTER;
     */
    int getStyle();

    /**
     * 獲取視圖的自定義高度，當(dāng)視圖樣式為STYLE_SCALE和STYLE_FOLLOW_SCALE時(shí)，必須返回一個(gè)確切且大于0的值，使用橫向刷新庫時(shí)，該屬性實(shí)際應(yīng)該返回的是視圖的寬度;
     * 自1.6.1版本開始，如果想要當(dāng)前視圖鋪滿布局即MATCH_PARENT，那么支持返回ViewGroup.LayoutParams.MATCH_PARENT對(duì)應(yīng)的值即`-1`;
     */
    int getCustomHeight();

    /**
     * 手指離開屏幕;
     */
    void onFingerUp(SmoothRefreshLayout layout, T indicator);

    /**
     * 重置視圖;
     */
    void onReset(SmoothRefreshLayout layout);

    /**
     * 重新配置視圖，準(zhǔn)備刷新;
     */
    void onRefreshPrepare(SmoothRefreshLayout layout);

    /**
     * 開始刷新;
     */
    void onRefreshBegin(SmoothRefreshLayout layout, T indicator);

    /**
     * 刷新完成;
     */
    void onRefreshComplete(SmoothRefreshLayout layout,boolean isSuccessful);

    /**
     * 當(dāng)頭部或者尾部視圖發(fā)生位置變化;
     */
    void onRefreshPositionChanged(SmoothRefreshLayout layout, byte status, T indicator);

    /**
     * 當(dāng)頭部或者尾部視圖仍然處于處理事務(wù)中，這時(shí)候移動(dòng)其他刷新視圖則會(huì)調(diào)用該方法;
     * 在1.4.6版本新加入;
     */
    void onPureScrollPositionChanged(SmoothRefreshLayout layout, byte status, T indicator);
}

添加自定義刷新視圖

• 全局靜態(tài)代碼構(gòu)造

        SmoothRefreshLayout.setDefaultCreator(new IRefreshViewCreator() {
            @Override
            public void createHeader(SmoothRefreshLayout layout) {
                ClassicHeader header = new ClassicHeader(layout.getContext());
                layout.setHeaderView(header);
            }

            @Override
            public void createFooter(SmoothRefreshLayout layout) {
                ClassicFooter footer = new ClassicFooter(layout.getContext());
                layout.setFooterView(footer);
            }
        });

• 動(dòng)態(tài)代碼添加

        ClassicHeader header = new ClassicHeader(mRefreshLayout.getContext());
        mRefreshLayout.setHeaderView(header);
        ClassicFooter footer = new ClassicFooter(mRefreshLayout.getContext());
        mRefreshLayout.setFooterView(footer);

• 請直接寫入Xml文件,SmoothRefreshLayout會(huì)根據(jù)添加的View是否是實(shí)現(xiàn)了IRefreshView接口進(jìn)行判斷

實(shí)現(xiàn)類QQ下拉阻尼效果

       mRefreshLayout.setIndicatorOffsetCalculator(new IIndicator.IOffsetCalculator() {
           @Override
           public float calculate(@IIndicator.MovingStatus int status, int currentPos, float offset) {
               if (status == IIndicator.MOVING_HEADER) {
                   if (offset < 0) {
                       //如果希望拖動(dòng)縮回時(shí)類似QQ一樣沒有阻尼效果，阻尼效果只存在于下拉則可以在此返回offset
                       //如果希望拖動(dòng)縮回時(shí)類似QQ一樣有阻尼效果，那么請注釋掉這個(gè)判斷語句
                       return offset;
                   }
                   return (float) Math.pow(Math.pow(currentPos / 2, 1.28d) + offset, 1 / 1.28d) * 2 - currentPos;
               } else if (status == IIndicator.MOVING_FOOTER) {
                   if (offset > 0) {
                       //如果希望拖動(dòng)縮回時(shí)類似QQ一樣沒有阻尼效果，阻尼效果只存在于上拉則可以在此返回offset
                       //如果希望拖動(dòng)縮回時(shí)類似QQ一樣有阻尼效果，那么請注釋掉這個(gè)判斷語句
                       return offset;
                   }
                   return -((float) Math.pow(Math.pow(currentPos / 2, 1.28d) - offset, 1 / 1.28d) * 2 - currentPos);
               } else {
                   if (offset > 0) {
                       return (float) Math.pow(offset, 1 / 1.28d) * 2;
                   } else if (offset < 0) {
                       return -(float) Math.pow(-offset, 1 / 1.28d) * 2;
                   } else {
                       return offset;
                   }
               }
           }
       });

Xml屬性

SmoothRefreshLayout 自身配置

TwoLevelSmoothRefreshLayout 自身配置

SmoothRefreshLayout包裹內(nèi)部其他View支持配置

SmoothRefreshLayout java屬性設(shè)置方法

SmoothRefreshLayout 回調(diào)

SmoothRefreshLayout 其它

TwoLevelSmoothRefreshLayout java屬性設(shè)置方法

TwoLevelSmoothRefreshLayout 其它

Thanks

• liaohuqiu android-Ultra-Pull-To-Refresh
• pnikosis material-progress

License

MIT License

Copyright (c) 2017 dkzwm
Copyright (c) 2015 liaohuqiu.net

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.