摘要：咱們?yōu)榧磳懙膸炱饌€(gè)名字為，開始就是如下的樣子啦處理傳進(jìn)來的參數(shù)我們需要在類的構(gòu)造函數(shù)中接收參數(shù)，并覆蓋默認(rèn)參數(shù)。

常見的js插件都很少使用ES6的class，一般都是通過構(gòu)造函數(shù)，而且常常是手寫CMD、AMD規(guī)范來封裝一個(gè)庫，比如這樣：

// 引用自：https://www.jianshu.com/p/e65c246beac1
;(function(undefined) {
    "use strict"
    var _global;
    var plugin = {
      // ...
    }
    _global = (function(){ return this || (0, eval)("this"); }());
    if (typeof module !== "undefined" && module.exports) {
        module.exports = plugin;
    } else if (typeof define === "function" && define.amd) {
        define(function(){return plugin;});
    } else {
        !("plugin" in _global) && (_global.plugin = plugin);
    }
}());

但現(xiàn)在都9102年了，是時(shí)候祭出我們的ES6大法了，可以用更優(yōu)雅的的寫法來實(shí)現(xiàn)一個(gè)庫，比如這樣：

class RememberScroll {
    constructor(options) {
        ...
    }
}
export default RememberScroll

在這篇文章，博主主要通過分享最近自己寫的一個(gè)記住頁面滾動位置小插件，講一下如何用class語法配合webpack 4.x和babel 7.x封裝一個(gè)可用的庫。

項(xiàng)目地址：Github， 在線Demo：Demo

喜歡的朋友希望能點(diǎn)個(gè)Star收藏一下，非常感謝。

相信很多同學(xué)都會遇到這樣一個(gè)需求：用戶瀏覽一個(gè)頁面并離開后，再次打開時(shí)需要重新定位到上一次離開的位置。

這個(gè)需求很常見，我們平時(shí)在手機(jī)上閱讀微信公眾號的文章頁面就有這個(gè)功能。想要做到這個(gè)需求，也比較好實(shí)現(xiàn)，但博主有點(diǎn)懶，心想有沒有現(xiàn)成的庫可以直接用呢？于是去GitHub上搜了一波，發(fā)現(xiàn)并沒有很好的且符合我需求的，于是得自己實(shí)現(xiàn)一下。

為了靈活使用（只是部分頁面需要這個(gè)功能），博主在項(xiàng)目中多帶帶封裝了這個(gè)庫，本來是在公司項(xiàng)目中用的，后來想想何不開源出來呢？于是有了這個(gè)分享，這也是對自己工作的一個(gè)總結(jié)。

博主喜歡在做一件事情前先yy一下預(yù)期的效果。博主希望這個(gè)庫用起來盡量簡單，最好是插入一句代碼就可以了，比如這樣：

在想要加上記住用戶瀏覽位置的頁面上引入一下庫，然后new RememberScroll()初始化一下即可。

下面就帶著這個(gè)目標(biāo)，一步一步去實(shí)現(xiàn)啦。

用戶瀏覽頁面的位置，主要需要存兩個(gè)字段：哪個(gè)頁面和離開時(shí)的位置，通過這兩個(gè)字段，我們才可以在用戶第二次打開網(wǎng)站的頁面時(shí)，命中該頁面，并自動跳轉(zhuǎn)到上一次離開的位置。

記住瀏覽位置，需要將用戶離開前的瀏覽位置記錄在客戶端的瀏覽器中。這些信息可以主要存放在：cookie、sessionStorage、localStorage中。

存放在cookie，大小4K，空間雖有限但也勉強(qiáng)可以。但cookie是每次請求服務(wù)器時(shí)都會攜帶上的，無形中增加了帶寬和服務(wù)器壓力，所以總體來說是不太合適的。

存放在sessionStorage中，由于僅在當(dāng)前會話下有效，用戶離開頁面sessionStorage就會被清除，所以不能滿足我們的需求。

存放在localStorage,瀏覽器可永久保存，大小一般限制5M，滿足我們需求。

綜上，最后我們應(yīng)該選擇localStorage。

一個(gè)站點(diǎn)可能有很多頁面，如何標(biāo)識是哪個(gè)頁面呢？

