这可能是ViewPager2滑动冲突最全处理方案

自去年12月份ViewPager2正式版发布以后,ViewPager2已经逐渐开始替代旧版本的ViewPager。许多开发者也已经在项目中使用了ViewPager2。相比ViewPager,ViewPager2的功能不可谓不强大,我在之前写过的一篇文章《学不动也要学!深入了解ViewPager2 》中对ViewPager2的使用做过详细的讲解。但是,由于当时没有太多实战,所以并没有发现ViewPager2的嵌套使用存在严重的滑动冲突。直到今年三月份用ViewPager2重构BannerViewPager的时候才发现这个问题。因此,在BVP 3.0版本中额外对ViewPager2做了滑动冲突处理,效果还算差强人意。另外,曾在论坛上看到过不少ViewPager2滑动冲突的求助帖子,甚至还有同学因为搜索ViewPager2滑动冲突而找到了BannerViewPager的Github主页。既然如此,不如写篇文章将BVP处理滑动冲突的经验分享给大家,没准还能涨知 (fěn) 识 **(sī)**,嘿嘿嘿。
在这里插入图片描述

一、为什么ViewPager没有滑动冲突?

不知道你是否有这个疑问,在ViewPager时代,ViewPager嵌套ViewPager并没有出现过滑动冲突。可是为什么在ViewPager的升级版ViewPager2中却出现了滑动冲突呢?想要搞清楚这个问题就需要我们深入到ViewPager和ViewPager2的内部分析一下它们的源码了。

我们知道,滑动冲突是需要在onInterceptTouchEvent方法中进行处理的,根据自身条件来决定是否要拦截事件。在ViewPager的源码中看到以下代码(方便阅读,代码做了删减):

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
@Override
public boolean onInterceptTouchEvent(MotionEvent ev) {

final int action = ev.getAction() & MotionEvent.ACTION_MASK;
if (action == MotionEvent.ACTION_CANCEL || action == MotionEvent.ACTION_UP) {
// 在事件取消或者抬起手指后重置状态
resetTouch();
return false;
}


switch (action) {
case MotionEvent.ACTION_MOVE: {
// 这里判断在水平方向上的滑动距离大于竖直方向的2倍,则认为是有效的切换页面的滑动
if (xDiff > mTouchSlop && xDiff * 0.5f > yDiff) {
mIsBeingDragged = true;
// 禁止Parent View拦截事件,即事件要能够传递到ViewPager
requestParentDisallowInterceptTouchEvent(true);
setScrollState(SCROLL_STATE_DRAGGING);
} else if (yDiff > mTouchSlop) {
mIsUnableToDrag = true;
}
break;
}

case MotionEvent.ACTION_DOWN: {
if (mScrollState == SCROLL_STATE_SETTLING
&& Math.abs(mScroller.getFinalX() - mScroller.getCurrX()) > mCloseEnough) {
// 在Down事件中禁止Parent View拦截事件,是为了事件序列能够传递到ViewPager
requestParentDisallowInterceptTouchEvent(true);
setScrollState(SCROLL_STATE_DRAGGING);
} else {
completeScroll(false);
mIsBeingDragged = false;
}
break;
}

case MotionEvent.ACTION_POINTER_UP:
onSecondaryPointerUp(ev);
break;
}
return mIsBeingDragged;
}

可以看到在ACTION_DOWN与ACTION_MOVE中根据一些判断条件调用了requestParentDisallowInterceptTouchEvent(true)方法来禁止Parent View拦截事件,也就是说ViewPager已经帮我们处理了滑动冲突,所以我们只管用即可,无需担心滑动冲突问题。

现在,我们转到ViewPager2中,翻阅源码发现只有在RecyclerView 的实现类中有onInterceptTouchEvent的相关方法,而且这句代码仅仅是处理禁用了用户输入的逻辑!

1
2
3
4
5
6
7
8
9
private class RecyclerViewImpl extends RecyclerView {

.... // 省略部分代码

@Override
public boolean onInterceptTouchEvent(MotionEvent ev) {
return isUserInputEnabled() && super.onInterceptTouchEvent(ev);
}
}

