Android SwipeRefreshLayout 使用

男娘i 2024-04-07 14:04 60阅读 0赞

## 1. 控件说明 ##

SwipeRefreshLayout是google官方推荐使用的下拉刷新的控件，如果用户想通过垂直滑动手势刷新视图的内容，就可以使用它。

实例化此控件的Activity应添加一个 OnRefreshListener，以便在完成滑动刷新手势时收到通知。 SwipeRefreshLayout 会在每次手势再次完成时通知监听器，监听器负责确定何时实际启动其内容的刷新。如果监听器不需要有刷新动作，通过调用 setRefreshing(false) 来取消任何刷新的视觉指示。如果用户要禁用手势和进度动画，可以通过调用 setEnabled(false)实现。

SwipeRefreshLayout 经常与ListView RecyclerView CardView控件一起使用，用来刷新数据显示。

SwipeRefreshLayout 在xml文件中角色：它作为手势刷新视图的父布局控件，并且只支持一个直接子控件。

## 2. API介绍 ##

<table style="width:690px;"> 
 <tbody> 
  <tr> 
   <td style="width:390px;"><strong>方法</strong></td> 
   <td style="width:299px;"><strong>说明</strong></td> 
  </tr> 
  <tr> 
   <td style="width:390px;"><code>setRefreshing(boolean refreshing)</code></td> 
   <td style="width:299px;">设置刷新状态，<code>true</code>表示正在刷新，<code>false</code>表示取消刷新。</td> 
  </tr> 
  <tr> 
   <td style="width:390px;">isRefreshing()</td> 
   <td style="width:299px;">判断当前的状态是否是正处于刷新状态。</td> 
  </tr> 
  <tr> 
   <td style="width:390px;">setSize(int size)</td> 
   <td style="width:299px;"> <pre>设置下拉刷新图标的大小, 只支持两种： DEFAULT&nbsp; 和 LARGE
</pre> </td> 
  </tr> 
  <tr> 
   <td style="width:390px;">setColorSchemeResources(int…colorReslds)</td> 
   <td style="width:299px;">设置进度View的组合颜色，在手指上下滑时使用第一个颜色，在刷新中，会一个个颜色进行切换</td> 
  </tr> 
  <tr> 
   <td style="width:390px;"> <pre>setColorSchemeResources(@ColorRes int... colorResIds)</pre> </td> 
   <td style="width:299px;"> <pre>设置刷新图标的颜色, 在手指下滑刷新时使用第一个颜色，和 setColorSchemeColors 传递的参数不一样，这里是传入int colorResIds</pre> </td> 
  </tr> 
  <tr> 
   <td style="width:390px;"> <pre>setProgressBackgroundColorSchemeResource(@ColorRes int colorRes)</pre> </td> 
   <td style="width:299px;"> <pre>设置刷新图标的背景颜色，默认为白色</pre> </td> 
  </tr> 
  <tr> 
   <td style="width:390px;">setOnRefreshListener(SwipeRefreshLayout.OnRefreshListener listener)</td> 
   <td style="width:299px;">设置监听，需要重写onRefresh()方法，顶部下拉时会调用这个方法，在里面实现请求数据的逻辑，设置下拉进度条消失等等。</td> 
  </tr> 
  <tr> 
   <td style="width:390px;"> <pre>setProgressViewOffset(boolean scale, int start, int end)</pre> </td> 
   <td style="width:299px;">设置动画样式下拉的起始点和结束点，<code>scale</code>设置是否需要放大或者缩小动画， 第一个参数：默认为false，设置为true，下拉过程中刷新图标就会从小变大<br><br> 第二个参数：起始位置，刷新图标距离顶部像素px<br><br> 第三个参数：结束位置，刷新图标距离顶部像素px</td> 
  </tr> 
  <tr> 
   <td style="width:390px;"> <pre>setProgressViewEndTarget(boolean scale, int end)</pre> </td> 
   <td style="width:299px;"> <pre>设置动画样式下拉的结束点  scale设置是否需要放大或者缩小动画， 第二个参数：结束位置，刷新图标距离顶部像素px</pre> </td> 
  </tr> 
  <tr> 
   <td style="width:390px;"> <pre>setSlingshotDistance(@Px int slingshotDistance)</pre> </td> 
   <td style="width:299px;"> <pre>设置可以将刷新指示器拉出其静止位置的距离（以像素为单位）</pre> </td> 
  </tr> 
  <tr> 
   <td style="width:390px;"> <pre>setEnabled(boolean enabled)</pre> </td> 
   <td style="width:299px;">false：禁用手势下拉刷新动画</td> 
  </tr> 
 </tbody> 
</table>

这些API 都是通过代码测试后，做的解释说明，还是比较准确的。

## 3. 使用方法 ##

#### 3.1 布局文件 ####

