万能ViewPager2适配器--SmartViewPager2Adapter

特点功能

完全脱离xml，所有效果只需要通过api调用

具体功能：
    1. 两句代码实现抖音列表效果
    2. 无感且丝滑，动态从头部或者底部加载数据
    3. 设置上下加载监听，再达到预加载limit的时候触发监听
    4. 实现数据源接口，和Fragment接口，你会体验到什么是丝滑
    5. 画廊的实现，不再需要在xml设置clipChildren属性，调用即可实现。
    6. 极限脱离xml控制，以简化使用者使用
    7. 支持无线循环模式
    8. 支持自动滚动模式；设置滚动时长，设置循环间隔时长
    9. 循环滚动可绑定页面lifeCycle生命周期

SmartViewPager2Adapter动态

SmartViewPager2Adapter更新动态及以往版本

Demo

为录制流畅，截图分辨率比较模糊。可在下方扫描二维码下载apk

效果展示

为录制流畅，截图分辨率模糊。可下载apk查看真机效果

基础功能展示跳转基础使用文档 ------ 跳转数据加载监听文档

几句代码实现抖音列表	向上或向下加载数据	设置加载监听

画廊功能展示跳转至此文档

asGallery一句代码搞定	3d画廊

version2.0 跳转至此文档

无线循环模式	自动滚动模式

version2.1.0 跳转至此文档

指示器的使用	指示器自动更新	边缘滑动监听

添加依赖

项目build.gradle添加如下

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

app build.gradle添加如下

dependencies {
        implementation 'com.github.lihangleo2:SmartViewPager2Adapter:2.1.4'
}

基本使用

一、两句代码实现抖音效果

使用此库，你只需在xml加上简单的viewPager2即可，其他只需调用方法即可

1.1、步骤一：初始化adapter

    
    private val mAdapter by lazy {
        SmartViewPager2Adapter(this, mBinding.viewPager2)
            .cancleOverScrollMode()
            .setOffscreenPageLimit(5)
            .setPreLoadLimit(3)
            .addFragment(1, ImageFragment::class.java)
            .addFragment(2, TextFragment::class.java)
            //可以在这里初始化数据
            .addData(list)
    }

1.2、步骤二：设置给viewpager2（做完这下就搞定了，你没看错）

mBinding.viewPager2.adapter = mAdapter

1.3、步骤三：list数据源（注意点）；bean对象要实现接口：SmartFragmentTypeExEntity

解析数据bean要实现SmartFragmentTypeExEntity接口，返回你在adapter里要生成的fragment的type。(也就是说type==1时生成图片fragment，这些逻辑adapter帮你操作了)

//2.1.2 SmartFragmentTypeExEntity 由接口改为抽象类了，整体变化不大
public class SourceBean extends SmartFragmentTypeExEntity {
    int type;

    @Override
    public int getFragmentType() {
        return type;
    }
}

1.4、步骤四：fragment（注意点）

可以看到方法.addFragment(type, Fragment.class)，这里结合步骤三就很清楚了。
比如上面的基础使用里调用了.addFragment(1, ImageFragment::class.java)。最后加载了数据.addData(list)，这样adapter会自动在数据里找到对应的tyep，然后生成你要的fragment。

注意你的fragment必须实现SmartFragmentImpl接口，这个接口是让adapter把数据回传给你，以便你做页面操作。【2.1.0后SmartFragmentImpl接口已舍弃，SmartFragmentImpl2加上泛型可以避免数据类型转换】

public class ImageFragment extends Fragment implements SmartFragmentImpl2<SourceBean> {
    //....伪代码
    @Override
    public void initSmartFragmentData(SourceBean bean) {
        this.mSourceBean = bean
    }
}

二、画廊效果

画廊只需要加上如下代码，无需在xml里写clipChildren="false"这些代码，解放xml

//如果是横向就是左右，竖直的话就是上下。adapter会自己判断
.asGallery(int leftMargin,int rightMargin)

//想要加上滑动效果只需要加上（后续会加上更多效果）
setPagerTransformer(SmartTransformer.TRANSFORMER_ALPHA_SCALE)

三、无线循环和自动滚动

3.1 无线循环

//一句代码即可加上循环模式
.setInfinite(true)

3.2 自动滚动

加上自动滚动功能
```
.isAutoLoop()
```
设置滚动间隔时间
```
.setLoopTime(3000L)
```
设置切换滚动时长（也就是item1滚动到item2所需的时长）

