Vant2 源码分析之 vant-sticky

前言

原打算借鉴 vant-sticky 源码，实现业务需求的某个功能，第一眼看以为看懂了，拿来用的时候，才发现一知半解。看第二遍时，对不起，是我肤浅了。这里侧重分析实现原理，其他部分不拓展开来，否则像滚雪球越滚越多了。一边读源码，一边学习使用技巧吧，这里记录下心得感悟，和大家共勉。

接下来会分析这三个的源码实现，因为项目用的 Vue2，故参考 Vant2 的 v2.12.54 版本，

在这里插入图片描述
而该版本未实现 Vant3 的吸底距离功能，故不做分析，同学们交给你们啦。

如果只关注实现原理，不关注每个部分实现细节的话，可以跳到 onScroll 滚动事件部分。

项目启动和调试

clone 项目：

git clone https://github.com/youzan/vant.git

切换版本：

git checkout v2.12.54

安装和启动项目：
在这里插入图片描述

npm run bootstrap
npm run dev

调试过程中，可以打印些计算值，帮助理解

源码分析

找到 vant-sticky 目录后，开始我们的源码分析吧
在这里插入图片描述

html 部分

render() {const { fixed } = this;const style = {height: fixed ? `${this.height}px` : null,};return (<div style={style}> // 1// bem({ fixed }) 生成 'vant-sticky--fixed'<div class={bem({ fixed })} style={this.style}> // 2{this.slots()}</div></div>);}

1 为包裹元素用于占位，因为内部元素 class=‘vant-sticky–fixed’ 是用 fixed 实现的，会脱离文档流。
2 class 和 style 都是根据 fixed 去决定是否展示。如下可见 class=‘vant-sticky–fixed’ 内容是固定的，而 style 是计算属性，动态变化的。

因此，这里学习到的两个技巧是，

元素使用 fixed 时，为了不影响滚动效果，布局错乱，可以包裹一个父元素去保持占位。
由同个变量去控制一个元素的样式变化，而静态的样式放到 class 里，动态的放到 style 里。

css 部分

@import '../style/var';.van-sticky {&--fixed {position: fixed;top: 0;right: 0;left: 0;z-index: @sticky-z-index; // @sticky-z-index: 99;}
}

@import ‘…/style/var’ 定义了 less 变量，@sticky-z-index: 99;

  computed: {style() {// 意味着 fixed 改变的同时， style 也改变了if (!this.fixed) {// 也就不设置 style 了，因为是动态响应 dom 元素的return;}const style = {};if (isDef(this.zIndex)) {// 修改层级，vant 默认在 vant-sticky--fixed 里变量定义为 99，这里通过传参修改style.zIndex = this.zIndex; }if (this.offsetTopPx && this.fixed) {style.top = `${this.offsetTopPx}px`; // 通过设置 top，来设置偏移量}if (this.transform) {style.transform = `translate3d(0, ${this.transform}px, 0)`;}return style;},},

初始的生命周期部分

created 生命周期

created() {// compatibility: https://caniuse.com/#feat=intersectionobserver// vant2 使用 SSR 写的，故有 isServer 是否在服务器运行的判断// window.IntersectionObserver ie11 不支持if (!isServer && window.IntersectionObserver) {this.observer = new IntersectionObserver(// entries是一个数组，每个成员都是一个 IntersectionObserverEntry 对象// 有几个被观察的成员就有几个对象(entries) => {// 每次元素进入可视区 或 离开可视区时 触发if (entries[0].intersectionRatio > 0) {this.onScroll();}},// root 属性指定目标元素所在的容器节点（即根元素）{ root: document.body });}},

window.IntersectionObserver 自动观察元素是否可见（本质是目标元素与视口产生一个交叉区，只有线程空闲下来，才会执行观察器），详见阮一峰的 IntersectionObserver API 使用教程

后续会用到，虽然把 IntersectionObserver 相关部分全都注释掉，也不影响使用。

// 用法
this.observer = new IntersectionObserver(callback, option)// 开始观察
this.observer.observe(this.$el);// 停止观察
this.observer.unobserve(this.$el);// 关闭观察器
this.observer.disconnect();

通过 mixins，混入生命周期函数 mounted、activated、deactivated、beforeDestroy 以绑定和取消监听事件

mixins: [BindEventMixin(function (bind, isBind) { // 1 BindEventMixin 建议先看下面的说明部分，再往下看if (!this.scroller) {this.scroller = getScroller(this.$el); // getScroller 从当前元素一直向上找到带有滚动属性的元素}// IntersectionObserver 的对象if (this.observer) {// 当绑定时，isBind 为 true，开始观察// 当取消监听时，isBind 为 false，停止观察const method = isBind ? 'observe' : 'unobserve'; this.observer[method](this.$el);}// bind 即为 on（ addEventListener）bind(this.scroller, 'scroll', this.onScroll, true);this.onScroll();}),],

1 简单分析下 BindEventMixin 实现如下

import { on, off } from '../utils/dom/event';let uid = 0;
// 入参 handler 是个函数
export function BindEventMixin(handler) {const key = `binded_${uid++}`; // 记录绑定function bind() {if (!this[key]) { // 没有绑定handler.call(this, on, true); // 把 on（即 addEventListener）传给 handler,第三个参数是告知 handler 当前状态是否绑定this[key] = true; // 标记绑定}}function unbind() {if (this[key]) { // 绑定了，则取消监听事件handler.call(this, off, false); // 把 off （即 removeEventListener ）传给 handlerthis[key] = false; // 标记w未绑定}}// 通过 mixins，混入生命周期函数，以绑定和取消监听事件return {mounted: bind, activated: bind,deactivated: unbind,beforeDestroy: unbind,};
}

因此这里学习到的技巧是，我们也可以通过 mixins 的方式去自动的绑定和取消监听事件。前提是，符合这些生命周期，需要一开始载入便监听的，但 watch 某个数据变化，去手动的监听和取消监听就不太适用了。当然，也可以依据情况改造下函数。

props 和 data 部分

简单看下传值和变量定义部分

  props: {zIndex: [Number, String], // 吸顶时的 z-indexcontainer: null, // 容器对应的 HTML 节点，类型 ElementoffsetTop: { // 吸顶时与顶部的距离，支持 px vw vh rem 单位，默认 pxtype: [Number, String],default: 0,},},data() {return {fixed: false,height: 0, // 元素本身高度transform: 0, // 偏移量，只在有容器，且展示吸底效果时，有用到};},

onScroll 滚动事件部分

先搞清楚几个概念：
scrollTop 为滚动的距离
window.scrollTop:
在这里插入图片描述

getBoundingClientRect():其提供了元素的大小及其相对于视口的位置
el.getBoundingClientRect().top:
在这里插入图片描述
可以发现，在向上滚动的过程中，window.scrollTop 不断增加，el.getBoundingClientRect().top 不断减少。而增加的部分刚好等于减少的部分。

如果元素的顶部超出视口，那么 el.getBoundingClientRect().top 为负值，window.scrollTop 还是不断增加。

可以得出，在滚动的过程中， el.getBoundingClientRect().top + window.scrollTop 的值始终是不变的，也就是，元素初始的位置到视口顶部的距离，此时 window.scrollTop 为 0。

接下来是重中之重的 onScroll 滚动事件部分，先从 1、2 开始讲起
在这里插入图片描述
offsetHeight：一个元素本身的高度 + padding+border+滚动条，不包括伪元素

因此在上面的基础上，加上 el.offsetHeight，也就是元素的初始位置的底部到视口顶部的距离
el.getBoundingClientRect().top + window.scrollTop + el.offsetHeight

实现原理：
scrollTop + offsetTopPx > topToPageTop
当页面滚动距离 + 偏移量大于目标元素一开始距离顶部的距离时，目标元素设置 fixed 属性，吸顶。至于偏移量，通过设置 top 属性去偏移。
当页面滚动距离 + 偏移量小于目标元素一开始距离定都的距离时，意味着滚回去了，那么移除 fixed 属性

  methods: {onScroll() {// 判断当前元素，及祖先元素是否隐藏了，隐藏了就不需要滚动了if (isHidden(this.$el)) {return;}this.height = this.$el.offsetHeight; // 当前元素的高度，可用于占位，一直不变的// offsetTopPx() 方法将 px vw vh rem 单位传值转换为 pxconst { container, offsetTopPx } = this;// window 滚动的距离 window.scrollTopconst scrollTop = getScrollTop(window);// getElementTop() 返回 el.getBoundingClientRect().top + window.scrollTop// 上面分析过，保持不变，也就是 元素一开始与顶部的距离const topToPageTop = getElementTop(this.$el);const emitScrollEvent = () => {this.$emit('scroll', {scrollTop,isFixed: this.fixed,});};// 先注释掉该部分后面讲解，目前的部分足够实现 1 2 效果// if (container) {//   ... // }// 当滚动距离达到指定上限：页面滚动的距离+偏移 > 元素一开始与顶部的距离 // offsetTopPx 偏移，会用设置 top 来解决if (scrollTop + offsetTopPx > topToPageTop) {this.fixed = true; // 设置 fixed 属性，目标元素视口吸顶this.transform = 0; // 重置因吸底容器效果而产生的偏移 transform，后面会提到。} else {// 当滚回顶部时，取消 fixedthis.fixed = false;}emitScrollEvent();},}

接下来，分析 3 指定容器的情况。
在这里插入图片描述
有点特殊的是，目标元素到达视口顶部时，需要吸顶。而视口顶部到容器底部的距离，小于目标元素时，应该吸底容器，如下图。
而在该特殊情况出现之前，页面滚动+偏移距离超出元素一开始到视口顶部距离时，吸顶（这部分和容器没有关系）。代码实现和 1 2 部分相同
在这里插入图片描述
如果在容器和元素之间再放个元素，是否也有吸底效果呢

<div ref="container" style="height: 150px; background-color: #fff"><van-button type="warning">假容器</van-button><van-sticky :container="container" :offset-top="20"><van-button type="warning" style="margin-left: 215px">指定容器</van-button></van-sticky>

在这里插入图片描述
看样子，这一版并不支持上述情况。因此，默认目标元素一开始的位置是在容器边缘。下面的源码分析，也就排除这一情况了。

实现原理：
scrollTop + offsetTopPx + this.height > bottomToPageTop
当页面滚动距离 + 偏移 + 目标元素高度，超出了容器一开始的底部到视口顶部的距离

如果超出部分小于元素高度，则展示吸底效果。设置 fixed 吸顶，在通过 transfom 向上移动超出的距离，以达到吸底容器的效果。

如果完全超出元素高度，则消除所有静态、动态样式，回到原样。

下面部分代码，便是上述特殊吸底情况的分析。

  if (container) {// 借鉴上面的分析，排除不支持的情况后// el.getBoundingClientRect().top + window.scrollTop 一开始目标元素到视口顶部的距离// 加上 container.offsetHeight 容器自身的高度，为容器一开始从底部到视口顶部的距离const bottomToPageTop = topToPageTop + container.offsetHeight;// 页面滚动的距离+偏移+目标元素的高度 > 容器一开始从底部到顶部的距离// 意味着，如果保持 fixed 的状态，目标元素会超出容器底部，这时候应该让它吸底if (scrollTop + offsetTopPx + this.height > bottomToPageTop) {// 目标元素超出底部的距离 = 目标元素高度 + 页面滚动距离 - 容器一开始的底部到顶部的距离// 为什么不考虑偏移呢？因为此时视觉上已经超出容器底部了，不需要管偏移，而是要吸附容器底部了const distanceToBottom = this.height + scrollTop - bottomToPageTop;// 超出距离 < 元素高度// 没有全部超出，元素吸底展示if (distanceToBottom < this.height) {// 给个 fixed 吸顶，通过调整 transform 往上移动使得 视觉上元素到了容器的底部this.fixed = true;// 需往上移动的距离为，超出的距离 + top 值的大小（抵消掉 top 值，因为原先的 top 值还在）this.transform = -(distanceToBottom + offsetTopPx);} else {// 完全超出，解除 fixed// 意味着 class='van-sticky--fixed' 删除，动态的 style 返回 {} this.fixed = false;}emitScrollEvent();return;}