一般來說可以用頁面的url作為頁面的唯一標(biāo)識，比如：www.xx.com/article/${id},不同的id對應(yīng)不同的頁面。

但博主考慮到現(xiàn)在很多站點(diǎn)都是用spa了，而且常見在url后面會帶有#xxx的哈希值，如www.xx.com/article/${id}#tag1和www.xx.com/article/${id}#tag2這種情況，這可能表示的是同一個(gè)頁面的不同錨點(diǎn)，所以用url作為頁面的唯一標(biāo)識不太可靠。

因此，博主決定將這個(gè)頁面唯一標(biāo)識作為一個(gè)參數(shù)來讓使用者來決定，姑且命名為pageKey，讓使用者保證是全站唯一的即可。

如果用戶訪問我們的站點(diǎn)中很多很多的頁面，由于localStorage是永久保存的，如何避免localStorage不斷累積占用過大？

我們的需求可能僅僅是想近期記住即可，即只需要記住用戶的瀏覽位置幾天，可能會更希望我們存的數(shù)據(jù)能夠自動過期。

但localStorage自身是沒有自動過期機(jī)制的，一般只能在存數(shù)據(jù)的時(shí)候同時(shí)存一下時(shí)間戳，然后在使用時(shí)判斷是否過期。如果只能是在使用時(shí)才判斷是否清除，而新訪問頁面時(shí)又會生成新的記錄，localStorage中始終都會存在至少一條記錄的，也就是說無法真正實(shí)現(xiàn)自動過期。這里不禁就覺得有點(diǎn)多余了，既然都是會一直保留記錄在localStorage中，那干脆就不判斷了，咱換一個(gè)思路：只記錄有限的最新頁面數(shù)量。

舉個(gè)例子：

咱們網(wǎng)站有個(gè)文章頁：www.xx.com/articles/${id}，每個(gè)的id表示不同的文章，咱們只記錄用戶最新訪問的5篇文章，即維護(hù)一個(gè)長度為5的隊(duì)列。
比如當(dāng)前網(wǎng)站有id從1到100篇文章，用戶分別訪問第1,2,3,4,5篇文章時(shí)，這5篇文章都會記錄離開的位置，而當(dāng)用戶打開第六篇文章時(shí)，第六條記錄入隊(duì)的同時(shí)第一條記錄出隊(duì)，此時(shí)localStorage中記錄的是2,3,4,5,6這幾篇文章的位置，這就保證了localStorage永遠(yuǎn)不會累積存儲數(shù)據(jù)且舊記錄會隨著不斷訪問新頁面自動“過期”。

為了更靈活一點(diǎn)，博主決定給這個(gè)插件添加一個(gè)maxLength的參數(shù)，表示當(dāng)前站點(diǎn)下記錄的最新的頁面最大數(shù)量，默認(rèn)值設(shè)為5，如果有小伙伴的需求是記錄更多的頁面，可以通過這個(gè)參數(shù)來設(shè)置。

我們需要時(shí)刻監(jiān)聽用戶瀏覽頁面時(shí)的滾動條的位置，可以通過window.onscroll事件，獲得當(dāng)前的滾動條位置：scrollTop 。

將scrollTop和頁面唯一標(biāo)識pageKey存進(jìn)localStorage中。

用戶再次打開之前訪問過的頁面，在頁面初始化時(shí)，讀取localStorage中的數(shù)據(jù)，判斷頁面的pageKey是否一致，若一致則將頁面的滾動條位置自動滾動到相應(yīng)的scrollTop值。

是不是很簡單？不過實(shí)現(xiàn)的過程中需要注意一下細(xì)節(jié)，比如做一下防抖處理。

逼逼了這么久，是時(shí)候開始擼代碼了。

工欲善其事，必先利其器。為更好服務(wù)接下來的工作，咱們先簡單封裝一下調(diào)用localStorage的幾個(gè)方法,主要是get,set,remove：