注意scrollTime≤LoopTime时，会滚动的很流畅，请谨慎设置
```
.setScrollTime(600L)
```
滚动模式下绑定当前页面的lifeCycle，提升app性能
```
.addLifecycleObserver()
```

四、数据加载监听和滑动效果

这里我会把重要的方法拿出来讲，其他的会出个表格

4.1 数据加载

向下无感加载数据

.addData(List<SmartFragmentTypeExEntity> list)

向上无感加载数据

.addFrontData(List<SmartFragmentTypeExEntity> list)

移除数据
```
.removeData(index: Int)
```
加载对应type的fragment.class
```
.addFragment(type, Fragment.class)
```

4.2 设置监听

设置头部加载监听（不设置则不触发）
```
.setOnRefreshListener(OnRefreshListener listener)
```
设置底部加载监听（不设置则不触发）
```
.setLoadMoreListener(OnLoadMoreListener listener)
```

同时设置头部和底部监听（不设置则不触发）

.setOnRefreshLoadMoreListener(OnRefreshLoadMoreListener listener)

4.3 结束监听

头部已经不能翻页时，调用。将不再触发头部监听。
```
.finishRefreshWithNoMoreData()
```
底部已经不能翻页时，调用。将不再触发底部监听。
```
.finishLoadMoreWithNoMoreData()
```

4.4 ViewPager2滑动效果

SmartTransformer.TRANSFORMER_3D 3d滑动效果
SmartTransformer.TRANSFORMER_ALPHA_SCALE 缩放透明度效果
```
.setPagerTransformer(SmartTransformer enum)
```

五、指示器的使用和边缘滑动监听

指示器的使用也是非常的简单，如下：（demo里的IndicatorActivity有具体用法）。

特别注意，使用withIndicator(SmartIndicator.CIRCLE) api，必须是viewPage2的父控件是ConstraintLayout布局，否则建议使用xml里的方式，不受父控件约束

    private val mAdapter by lazy {
        SmartViewPager2Adapter(this, mBinding.viewPager1)
            //关键代码
            .withIndicator(SmartIndicator.CIRCLE)
            .addFragment(1, ImageFragment::class.java)
            .addFragment(2, TextFragment::class.java)
            .addData(DataUtil.productDatas(0, isLoadMore = true, isGallery = true, 4))
    }

5.1 指示器详解：

圆形指示器的使用

.withIndicator(SmartIndicator.CIRCLE)

线性指示器的使用

.withIndicator(SmartIndicator.LINE)

以上会默认在居中靠下的位置，设置位置你可以使用以下api

.withIndicator(SmartIndicator.CIRCLE,SmartGravity.LEFT_BOTTOM, ConvertUtils.dp2px(20f),ConvertUtils.dp2px(20f))

你还可以将指示器放在xml里，这样可以更强自定义指示器样式，及把指示器放置你布局里想放置的任何位置，不受父控件影响 xml里如下：

    <com.smart.adapter.indicator.CircleIndicator
        android:id="@+id/circle_indicator"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_marginRight="10dp"
        android:layout_marginBottom="10dp"
        app:layout_constraintBottom_toBottomOf="@+id/viewPager2"
        app:layout_constraintRight_toRightOf="parent"
        app:lh_indicator_mode="fill"
        app:lh_indicator_radius="10dp"
        app:lh_indicator_scrollWithViewPager2="true"
        app:lh_indicator_selectColor="#FF0101"
        app:lh_indicator_space="10dp"
        app:lh_indicator_strokeWidth="1.5dp"
        app:lh_indicator_unselectColor="#FFEB3B" />

代码如下,是不是超级简单：

//关键代码，xml里的指示器
.withIndicator(mBinding.circleIndicator)

5.2 边缘滑动监听：

使用也非常简单，当然此监听也是支持横或者竖的viewPager2

    private val mAdapter by lazy {
        SmartViewPager2Adapter(this, mBinding.viewPager2)
            .setOffscreenPageLimit(3)
            .addFragment(1, ImageFragment::class.java)
            .addFragment(2, TextFragment::class.java)
            .addData(DataUtil.productDatas(0, isLoadMore = true, isGallery = true, 4))
            /**
             * 设置左右边界滑动监听
             * */
            .setOnSideListener(object : onSideListener {
                override fun onLeftSide() {
                    ToastUtils.showShort("触发左边缘事件")

                }
                override fun onRightSide() {
                    ToastUtils.showShort("触发右边缘事件")
                }

            })
    }

