前言
常見的js插件都很少使用ES6的class,一般都是通過構(gòu)造函數(shù),而且常常是手寫CMD、AMD規(guī)范來封裝一個庫,比如這樣:
// 引用自:http://www.itdecent.cn/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年了,是時候祭出我們的ES6大法了,可以用更優(yōu)雅的的寫法來實(shí)現(xiàn)一個庫,比如這樣:
class RememberScroll {
constructor(options) {
...
}
}
export default RememberScroll
在這篇文章,博主主要通過分享最近自己寫的一個記住頁面滾動位置小插件,講一下如何用class語法配合webpack 4.x和babel 7.x封裝一個可用的庫。
項(xiàng)目地址:Github, 在線Demo:Demo
喜歡的朋友希望能點(diǎn)個Star收藏一下,非常感謝。
需求來源
相信很多同學(xué)都會遇到這樣一個需求:用戶瀏覽一個頁面并離開后,再次打開時需要重新定位到上一次離開的位置。
這個需求很常見,我們平時在手機(jī)上閱讀微信公眾號的文章頁面就有這個功能。想要做到這個需求,也比較好實(shí)現(xiàn),但博主有點(diǎn)懶,心想有沒有現(xiàn)成的庫可以直接用呢?于是去GitHub上搜了一波,發(fā)現(xiàn)并沒有很好的且符合我需求的,于是得自己實(shí)現(xiàn)一下。
為了靈活使用(只是部分頁面需要這個功能),博主在項(xiàng)目中單獨(dú)封裝了這個庫,本來是在公司項(xiàng)目中用的,后來想想何不開源出來呢?于是有了這個分享,這也是對自己工作的一個總結(jié)。
預(yù)期效果
博主喜歡在做一件事情前先yy一下預(yù)期的效果。博主希望這個庫用起來盡量簡單,最好是插入一句代碼就可以了,比如這樣:
<html>
<head>
<meta charset="utf-8">
<title>remember-scroll examples</title>
</head>
<body>
<div id="content"></div>
<script src="../dist/remember-scroll.js"></script>
<script>
new RememberScroll()
</script>
</body>
</html>
在想要加上記住用戶瀏覽位置的頁面上引入一下庫,然后new RememberScroll()初始化一下即可。
下面就帶著這個目標(biāo),一步一步去實(shí)現(xiàn)啦。
設(shè)計方案
1. 需要存哪些信息?
用戶瀏覽頁面的位置,主要需要存兩個字段:哪個頁面和離開時的位置,通過這兩個字段,我們才可以在用戶第二次打開網(wǎng)站的頁面時,命中該頁面,并自動跳轉(zhuǎn)到上一次離開的位置。
2.存在哪?
記住瀏覽位置,需要將用戶離開前的瀏覽位置記錄在客戶端的瀏覽器中。這些信息可以主要存放在:cookie、sessionStorage、localStorage中。
- 存放在
cookie,大小4K,空間雖有限但也勉強(qiáng)可以。但cookie是每次請求服務(wù)器時都會攜帶上的,無形中增加了帶寬和服務(wù)器壓力,所以總體來說是不太合適的。 - 存放在
sessionStorage中,由于僅在當(dāng)前會話下有效,用戶離開頁面sessionStorage就會被清除,所以不能滿足我們的需求。 - 存放在
localStorage,瀏覽器可永久保存,大小一般限制5M,滿足我們需求。
綜上,最后我們應(yīng)該選擇localStorage。
3. 需注意的問題
- 一個站點(diǎn)可能有很多頁面,如何標(biāo)識是哪個頁面呢?
一般來說可以用頁面的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這種情況,這可能表示的是同一個頁面的不同錨點(diǎn),所以用url作為頁面的唯一標(biāo)識不太可靠。
因此,博主決定將這個頁面唯一標(biāo)識作為一個參數(shù)來讓使用者來決定,姑且命名為pageKey,讓使用者保證是全站唯一的即可。
- 如果用戶訪問我們的站點(diǎn)中很多很多的頁面,由于
localStorage是永久保存的,如何避免localStorage不斷累積占用過大?
我們的需求可能僅僅是想近期記住即可,即只需要記住用戶的瀏覽位置幾天,可能會更希望我們存的數(shù)據(jù)能夠自動過期。
但localStorage自身是沒有自動過期機(jī)制的,一般只能在存數(shù)據(jù)的時候同時存一下時間戳,然后在使用時判斷是否過期。如果只能是在使用時才判斷是否清除,而新訪問頁面時又會生成新的記錄,localStorage中始終都會存在至少一條記錄的,也就是說無法真正實(shí)現(xiàn)自動過期。這里不禁就覺得有點(diǎn)多余了,既然都是會一直保留記錄在localStorage中,那干脆就不判斷了,咱換一個思路:只記錄有限的最新頁面數(shù)量。
舉個例子:
咱們網(wǎng)站有個文章頁:
www.xx.com/articles/${id},每個的id表示不同的文章,咱們只記錄用戶最新訪問的5篇文章,即維護(hù)一個長度為5的隊(duì)列。
比如當(dāng)前網(wǎng)站有id從
1到100篇文章,用戶分別訪問第1,2,3,4,5篇文章時,這5篇文章都會記錄離開的位置,而當(dāng)用戶打開第六篇文章時,第六條記錄入隊(duì)的同時第一條記錄出隊(duì),此時localStorage中記錄的是2,3,4,5,6這幾篇文章的位置,這就保證了localStorage永遠(yuǎn)不會累積存儲數(shù)據(jù)且舊記錄會隨著不斷訪問新頁面自動“過期”。
為了更靈活一點(diǎn),博主決定給這個插件添加一個maxLength的參數(shù),表示當(dāng)前站點(diǎn)下記錄的最新的頁面最大數(shù)量,默認(rèn)值設(shè)為5,如果有小伙伴的需求是記錄更多的頁面,可以通過這個參數(shù)來設(shè)置。
4. 實(shí)現(xiàn)思路
- 我們需要時刻監(jiān)聽用戶瀏覽頁面時的滾動條的位置,可以通過
window.onscroll事件,獲得當(dāng)前的滾動條位置:scrollTop。 - 將
scrollTop和頁面唯一標(biāo)識pageKey存進(jìn)localStorage中。 - 用戶再次打開之前訪問過的頁面,在頁面初始化時,讀取
localStorage中的數(shù)據(jù),判斷頁面的pageKey是否一致,若一致則將頁面的滾動條位置自動滾動到相應(yīng)的scrollTop值。
是不是很簡單?不過實(shí)現(xiàn)的過程中需要注意一下細(xì)節(jié),比如做一下防抖處理。
實(shí)現(xiàn)步驟
逼逼了這么久,是時候開始擼代碼了。
1.封裝localStorage工具方法
工欲善其事,必先利其器。為更好服務(wù)接下來的工作,咱們先簡單封裝一下調(diào)用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
2. class大法
class即類,本質(zhì)上雖然是一個function,但使用class定義一個類會更直觀。咱們?yōu)榧磳懙膸炱饌€名字為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)頁面初始化時,咱們需要做三件事情:
- 從
loaclStorage取出緩存列表 - 將滾動條滾動到記錄的位置(若有記錄的話);
- 注冊
window.onscroll事件監(jiān)聽用戶滾動行為;
因此,需要在構(gòu)造函數(shù)中就執(zhí)行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,應(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)加載完成了的,滾動條要已存在才可以滾動對吧。如果頁面加載時直接執(zhí)行,當(dāng)時的scroll高度可能為0,window.scrollTo執(zhí)行就會無效。如果頁面的數(shù)據(jù)是異步獲取的,也會導(dǎo)致window.scrollTo無效。因此用setTimeout會是比較穩(wěn)的一個辦法。
5.將模塊export出去
最后我們需要將模塊export出去,整體代碼大概是這個樣子:
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
這樣就基本完成整個插件的功能啦,是不是很簡單哈哈。篇幅原因就不貼具體代碼了,可以直接到GitHub上看:remember-scroll
打包
接下來應(yīng)該是本文的重點(diǎn)了,首先要清楚為什么要打包?
- 將項(xiàng)目中所用到的js文件合并,只對外輸出一個js文件。
- 使項(xiàng)目同時支持
AMD,CMD、瀏覽器<script>標(biāo)簽引入,即umd規(guī)范。 - 配合babel,將es6語法轉(zhuǎn)為es5語法,兼容低版本瀏覽器。
PS: 由于webpack和babel更新速度很快,網(wǎng)上很多教程可能早已過時,現(xiàn)在(2019-03)的版本已經(jīng)是babel 7.3.0,webpack 4.29.6, 本篇文章只分享現(xiàn)在的最新的配置方法,因此本篇文章也是會過時的,讀者們請注意版本號。
npm init項(xiàng)目
咱們先新建一個目錄,這里名為:remember-scroll,然后將上面寫好的remember-scroll.js放進(jìn)remember-scroll/src/目錄下。
PS:一般項(xiàng)目的資源文件都放在src目錄下,為了顯得專業(yè)點(diǎn),最好將
remember-scroll.js改名為index.js。)
此時項(xiàng)目還沒有package.json文件,因此在根目錄執(zhí)行命令初始化package.json:
npm init
需要根據(jù)提示填寫一些項(xiàng)目相關(guān)信息。
安裝webpack和webpack-cli
運(yùn)行webpack命令時需要同時裝上webpack-cli:
npm i webpack webpack-cli -D
配置webpack.config.js
在根目錄中添加一個webpack.config.js,按照webpack官網(wǎng)的示例代碼配置:
const path = require('path');
module.exports = {
entry: './src/index.js',
output: {
path: path.resolve(__dirname, 'dist'),
filename: 'remember-scroll.js' // 修改下輸出的名稱
}
};
然后在package.json的script中配置運(yùn)行webpack的命令:
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1",
"dev": "webpack --mode=development --colors"
},
這樣配置完成,在根目錄運(yùn)行npm run dev,會自動生成dist/remember-scroll.js。
此時已經(jīng)實(shí)現(xiàn)了我們的第一個小目標(biāo):賺它一個億,哦不,是將storage.js和index.js合并輸出為一個remember-scroll.js。
這種簡單的打包可以稱為:
非模塊化打包。由于我們在js文件中沒有通過AMD的return或者CommonJS的exports或者this導(dǎo)出模塊本身,導(dǎo)致模塊被引入的時候只能執(zhí)行代碼而無法將模塊引入后賦值給其它模塊使用。
支持umd規(guī)范
相信很多同學(xué)都聽過AMD,CommonJS規(guī)范了,不清楚的同學(xué)可以看看阮一峰老師的介紹:Javascript模塊化編程(二):AMD規(guī)范。
為了讓我們的插件同時支持AMD,CommonJS,所以需要將我們的插件打包為umd通用模塊。
之前看過一篇文章:如何定義一個高逼格的原生JS插件,在沒有使用webpack打包時,需要在插件中手寫支持這些模塊化的代碼:
// 引用自:http://www.itdecent.cn/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);
}
}());
博主看到這坨東西,也是有點(diǎn)暈,不得不佩服大佬就是大佬。還好現(xiàn)在有了webpack,我們現(xiàn)在只需要寫好主體關(guān)鍵代碼,webpack會幫我們處理好這些打包的問題。
在webpack4中,我們可以將js打包為一個庫的形式,詳情可看:Webpack Expose the Library
。在我們這里只需在output中加上library屬性:
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'
}
};
注意libraryTarget為umd,就是我們要打包的目標(biāo)規(guī)范為umd。
當(dāng)我們在html中通過script標(biāo)簽引入這個js時,會在window下注冊RememberScroll這個變量(類似引入jQuery時會在全局注冊$這個變量)。此時就直接使用RememberScroll這個變量了。
<script src="../dist/remember-scroll.js"></script>
<script>
console.log(RememberScroll)
</script>
這里有個坑需要注意一下,如果沒有加上libraryExport: 'default',由于我們代碼中是export default RememberScroll,打包出來的代碼會類似:
{
'default': {
initScroll () {}
}
}
而我們期望的是這樣:
{
initScroll () {}
}
即我們希望的是直接輸出default中的內(nèi)容,而不是隔著一層default。所以這里還要加上libraryExport: 'default',打包時只輸出default的內(nèi)容。
PS: webpack英文文檔看得有點(diǎn)懵逼,這個坑讓博主折騰了很久才爬起來,所以特別講下。剛興趣的同學(xué)可以看下文檔:output.libraryExport。
到這里,已經(jīng)實(shí)現(xiàn)了我們的第二個小目標(biāo):支持umd規(guī)范。
使用babel-loader
上面我們打包出來的js,其實(shí)已經(jīng)可以正常運(yùn)行在支持es6語法的瀏覽器中了,比如chrome。但想要運(yùn)行在IE10,IE11中,還得讓神器Babel幫我們一把。
PS: 雖然很多人說不考慮兼容IE了,但作為一個通用性的庫,古董級的IE7,8,9可以不兼容,但較新版本的IE10,11還是需要兼容一下的。
Babel是一個JavaScript轉(zhuǎn)譯器,相信大家都聽過。由于JavaScript在不斷的發(fā)展,但是瀏覽器的發(fā)展速度跟不上,新的語法和特性不能馬上被瀏覽器支持,因此需要一個能將新語法新特性轉(zhuǎn)為現(xiàn)代瀏覽器能理解的語法的轉(zhuǎn)譯器,而Babel就是充當(dāng)了轉(zhuǎn)譯器的角色。
PS:以前博主一直以為(相信很多剛接觸Babel的同學(xué)也是這樣),只要使用了Babel,就可以放心無痛使用ES6的語法了,然而事情并不是這樣。Babel編譯并不會做polyfill,Babel為了保證正確的語義,只能轉(zhuǎn)換語法而不會增加或修改原有的屬性和方法。要想無痛使用ES6,還需要配合polyfill。不太理解的同學(xué),在這里推薦大家看下這篇文章:21 分鐘精通前端 Polyfill 方案,寫得非常通俗易懂。
總的來說,就是Babel需要配合polyfill來使用。
Babel更新比較頻繁,網(wǎng)上搜出來的很多配置教程是舊版本的,可能并不適用最新的Babel 7.x,所以我們這里折騰一下最新的webpack4配置Babel方案:babel-loader。
1.安裝babel-loader,@babel/core、@babel/preset-env。
npm install -D babel-loader @babel/core @babel/preset-env core-js
core-js是JavaScript模塊化標(biāo)準(zhǔn)庫,在@babel/preset-env按需打包時會使用core-js中的函數(shù),因此這里也是要安裝的,不然打包的時候會報錯。
2.修改webpack.config.js配置,添加rules
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'
}
}
]
}
};
表示.js的代碼使用babel-loader打包。
3.在根目錄新建babel.config.js,參考Babel官網(wǎng)
const presets = [
[
"@babel/env",
{
targets: {
browsers: [
"last 1 version",
"> 1%",
"maintained node versions",
"not dead"
]
},
useBuiltIns: "usage",
},
],
];
browsers配置的是目標(biāo)瀏覽器,即我們想要兼容到哪些瀏覽器,比如我們想兼容到IE10,就可以寫上IE10,然后webpack會在打包時自動為我們的庫添加polyfill兼容到IE10。
博主這里用的是推薦的參數(shù),來自:npm browserslist,這樣就能兼容到大多數(shù)瀏覽器啦。
配置好后,npm run dev打包即可。
此時,我們已經(jīng)實(shí)現(xiàn)了第三個小目標(biāo):兼容低版本瀏覽器。
生產(chǎn)環(huán)境打包
npm run dev打包出來的js會比較大,一般還需要壓縮一下,而我們可以使用webpack的production模式,就會自動為我們壓縮js,輸出一個生產(chǎn)環(huán)境可用的包。在package.json再添加一條build命令:
"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"
},
這里同時指定了輸出的文件名為:remember-scroll.min.js,一般生產(chǎn)環(huán)境就是使用這個文件啦。
發(fā)布到npm
經(jīng)過上面的步驟,我們已經(jīng)寫完這個庫,有需求的同學(xué)可以將庫發(fā)布到npm,讓更多的人可以方便用到你這個庫。
在發(fā)布到npm前,需要修改一下package.json,完善下描述作者之類的信息,最重要的是要添加main入口文件:
{
"main": "dist/remember-scroll.min.js",
}
這樣別人使用你的庫時,可以直接通過import RememberScroll from 'remember-scroll'來使用remember-scroll.min.js。
發(fā)布步驟:
- 先到https://www.npmjs.com/注冊一個賬號,然后驗(yàn)證郵箱。
- 然后在命令行中輸入:
npm adduser,輸入賬號密碼郵箱登錄。 - 運(yùn)行
npm publish上傳包,幾分鐘后就可以在npm搜到你的包了。
至此,基本就完成一個插件的開發(fā)發(fā)布過程啦。
不過一個優(yōu)秀的開源項(xiàng)目,還應(yīng)該要有詳細(xì)的說明文檔,使用示例等等,大家可以參考下博主這個項(xiàng)目的README.md, 中文README.md。
最后
文章寫了好幾天了,可謂嘔心瀝血,雖然比較啰嗦,但應(yīng)該比較清楚地交代了如何運(yùn)用ES6語法從零寫一個記住用戶離開位置的js插件,也很詳細(xì)地講解了如何用最新的webpack打包我們的庫,希望能讓大家都有所收獲,也希望大家能到GitHub上點(diǎn)個Star鼓勵一下啦。
remember-scroll這個插件其實(shí)幾個月前就已經(jīng)發(fā)布到npm了,一直比較忙(懶)沒寫章分享。雖然功能簡單但很有誠意,能兼容到IE9。
使用起來也非常方便簡單,可直接通過script標(biāo)簽cdn引入,也可以在vue中import RememberScroll from 'remember-scroll'使用。文檔中有詳細(xì)的使用示例:
歡迎大家評論交流,也歡迎PR,同時希望大家能點(diǎn)個Star鼓勵一下啦。