// storage.js
const Storage = {
  isSupport () {
    if (window.localStorage) {
      return true
    } else {
      console.error("Your browser cannot support localStorage!")
      return false
    }
  },
  get (key) {
    if (!this.isSupport) {
      return
    }
    const data = window.localStorage.getItem(key)
    return data ? JSON.parse(data) : undefined
  },
  remove (key) {
    if (!this.isSupport) {
      return
    }
    window.localStorage.removeItem(key)
  },
  set (key, data) {
    if (!this.isSupport) {
      return
    }
    const newData = JSON.stringify(data)
    window.localStorage.setItem(key, newData)
  }
}

export default Storage

class即類，本質(zhì)上雖然是一個(gè)function,但使用class定義一個(gè)類會更直觀。咱們?yōu)榧磳懙膸炱饌€(gè)名字為RememberScroll，開始就是如下的樣子啦：

import Storage from "./storage"
class RememberScroll {
    constructor() {
        
    }
}

1.處理傳進(jìn)來的參數(shù)

我們需要在類的構(gòu)造函數(shù)constructor中接收參數(shù)，并覆蓋默認(rèn)參數(shù)。

還記得上面咱們預(yù)期的用法嗎？即new RememberScroll({pageKey: "myPage", maxLength: 10})。

  constructor (options) {
    let defaultOptions = {
      pageKey: "_page1", // 當(dāng)前頁面的唯一標(biāo)識
      maxLength: 5
    }
    this.options = Object.assign({}, defaultOptions, options)
}

如果沒有傳參數(shù)，就會使用默認(rèn)的參數(shù)，如果傳了參數(shù)，就使用傳進(jìn)來的參數(shù)。this.options就是最終處理后的參數(shù)啦。

2.頁面初始化

當(dāng)頁面初始化時(shí)，咱們需要做三件事情：

從loaclStorage取出緩存列表

將滾動條滾動到記錄的位置（若有記錄的話）；

注冊window.onscroll事件監(jiān)聽用戶滾動行為；

因此，需要在構(gòu)造函數(shù)中就執(zhí)行initScroll和addScrollEvent這兩個(gè)方法:

import Storage from "./utils/storage"
class RememberScroll {
  constructor (options) {
    // ...
    this.storageKey = "_rememberScroll"
    this.list = Storage.get(this.storageKey) || []
    this.initScroll()
    this.addScrollEvent()
  }
  initScroll () {
    // ...
  }
  addScrollEvent () {
    // ...
  }
}

這里咱們將localStorage中的鍵名命名為_rememberScroll，應(yīng)該能夠盡量避免和平常站點(diǎn)使用localStorage的鍵名沖突。

3.監(jiān)聽滾動事件：addScrollEvent()的實(shí)現(xiàn)

  addScrollEvent () {
    window.onscroll = () => {
      // 獲取最新的位置，只記錄垂直方向的位置
      const scrollTop = document.documentElement.scrollTop || document.body.scrollTop
      // 構(gòu)造當(dāng)前頁面的數(shù)據(jù)對象
      const data = {
        pageKey: this.options.pageKey,
        y: scrollTop
      }
      let index = this.list.findIndex(item => item.pageKey === data.pageKey)
      if (index >= 0) {
        // 之前緩存過該頁面，則替換掉之前的記錄
        this.list.splice(index, 1, data)
      } else {
        // 如果已經(jīng)超出長度了，則清除一條最早的記錄
        if (this.list.length >= this.options.maxLength) {
          this.list.shift()
        }
        this.list.push(data)
      }
      // 更新localStorage里面的記錄
      Storage.set(this.storageKey, this.list)
    }
  }

ps：這里最好需要做一下防抖處理

4.初始化滾動條位置： initScroll()的實(shí)現(xiàn)

initScroll () {
    // 先判斷是否有記錄
    if (this.list.length) {
      // 當(dāng)前頁面pageKey是否一致
      let currentPage = this.list.find(item => item.pageKey === this.options.pageKey)
      if (currentPage) {
        setTimeout(() => {
          // 一致，則滾動到對應(yīng)的y值
          window.scrollTo(0, currentPage.y)
        }, 0)
    }
}

細(xì)心的同學(xué)可能會發(fā)現(xiàn)，這里用了setTimeout,而不是直接調(diào)用window.scrollTo。這是因?yàn)椴┲髟谶@里遇到坑了，這里涉及到頁面加載執(zhí)行順序的問題。