六、刷新问题和视频的用法问题

本库开源以后，有很多说刷新问题和视频的问题，这个这里详细讲解一下

6.1 刷新问题：

我们首先是通过.addData()去设置数据源的，然后到了我们的fragment里。以下代码，在fragment里你可以拿到mSourceBean，注意这里的内存地址和数据源list里的内存地址指向一个地方的。记住这一点就好办了。

public class ImageFragment extends Fragment implements SmartFragmentImpl2<SourceBean> {
    private SourceBean mSourceBean;
    //....伪代码
    @Override
    public void initSmartFragmentData(SourceBean bean) {
        this.mSourceBean = bean
    }

    //....伪代码
    private void initView(){
        //一般封装的baseFragement都通过一个方法去初始化页面
        //当然你也可以叫initData()这里随便。拿到mSourceBean去初始化页面
    }
}

需求来了：假设你有一个点赞按钮，点击了，从未点赞状态变成了红色点赞状态如下：

btn.setOnClickListener{
    //第一步：（因为你在fragment里），你要去改变按钮ui的样式
    //第二步：【重点】你要去修改数据源里的点赞字段假设：mSourceBean.isClick = 1
    //执行了第二步以后，你的数据源的isClick字段改变了。因为内存地址一样，数据源list里的数据也改变了。
    //所以，当你随便滑动你的viewPager2，即使超过offscreenPageLimit，
    //页面被销毁了，然后重建，因为数据源在这，样式也会恢复之前的状态。其实就和RecycleView里的Adapter里的用法是一样的
}

以上是对此库页面刷新的用法。其实很简单

6.1 视频在fragment里的用法：

视频用法也是极其简单，我这里放我baseFragment里的封装，我相信大部分开发者都会有一个base，如下：

public abstract BaseFragment{
    //....伪代码
    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
        super.onViewCreated(view, savedInstanceState)
        //初始化子布局
        initView()
    }

    override fun onResume() {
        super.onResume()
        if (!isLoaded && !isHidden) {
            lazyInit()
            isLoaded = true
        }

        if (!isHidden) {
            onVisible()
        }
    }

    override fun onPause() {
        super.onPause()
        onInVisible()
    }
}

这里有3个方法

initView() 在这里你可以初始化你的视频数据，甚至preLoad(因为缓存问题会加载很多个fragment,只要你不播放视频即可)
onVisible() 页面可见时，播放视频
onInVisible() 页面不可见时，暂停播放。假设你滑回这个页面你想从第一帧开始播放，你可以将视频seekTo到第0秒的时间。可以根据你的需求来。

希望我表达清楚了。看懂了也是非常好用！感谢，让我们共同维护这个库，让你在使用ViewPager2的时候，是如此简单

其他方法

name	format	description
.getDataList()	List<SmartFragmentTypeExEntity>	返回数据源
.addDefaultFragment()	SmartFragmentImpl	找不到对应type的默认fragment
cancleOverScrollMode()	void	取消viewpager2边缘阴影
setVertical()	boolean	是否设置竖直viewpager2，默认横向
setOffscreenPageLimit()	integer	设置预加载数量
setPreLoadLimit()	integer	设置滑动到limit触发预加载监听
setUserEnabled()	boolean	是否允许用户左右滑动

赞赏

如果你喜欢 SmartViewPager2Adapter 的功能，感觉 SmartViewPager2Adapter 帮助到了你，可以点右上角 "Star" 支持一下谢谢！ ^_^ 你也还可以扫描下面的二维码~ 请作者喝一杯咖啡。或者遇到工作中比较难实现的需求请作者帮忙。

如果在捐赠留言中备注名称，将会被记录到列表中~ 如果你也是github开源作者，捐赠时可以留下github项目地址或者个人主页地址，链接将会被添加到列表中

捐赠列表

其他作品

万能阴影布局

关于作者。

Android工作多年了，如果你在学习的路上也感觉孤独，请和我一起。让我们在学习道路上少些孤独

QQ群： 209010674 （点击图标，可以直接加入）

Licenses

MIT License

Copyright (c) 2023 leo

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.

Files

README2.0.md

Latest commit

History