<?xml version="1.0" encoding="utf-8"?>
    <RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
        xmlns:tools="http://schemas.android.com/tools"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        tools:context=".MainActivity">
    
        <androidx.swiperefreshlayout.widget.SwipeRefreshLayout
            xmlns:android="http://schemas.android.com/apk/res/android"
            android:layout_width="match_parent"
            android:layout_height="match_parent"
            android:id="@+id/swipeLayout">
            <TextView
                android:id="@+id/text_test"
                android:layout_width="match_parent"
                android:layout_height="match_parent"
                android:text="手动下拉刷新"
                android:gravity="center"
                android:textSize="30dp"/>
        </androidx.swiperefreshlayout.widget.SwipeRefreshLayout>
    
    </RelativeLayout>

SwipeRefreshLayout 作为父控件， 它仅仅只能有一个子控件，比如TextView ListView CardView 其他等...

#### 3.2 界面代码 ####

public class MainActivity extends AppCompatActivity implements SwipeRefreshLayout.OnRefreshListener{
    
        private SwipeRefreshLayout swipeRefreshLayout;
    
        private TextView mTextView;
    
        @Override
        protected void onCreate(Bundle savedInstanceState) {
            super.onCreate(savedInstanceState);
            setContentView(R.layout.activity_main);
    
            swipeRefreshLayout = findViewById(R.id.swipeLayout);
    
            mTextView = findViewById(R.id.text_test);
    
            //设置下拉刷新图标的大小 只支持两种： DEFAULT  和 LARGE
            swipeRefreshLayout.setSize(CircularProgressDrawable.LARGE);
    
            //设置刷新图标的颜色，在手指下滑刷新时使用第一个颜色，在刷新中，会一个个颜色进行切换 这里是传入 int... colors
            swipeRefreshLayout.setColorSchemeColors(Color.BLACK, Color.GREEN, Color.RED, Color.YELLOW, Color.BLUE);
    
            //设置刷新图标的颜色, 在手指下滑刷新时使用第一个颜色，和 setColorSchemeColors 传递的参数不一样，这里是传入int colorResIds
            swipeRefreshLayout.setColorSchemeResources(R.color.red, R.color.blue, R.color.green);
    
            //设置刷新图标的背景颜色
            swipeRefreshLayout.setProgressBackgroundColorSchemeResource(R.color.teal_200);
    
            //设置动画样式下拉的起始点和结束点，scale设置是否需要放大或者缩小动画
            // 第一个参数：默认为false，设置为true，下拉过程中刷新图标就会从小变大
            // 第二个参数：起始位置，刷新图标距离顶部像素px
            // 第三个参数：结束位置，刷新图标距离顶部像素px
            //swipeRefreshLayout.setProgressViewOffset(false, 100, 200);
    
            //设置动画样式下拉的结束点  scale设置是否需要放大或者缩小动画
            // 第二个参数：结束位置，刷新图标距离顶部像素px
            //swipeRefreshLayout.setProgressViewEndTarget(false, 500);
    
            //设置可以将刷新指示器拉出其静止位置的距离（以像素为单位）
            //swipeRefreshLayout.setSlingshotDistance(600);
    
            //false:禁用手势下拉刷新动画
            //swipeRefreshLayout.setEnabled(false);
    
            //设置监听器,需要重写onRefresh()方法
            swipeRefreshLayout.setOnRefreshListener(this);
    
    
        }
    
        @Override
        public void onRefresh() {
            Log.e("test", "===是否==正在刷新中====" + swipeRefreshLayout.isRefreshing());
    
    
            mTextView.setText("正在刷新中......");
    
            new Handler().postDelayed(new Runnable() {
                @Override
                public void run() {
                    mTextView.setText("刷新完成");
                    //注意事项：当完成数据更新后一定要调用 setRefreshing(false)，不然刷新图标会一直转圈，不会消失
                    swipeRefreshLayout.setRefreshing(false);
                }
            }, 3000);
        }

代码解读：

当手势下拉刷新界面打印log如下：

28100 28100 E test    : ===是否==正在刷新中====true

效果图：

![0bd204249b9e4badbc594ec0fe8ef3e9.gif][]

--------------------

**响应刷新手势**

（1）当用户做出滑动手势时，系统会显示进度指示器并调用应用的回调方法。您的回调方法负责应用数据的实际更新。

（2）如需响应应用中的刷新手势，请实现 SwipeRefreshLayout.OnRefreshListener 接口及其 onRefresh() 方法。

（3）当用户做出滑动手势时，系统会调用 onRefresh() 方法。

实际更新操作的代码放在单独的方法中，并通过onRefresh() 实现调用该更新方法。

**当完成数据更新后一定要调用 setRefreshing(false),** 调用此方法可指示SwipeRefreshLayout移除进度指示器并更新视图内容。