在執(zhí)行window.scrollTo前，頁面必須是已經(jīng)加載完成了的，滾動條要已存在才可以滾動對吧。如果頁面加載時(shí)直接執(zhí)行，當(dāng)時(shí)的scroll高度可能為0，window.scrollTo執(zhí)行就會無效。如果頁面的數(shù)據(jù)是異步獲取的，也會導(dǎo)致window.scrollTo無效。因此用setTimeout會是比較穩(wěn)的一個(gè)辦法。

5.將模塊export出去

最后我們需要將模塊export出去，整體代碼大概是這個(gè)樣子：

import Storage from "./utils/storage"

class RememberScroll {
  constructor (options) {
    let defaultOptions = {
      pageKey: "_page1", // 當(dāng)前頁面的唯一標(biāo)識
      maxLength: 5
    }
    this.storageKey = "_rememberScroll"
    // 參數(shù)
    this.options = Object.assign({}, defaultOptions, options)

    // 緩存列表
    this.list = Storage.get(this.storageKey) || []
    this.initScroll()
    this.addScrollEvent()
  }
  initScroll () {
    // ...
  }
  addScrollEvent () {
    // ...
  }
}

export default RememberScroll

這樣就基本完成整個(gè)插件的功能啦，是不是很簡單哈哈。篇幅原因就不貼具體代碼了，可以直接到GitHub上看：remember-scroll

接下來應(yīng)該是本文的重點(diǎn)了，首先要清楚為什么要打包？

將項(xiàng)目中所用到的js文件合并，只對外輸出一個(gè)js文件。

使項(xiàng)目同時(shí)支持AMD,CMD、瀏覽器

這里有個(gè)坑需要注意一下，如果沒有加上libraryExport: "default",由于我們代碼中是export default RememberScroll,打包出來的代碼會類似：

{
    "default": {
        initScroll () {}
    }
}

{
    initScroll () {}
}

PS: webpack英文文檔看得有點(diǎn)懵逼，這個(gè)坑讓博主折騰了很久才爬起來，所以特別講下。剛興趣的同學(xué)可以看下文檔：output.libraryExport。

PS: 雖然很多人說不考慮兼容IE了，但作為一個(gè)通用性的庫，古董級的IE7,8,9可以不兼容，但較新版本的IE10,11還是需要兼容一下的。

PS：以前博主一直以為（相信很多剛接觸Babel的同學(xué)也是這樣），只要使用了Babel，就可以放心無痛使用ES6的語法了，然而事情并不是這樣。Babel編譯并不會做polyfill，Babel為了保證正確的語義，只能轉(zhuǎn)換語法而不會增加或修改原有的屬性和方法。要想無痛使用ES6，還需要配合polyfill。不太理解的同學(xué)，在這里推薦大家看下這篇文章：21 分鐘精通前端 Polyfill 方案，寫得非常通俗易懂。

npm install -D babel-loader @babel/core @babel/preset-env core-js

core-js是JavaScript模塊化標(biāo)準(zhǔn)庫，在@babel/preset-env按需打包時(shí)會使用core-js中的函數(shù)，因此這里也是要安裝的，不然打包的時(shí)候會報(bào)錯(cuò)。

const path = require("path");

module.exports = {
  entry: "./src/index.js",
  output: {
    path: path.resolve(__dirname, "dist"),
    filename: "remember-scroll.js",
    library: "RememberScroll",
    libraryTarget: "umd",
    libraryExport: "default"
  },
  module: {
    rules: [
        {
          test: /.m?js$/,
          exclude: /(node_modules|bower_components)/,
          use: {
            loader: "babel-loader"
          }
        }
      ]
  }
};

const presets = [
  [
    "@babel/env",
    {
      targets: {
        browsers: [
            "last 1 version",
            "> 1%",
            "maintained node versions",
            "not dead"
          ]
      },
      useBuiltIns: "usage",
    },
  ],
];

  "scripts": {
    "test": "echo "Error: no test specified" && exit 1",
    "build": "webpack --mode=production -o dist/remember-scroll.min.js --colors",
    "dev": "webpack --mode=development --colors"
  },

{
    "main": "dist/remember-scroll.min.js",
}