也就是说ViewPager2其实并没有帮我们处理滑动冲突!这是为什么呢?难道是ViewPager2的开发者们把这件事忘了?这里我敢保证肯定不是这样子的。其实,只要我们看一看ViewPager2的结构大概就能知道了。ViewPager2被声明了final,意味着我们不能像继承ViewPager一样来修改ViewPager2。如果官方在ViewPager2内部自行处理了滑动冲突,那么如果有特殊的需求,需要根据我们自己的情况来处理ViewPager2的滑动,那么官方写的处理滑动冲突的代码是不是会影响到我们自己的需求?所以我觉得也正因为这样,干脆不做任何处理,全权交给了开发者自行解决。

二、滑动冲突的处理方案

既然官方不给我们处理,那就需要我们自己动手了。在开始之前我们先来了解以下处理滑动冲突的两种方案。既然出现滑动冲突,那么一定是由于两个布局相互嵌套引起的 。既然是两个布局,那么我们就可以分为两个方向来处理。即所谓的外部拦截法内部拦截法

1.外部拦截法

所谓的“外部拦截法“中的外部是指出现滑动冲突的这两个布局的外层。我们知道,一个事件序列是由Parent View先获取到的,如果Parent View不拦截事件那么才会交由子View去处理。既然是外层先获知事件,那外层View根据自身情况来决定是否要拦截事件不就行了吗?因此外部拦截法的实现是非常简单的,大概思路如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
public boolean onInterceptTouchEvent(MotionEvent event) {
boolean intercepted = false;
int x = (int) event.getX();
int y = (int) event.getY();
switch (event.getAction()) {
case MotionEvent.ACTION_DOWN: {
intercepted = false;
break;
}
case MotionEvent.ACTION_MOVE: {
if (needIntercept) { // 这里根据需求判断是否需要拦截
intercepted = true;
} else {
intercepted = false;
}
break;
}
case MotionEvent.ACTION_UP: {
intercepted = false;
break;
}
default:
break;
}
mLastXIntercept = x;
mLastYIntercept = y;
return intercepted;
}

2.内部拦截法

所谓的”内部拦截法“指的是对内部的View做文章,让内部View决定是不是拦截事件。但是现在就有问题了,你怎么知道外部的View是不是要拦截事件啊??如果外部View把事件拦截了,内部的View岂不是连西北风都喝不到了?别着急,Google官方当然有考虑到这种情况。在ViewGroup中有一个叫requestDisallowInterceptTouchEvent的方法,这个方法接受一个boolean值,意思是是否要禁止ViewGroup拦截当前事件。如果是true的话那么该ViewGroup则无法对事件进行拦截。有了这个方法那我们就可以让内部View大显神通了。来看下内部拦截法的代码:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
public boolean dispatchTouchEvent(MotionEvent event) {
int x = (int) event.getX();
int y = (int) event.getY();

switch (event.getAction()) {
case MotionEvent.ACTION_DOWN: {
// 禁止parent拦截down事件
parent.requestDisallowInterceptTouchEvent(true);
break;
}
case MotionEvent.ACTION_MOVE: {
int deltaX = x - mLastX;
int deltaY = y - mLastY;
if (disallowParentInterceptTouchEvent) { // 根据需求条件来决定是否让Parent View拦截事件。
parent.requestDisallowInterceptTouchEvent(false);
}
break;
}
case MotionEvent.ACTION_UP: {
break;
}
default:
break;
}

mLastX = x;
mLastY = y;
return super.dispatchTouchEvent(event);
}

这么处理之后,两个嵌套View就可以和谐工作了。

下面是来自外部View和内部View的对话。

外部View:”我想拦截事件!“

内部View:”不,你不想。这事件我要定了,耶稣都留不住他。“
开发不容易,P图靠自己

三、处理ViewPager2的滑动冲突

