摘要：咱們為即將寫的庫起個名字為，開始就是如下的樣子啦處理傳進來的參數我們需要在類的構造函數中接收參數，并覆蓋默認參數。

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

// 引用自：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);
    }
}());

但現在都9102年了，是時候祭出我們的ES6大法了，可以用更優雅的的寫法來實現一個庫，比如這樣：

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

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

項目地址：Github， 在線Demo：Demo

喜歡的朋友希望能點個Star收藏一下，非常感謝。

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

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

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

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

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

下面就帶著這個目標，一步一步去實現啦。

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

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

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

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

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

綜上，最后我們應該選擇localStorage。

一個站點可能有很多頁面，如何標識是哪個頁面呢？

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

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

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

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

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

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

舉個例子：

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

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

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

將scrollTop和頁面唯一標識pageKey存進localStorage中。

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

是不是很簡單？不過實現的過程中需要注意一下細節，比如做一下防抖處理。

逼逼了這么久，是時候開始擼代碼了。

工欲善其事，必先利其器。為更好服務接下來的工作，咱們先簡單封裝一下調用localStorage的幾個方法,主要是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即類，本質上雖然是一個function,但使用class定義一個類會更直觀。咱們為即將寫的庫起個名字為RememberScroll，開始就是如下的樣子啦：

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

1.處理傳進來的參數

我們需要在類的構造函數constructor中接收參數，并覆蓋默認參數。

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

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

如果沒有傳參數，就會使用默認的參數，如果傳了參數，就使用傳進來的參數。this.options就是最終處理后的參數啦。

2.頁面初始化

當頁面初始化時，咱們需要做三件事情：

從loaclStorage取出緩存列表

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

注冊window.onscroll事件監聽用戶滾動行為；

因此，需要在構造函數中就執行initScroll和addScrollEvent這兩個方法:

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，應該能夠盡量避免和平常站點使用localStorage的鍵名沖突。

3.監聽滾動事件：addScrollEvent()的實現

  addScrollEvent () {
    window.onscroll = () => {
      // 獲取最新的位置，只記錄垂直方向的位置
      const scrollTop = document.documentElement.scrollTop || document.body.scrollTop
      // 構造當前頁面的數據對象
      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 {
        // 如果已經超出長度了，則清除一條最早的記錄
        if (this.list.length >= this.options.maxLength) {
          this.list.shift()
        }
        this.list.push(data)
      }
      // 更新localStorage里面的記錄
      Storage.set(this.storageKey, this.list)
    }
  }

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

4.初始化滾動條位置： initScroll()的實現

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

細心的同學可能會發現，這里用了setTimeout,而不是直接調用window.scrollTo。這是因為博主在這里遇到坑了，這里涉及到頁面加載執行順序的問題。

在執行window.scrollTo前，頁面必須是已經加載完成了的，滾動條要已存在才可以滾動對吧。如果頁面加載時直接執行，當時的scroll高度可能為0，window.scrollTo執行就會無效。如果頁面的數據是異步獲取的，也會導致window.scrollTo無效。因此用setTimeout會是比較穩的一個辦法。

5.將模塊export出去

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

import Storage from "./utils/storage"

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

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

export default RememberScroll

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

接下來應該是本文的重點了，首先要清楚為什么要打包？

將項目中所用到的js文件合并，只對外輸出一個js文件。

使項目同時支持AMD,CMD、瀏覽器

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

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

{
    initScroll () {}
}

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

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

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

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

core-js是JavaScript模塊化標準庫，在@babel/preset-env按需打包時會使用core-js中的函數，因此這里也是要安裝的，不然打包的時候會報錯。

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",
}