本文为 Nick Rout 发布于 Medium 的文章译文
原文链接为 Detecting snap changes with Android’s RecyclerView SnapHelper
本文仅作为个人学习记录所用。如有涉及侵权，请相关人士尽快联系译文作者。
SnapHelper 是 AndroidX RecyclerView 软件包的重要补充。 简而言之，它可用于更改 RecyclerView 的行为，用于辅助 RecyclerView 在滚动结束时将 Item 对齐到某个位置。
目前，基本 SnapHelper 类有两种标准实现； LinearSnapHelper 和 PagerSnapHelper，它们各自提供的功能略有不同。 两者都支持水平和垂直方向。
LinearSnapHelper 适用于较小的项目，并将目标子视图的中心对齐到 RecyclerView 的中心：
PagerSnapHelper适用于全屏项目，其行为类似于ViewPager：
使用这些类的API非常简单：
val snapHelper = LinearSnapHelper() // Or PagerSnapHelper
snapHelper.attachToRecyclerView(recyclerView)
缺少API的情况️♀️
如果我们想知道捕捉位置何时更改该怎么办？ 例如，也许我们正在使用 PagerSnapHelper，并且想要显示一个页面指示器。
不幸的是，在撰写本文时，尚不存在此类 API 。 对于这样的回调，甚至存在一个开放的问题，已经存在了一段时间。
我们将如何实施呢？ SnapHelper 类很复杂且不是非常模块化，因此扩展它们（或编写新的子类）将很痛苦。 幸运的是，我们可以利用现有的 RecyclerView 类和一些 Kotlin 魔术来实现这一目标。
查找当前的捕捉位置
我们需要的第一件事是确定当前捕捉位置的方法。 同样，目前尚不存在此类 SnapHelper 函数，我们将必须自行实现此功能。
SnapHelper 提供的功能是一种查找当前快照视图的方法。 我们必须传递 SnapHelper 附加到的 RecyclerView 使用的 LayoutManager：
val layoutManager = recyclerView.layoutManager
val snapView = snapHelper.findSnapView(layoutManager)
然后，我们可以使用此 LayoutManager 来确定此 View 的位置：
val snapPosition = layoutManager.getPosition(snapView)
我们可以为 Kotlin 扩展函数中的可重用性而巧妙地将其包装起来，同时还要考虑到一些可为空性方面：
package com.nickrout.snaphelperlistener
import androidx.recyclerview.widget.RecyclerView
import androidx.recyclerview.widget.SnapHelper
fun SnapHelper.getSnapPosition(recyclerView: RecyclerView): Int {
val layoutManager = recyclerView.layoutManager ?: return RecyclerView.NO_POSITION
val snapView = findSnapView(layoutManager) ?: return RecyclerView.NO_POSITION
return layoutManager.getPosition(snapView)
}
监听捕捉位置变化
在深入研究如何确定捕捉位置变化之前，我们先定义一个简单的回调接口：
package com.nickrout.snaphelperlistener
interface OnSnapPositionChangeListener {
fun onSnapPositionChange(position: Int)
}
确定捕捉位置变化
我们知道，捕捉位置只会在滚动过程中改变。 因此，为了确定更改，我们将结合先前定义的getSnapPosition 函数和 OnScrollListener 的自定义子类。 重要的是要注意，我们仅想知道捕捉位置何时发生变化，因此我们的类需要保留对最后一个已知位置的引用，以便仅在此位置不同时才触发回调。 关键功能：
private var snapPosition = RecyclerView.NO_POSITION
override fun onScrolled(recyclerView: RecyclerView, dx: Int, dy: Int) {
maybeNotifySnapPositionChange(recyclerView)
}
private fun maybeNotifySnapPositionChange(recyclerView: RecyclerView) {
val snapPosition = snapHelper.getSnapPosition(recyclerView)
val snapPositionChanged = this.snapPosition != snapPosition
if (snapPositionChanged) {
onSnapPositionChangeListener
.onSnapPositionChange(snapPosition)
this.snapPosition = snapPosition
}
}
添加选项以在滚动完成时通知
上面的实现将在滚动事件期间将所有捕捉位置更改通知我们，特别是在使用 LinearSnapHelper 时。 也许我们只想知道最终的捕捉位置是什么（即，当滚动状态变为空闲状态时）？
首先，让我们定义一个枚举类来指定以下两个选项：
enum class Behavior {
NOTIFY_ON_SCROLL,
NOTIFY_ON_SCROLL_STATE_IDLE
}
然后，我们使用第二个 OnScrollListener 回调来实现此目的：
override fun onScrollStateChanged(recyclerView: RecyclerView, newState: Int) {
if (newState == RecyclerView.SCROLL_STATE_IDLE) {
maybeNotifySnapPositionChange(recyclerView)
}
}
最终课程
我们的最终课程融合了上述所有功能，同时还使用了可空性和默认参数：
package com.nickrout.snaphelperlistener
import androidx.recyclerview.widget.RecyclerView
import androidx.recyclerview.widget.SnapHelper
class SnapOnScrollListener(
private val snapHelper: SnapHelper,
var behavior: Behavior = Behavior.NOTIFY_ON_SCROLL,
var onSnapPositionChangeListener: OnSnapPositionChangeListener? = null
) : RecyclerView.OnScrollListener() {
enum class Behavior {
NOTIFY_ON_SCROLL,
NOTIFY_ON_SCROLL_STATE_IDLE
}
private var snapPosition = RecyclerView.NO_POSITION
override fun onScrolled(recyclerView: RecyclerView, dx: Int, dy: Int) {
if (behavior == Behavior.NOTIFY_ON_SCROLL) {
maybeNotifySnapPositionChange(recyclerView)
}
}
override fun onScrollStateChanged(recyclerView: RecyclerView, newState: Int) {
if (behavior == Behavior.NOTIFY_ON_SCROLL_STATE_IDLE
&& newState == RecyclerView.SCROLL_STATE_IDLE) {
maybeNotifySnapPositionChange(recyclerView)
}
}
private fun maybeNotifySnapPositionChange(recyclerView: RecyclerView) {
val snapPosition = snapHelper.getSnapPosition(recyclerView)
val snapPositionChanged = this.snapPosition != snapPosition
if (snapPositionChanged) {
onSnapPositionChangeListener?.onSnapPositionChange(snapPosition)
this.snapPosition = snapPosition
}
}
}
我们将新类与现有的 RecyclerView 和 SnapHelper 连接起来，如下所示：
val snapOnScrollListener = SnapOnScrollListener(snapHelper, behavior, onSnapPositionChangeListener)
recyclerView.addOnScrollListener(snapOnScrollListener)
添加便捷的扩展功能
我们当前的实现效果很好，但是我们可以通过使用另一个扩展功能来减少设置所需的样板代码。
我们要确保新的 OnSnapPositionChangeListener 和 SnapOnScrollListener 类的设置一致。 我们还希望保持“行为”选项可用：
package com.nickrout.snaphelperlistener
import androidx.recyclerview.widget.RecyclerView
import androidx.recyclerview.widget.SnapHelper
fun RecyclerView.attachSnapHelperWithListener(
snapHelper: SnapHelper,
behavior: SnapOnScrollListener.Behavior = SnapOnScrollListener.Behavior.NOTIFY_ON_SCROLL,
onSnapPositionChangeListener: OnSnapPositionChangeListener) {
snapHelper.attachToRecyclerView(this)
val snapOnScrollListener = SnapOnScrollListener(snapHelper, onSnapPositionChangeListener, behavior)
addOnScrollListener(snapOnScrollListener)
}
现在，我们有一种简单的方法可以将 RecyclerView 与 SnapHelper 联系在一起，同时还可以监听捕捉位置的变化：
recyclerView.attachSnapHelperWithListener(snapHelper, behavior, onSnapPositionChangeListener)
我希望这篇文章，可以帮助你对 SnapHelper 有更深入的了解。