webpack，非同步載入，程式碼分割，require.ensure

wdapp發表於2020-02-28

webpack非同步載入的原理

webpack ensure相信大家都聽過。有人稱它為非同步載入，也有人說做程式碼切割，那這個傢伙到底是用來幹嘛的？其實說白了，它就是把js模組給獨立匯出一個.js檔案的，然後使用這個模組的時候，webpack會構造script dom元素，由瀏覽器發起非同步請求這個js檔案。

場景分析:

比如應用的首頁裡面有個按鈕，點選後可以開啟某個地圖。開啟地圖的話就要利用百度地圖的js,於是我們不得不在首頁中把百度地圖的js一起打包進去首頁,一個百度地圖的js檔案是非常大的，假設為 1m，於是就造成了我們首頁打包的js非常大，使用者開啟首頁的時間就比較長了。

有沒有什麼好的解決方法呢？

解決1

既然打包成同一個js非常大的話，那麼我們完全可以把百度地圖js分類出去，利用瀏覽器的併發請求 js檔案處理，這樣的話，會比載入一個js檔案時間小得多。嗯，這也是個不錯的方案。為baidumap.js 配置一個新的入口就行了，這樣就能打包成兩個js檔案，都插入html即可（如果baidumap.js被多個入口檔案引用的話，也可以不用將其設定為入口檔案，而且直接利用CommonsChunkPlugin,匯出到一個公共模組即可）可以參考我之前文章

webpack模組打包

那還有沒有更好的解決方案呢？

解決2

當然還是有的！我們細想，百度地圖是使用者點選了才彈出來的，也就是說，這個功能是可選的。那麼解決方案就來了，能不能在使用者點選的時候，我在去下載百度地圖的js.當然可以。那如何實現使用者點選的時候再去下載百度地圖的js呢？於是，我們可以寫一個按鈕的監聽器

mapBtn.click(function() {
  //獲取 文件head物件
  var head = document.getElementsByTagName('head')[0];
  //構建 <script>
  var script = document.createElement('script');
  //設定src屬性
  script.async = true;
  script.src = "http://map.baidu.com/.js"
  //加入到head物件中
  head.appendChild(script);
})
複製程式碼

上面的幾行程式碼對大家來說都不難。可以在點選的時候，才載入百度地圖，等百度地圖載入完成後，在利用百度地圖的物件去執行我們的操作。ok，講到這裡webpack.ensure的原理也就講了一大半了。它就是把一些js模組給獨立出一個個js檔案，然後需要用到的時候，在建立一個script物件，加入到document.head物件中即可，瀏覽器會自動幫我們發起請求，去請求這個js檔案，在寫個回撥，去定義得到這個js檔案後，需要做什麼業務邏輯操作。

ok,那麼我們就利用webpack的api去幫我們完成這樣一件事情。點選後才進行非同步載入百度地圖js，上面的click載入js時我們自己寫的，webpack可以輕鬆幫我們搞定這樣的事情，而不用我們手寫

mapBtn.click(function() {
  require.ensure([], function() {
    var baidumap = require('./baidumap.js') //baidumap.js放在我們當前目錄下
  })
})
複製程式碼

搞定！當然還是分析一下。require.ensure這個函式是一個程式碼分離的分割線，表示回撥裡面的require 是我們想要進行分割出去的，即require('./baidumap.js')，把baidumap.js分割出去，形成一個 webpack打包的單獨js檔案。當然ensure裡面也是可以寫一些同步的require的，比如

var sync = require('syncdemo.js')   //下面ensure裡面也用到

mapBtn.click(function() {
  require.ensure([], function() {
    var baidumap = require('./baidumap.js') //baidumap.js放在我們當前目錄下
    var sync = require('syncdemo.js')  //這個不會獨立出去，因為它已經載入到模組快取中了
  })
})
複製程式碼

也就是說，ensure會把沒有使用過的require資源進行獨立分成成一個js檔案. require.ensure的第一個引數是什麼意思呢？[], 其實就是當前這個 require.ensure所依賴的其他非同步載入的模組。你想啊？如果A 和 B都是非同步載入的，B中需要A，那麼B下載之前，是不是先要下載A啊？，所以ensure的第一個引數[] 也是請求下載的模組，如果想載入A require.ensure(['A.js'],function) 即可

說完了上面的原理。下面就實踐一下

entry.js 依賴三個 js。

Abtn-work.js 是封裝了 abtn按鈕點選後，才執行的業務邏輯
Bbtn-work.js 是封裝了 bbtn按鈕點選後，才執行的業務邏輯
util.js 是封裝了 entry.js需要利用的工具箱

針對上面的需求，優化方案

假設 Abtn-work.js Bbtn-work.js util.js都是非常大的檔案因為 Abtn-work.js Bbtn-work.js 都不是entry.js必須有的，即可能發生的操作，那麼我們把他們利用非同步載入，當發生的時候再去載入就行了

util.js是entry.js立即馬上依賴的工具箱。但是它又非常的大，所以將其配置打包成一個公共模組，利用瀏覽器的併發載入，加快下載速度。ok,構思完成，開始實現

index.html

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
    <title>index</title>
  </head>
  <body>
    <div id="aBtn">Abtn</div>
    <div id="bBtn">Bbtn</div>
  </body>
</html>
複製程式碼

定義了兩個buttom

然後看看 entry.js


var util_sync = require('./util-sync.js')

alert(util_sync.data)

document.getElementById("aBtn").onclick = function() {

  require.ensure([], function() {
    var awork = require('./workA-async.js')
    alert(awork.data)
    //非同步裡面再匯入同步模組--實際是使用同步中的模組
    var util1 = require('./util-sync.js')
  })
}

document.getElementById("bBtn").onclick = function() {

  require.ensure([], function() {
    var bwork = require('./workB-async.js')
    alert(bwork.data)
  })
}
複製程式碼