上一章讲了滑动冲突处理的两种方案,那么本章我们就来解决ViewPager2的滑动冲突。首先,应该确定一下存在在哪些需要拦截和不需要拦截的边界条件。在写这篇文章之前,我Google搜索了一下ViewPager2的滑动冲突处理方案,关于这方面的文章还不算少,不过大部分的文章对于ViewPager2的滑动冲突处理考虑的都不够完善。

下面我们详细来分析一下:

  • 如果设置了userInputEnable=false,那么ViewPager2不应该拦截任何事件;
  • 如果只有一个Item,那么ViewPager2也不应该拦截事件;
  • 如果是多个Item,且当前是第一个页面,那么只能拦截向左的滑动事件,向右的滑动事件就不应该由ViewPager2拦截了;
  • 如果是多个Item,且当前是最后一个页面,那么只能拦截向右的滑动事件,向左的滑动事件不应该由当前的ViewPager2拦截;
  • 如果是多个Item,且是中间页面,那么无论向左还是向右的事件都应该由ViewPager2拦截;
  • 最后,由于ViewPager2是支持竖直滑动的,那么竖直滑动也应该考虑以上条件。

分析完了边界条件之后,我们看下应该使用哪种方案来处理滑动冲突?很明显,这里应该使用内部拦截法处理。但是,由于ViewPager2被设置成了final,我们无法通过继承的方式来处理,因此就需要我们在ViewPager2外部加一层自定义的Layout。这层Layout其实相当于夹在了内层View和外层View的中间,其实就是这层Layout就变成了内层。好了,废话不多说了,直接贴代码了。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
class ViewPager2Container @JvmOverloads constructor(context: Context, attrs: AttributeSet? = null, defStyleAttr: Int = 0) : RelativeLayout(context, attrs, defStyleAttr) {

private var mViewPager2: ViewPager2? = null
private var disallowParentInterceptDownEvent = true
private var startX = 0
private var startY = 0

override fun onFinishInflate() {
super.onFinishInflate()
for (i in 0 until childCount) {
val childView = getChildAt(i)
if (childView is ViewPager2) {
mViewPager2 = childView
break
}
}
if (mViewPager2 == null) {
throw IllegalStateException("The root child of ViewPager2Container must contains a ViewPager2")
}
}

override fun onInterceptTouchEvent(ev: MotionEvent): Boolean {
val doNotNeedIntercept = (!mViewPager2!!.isUserInputEnabled
|| (mViewPager2?.adapter != null
&& mViewPager2?.adapter!!.itemCount <= 1))
if (doNotNeedIntercept) {
return super.onInterceptTouchEvent(ev)
}
when (ev.action) {
MotionEvent.ACTION_DOWN -> {
startX = ev.x.toInt()
startY = ev.y.toInt()
parent.requestDisallowInterceptTouchEvent(!disallowParentInterceptDownEvent)
}
MotionEvent.ACTION_MOVE -> {
val endX = ev.x.toInt()
val endY = ev.y.toInt()
val disX = abs(endX - startX)
val disY = abs(endY - startY)
if (mViewPager2!!.orientation == ViewPager2.ORIENTATION_VERTICAL) {
onVerticalActionMove(endY, disX, disY)
} else if (mViewPager2!!.orientation == ViewPager2.ORIENTATION_HORIZONTAL) {
onHorizontalActionMove(endX, disX, disY)
}
}
MotionEvent.ACTION_UP, MotionEvent.ACTION_CANCEL -> parent.requestDisallowInterceptTouchEvent(false)
}
return super.onInterceptTouchEvent(ev)
}

private fun onHorizontalActionMove(endX: Int, disX: Int, disY: Int) {
if (mViewPager2?.adapter == null) {
return
}
if (disX > disY) {
val currentItem = mViewPager2?.currentItem
val itemCount = mViewPager2?.adapter!!.itemCount
if (currentItem == 0 && endX - startX > 0) {
parent.requestDisallowInterceptTouchEvent(false)
} else {
parent.requestDisallowInterceptTouchEvent(currentItem != itemCount - 1
|| endX - startX >= 0)
}
} else if (disY > disX) {
parent.requestDisallowInterceptTouchEvent(false)
}
}

private fun onVerticalActionMove(endY: Int, disX: Int, disY: Int) {
if (mViewPager2?.adapter == null) {
return
}
val currentItem = mViewPager2?.currentItem
val itemCount = mViewPager2?.adapter!!.itemCount
if (disY > disX) {
if (currentItem == 0 && endY - startY > 0) {
parent.requestDisallowInterceptTouchEvent(false)
} else {
parent.requestDisallowInterceptTouchEvent(currentItem != itemCount - 1
|| endY - startY >= 0)
}
} else if (disX > disY) {
parent.requestDisallowInterceptTouchEvent(false)
}
}

/**
* 设置是否允许在当前View的{@link MotionEvent#ACTION_DOWN}事件中禁止父View对事件的拦截,该方法
* 用于解决CoordinatorLayout+CollapsingToolbarLayout在嵌套ViewPager2Container时引起的滑动冲突问题。
*
* 设置是否允许在ViewPager2Container的{@link MotionEvent#ACTION_DOWN}事件中禁止父View对事件的拦截,该方法
* 用于解决CoordinatorLayout+CollapsingToolbarLayout在嵌套ViewPager2Container时引起的滑动冲突问题。
*
* @param disallowParentInterceptDownEvent 是否允许ViewPager2Container在{@link MotionEvent#ACTION_DOWN}事件中禁止父View拦截事件,默认值为false
* true 不允许ViewPager2Container在{@link MotionEvent#ACTION_DOWN}时间中禁止父View的时间拦截,
* 设置disallowIntercept为true可以解决CoordinatorLayout+CollapsingToolbarLayout的滑动冲突
* false 允许ViewPager2Container在{@link MotionEvent#ACTION_DOWN}时间中禁止父View的时间拦截,
*/
fun disallowParentInterceptDownEvent(disallowParentInterceptDownEvent: Boolean) {
this.disallowParentInterceptDownEvent = disallowParentInterceptDownEvent
}
}

上边代码限于篇幅我就不做过多解释了,注意一下在onFinishInflate中我们通过循环,遍历了ViewPager2Container的所有子View,如果没有找到ViewPager2就抛出异常。另外,disallowParentInterceptDownEvent方法注释写的比较详细就不多说了。

使用方法也很简单,直接用ViewPager2Container包裹ViewPager2即可:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
<com.zhpan.sample.viewpager2.ViewPager2Container
android:layout_width="match_parent"
android:layout_height="match_parent"
app:layout_constraintBottom_toBottomOf="parent"
app:layout_constraintLeft_toLeftOf="parent"
app:layout_constraintRight_toRightOf="parent"
app:layout_constraintTop_toTopOf="parent">

<androidx.viewpager2.widget.ViewPager2
android:id="@+id/view_pager2"
android:layout_width="match_parent"
android:layout_height="match_parent" />

<com.zhpan.indicator.IndicatorView
android:id="@+id/indicatorView"
android:layout_centerHorizontal="true"
android:layout_alignParentBottom="true"
android:layout_margin="@dimen/dp_20"
android:layout_width="wrap_content"
android:layout_height="wrap_content"/>

</com.zhpan.sample.viewpager2.ViewPager2Container>

这是关于ViewPager2滑动出冲突的处理方案,当然,由于BannerViewPager支持循环轮播,所以BannerViewPager的滑动冲突处理相对会更麻烦些。如果有兴趣的同学可以点击查看BannerViewPager的源码。

同时,ViewPager2Container 的源码我也放到了Github,需要用到的可以自取。


本博客所有文章除特别声明外,均采用 CC BY-SA 4.0 协议 ,转载请注明出处!

开源库推荐
1.BannerViewPager

一个基于ViewPager2实现的具有强大功能的无限轮播库。支持多种页面切换效果和指示器样式。

2.ViewPagerIndicator

一个适用于ViewPager和ViewPager2的指示器,支持多种滑块样式及滑动模式