這篇文章帶給大家的內容是關於webpack引入第三方函式庫的方式及注意事項(程式碼範例),有一定的參考價值,有需要的朋友可以參考一下,希望對你有幫助。
一般情況下,我們不用擔心所使用的第三方函式庫,在npm管理倉庫中找不到。
如果需要某一個函式庫,如:jquery,可以直接執行npm install jquery腳本指令來安裝這個專案所需要的依賴;
然後,在使用jquery的模組檔案中,透過import $ from 'jquery'或var $ = require('jquery')來引入。
這是常用的在webpack建構的專案中引入第三方函式庫的方式。
附註:為了更好的示範範例程式碼,範例是在nodemon這篇文章的基礎上操作的。
但是,在不同的場景下,對webpack建構的專案有不同的需求:
專案的體積足夠小(cdn)
如果是webapck的處理方式,可參考webapck——實現構建輸出最小這篇文章。
使用非webapck的處理方式,如:CDN。
操作也很簡單,如果使用html-webpack-plugin直接在範本檔案template/index.html中引入某個cdn(如:boot CDN)上的某個第三方函式庫(如:jquery) ,參考程式碼如下:
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>third party</title> </head> <body> <script src="https://cdn.bootcss.com/jquery/3.3.1/jquery.min.js"></script> </body> </html>
然後,在module.js
中使用jquery
即可,參考程式碼如下:
require('./module.css'); module.exports = function() { $(document.body).append('<h1>hello webpack</h1>') }
最後,執行npm run test,建置結束後,你會在瀏覽器中看到hello webpack字樣,背景是紅色的頁面效果。
全域環境下使用第三方函式庫(provide-plugin or imports-loader)
為了避免每次使用第三方函式庫,都需要用import或require( )引用它們,可以將它們定義為全域的變數。
而webpack的ProvidePlugin內建的插件,可以解決這個問題。詳情可參考ProvidePlugin這篇文章的介紹。
避免cdn所引用的jquery衝突,這裡使用lodash。
首先,安裝lodash依賴,指令如下:
yarn add lodash --dev
然後,在webpack.config.js中,加入以下程式碼:
new webpack.ProvidePlugin({ _: 'lodash' }),
其次,在module.js中加入以下程式碼:
... var arr = [1, 2, 3, 4, 5 ,6]; // provide-plugin $(document.body).append('<h1>' + _.concat(arr, '~') + '</h1'); ...
最後,執行npm run test腳本指令,建置完成後,你就可以瀏覽器的頁面中增加了1,2,3,4,5,6,~。
如果,你想指定lodash的某個工具函數可以全域使用,如:_.concat,
首先,像下面這樣修改webapck.config.js,程式碼如下:
... new webpack.ProvidePlugin({ // _: 'lodash', _concat: ['lodash', 'concat'] }), ...
然後,修改module.js,程式碼如下:
... var arr = [1, 2, 3, 4, 5 ,6]; // provide-plugin // $(document.body).append('<h1>' + _.concat(arr, '~') + '</h1'); $(document.body).append('<h1>' + _concat(arr, '~') + '</h1'); ...
如果不喜歡用外掛的,也可以考慮使用import-loader,它也可以達到相同的目的。
為了避免不必要的干擾,可以使用underscore來示範。
首先,安裝imports-loader依賴,指令如下:
yarn add imports-loader --dev
然後,安裝underscore依賴,指令如下:
yarn add underscore
其次,在webapck.config.js中加入如下程式碼:
... module: { rules: [ { test: require.resolve('underscore'), use: 'imports-loader?_=underscore' }, ... ] }, ...
註:underscore和lodash都是用的是單例的模式開發的,它們實例化的建構子的名字都是_,為了作區分,需要對其中一個做一下改變。 imports-loader對這個標識起別名有點兒困難,而provide-plugin則沒有這個問題,可以定一個個性化的別名。
修改webpack.config.js,程式碼如下:
new webpack.ProvidePlugin({ // _: 'lodash', // _concat: ['lodash', 'concat'], __: 'lodash' }),
可以為lodash定義為__與underscore的_作區分。
然後,修改module.js,程式碼如下:
... // provide-plugin // $(document.body).append('<h1>' + _.concat(arr, '~') + '</h1'); // $(document.body).append('<h1>' + _concat(arr, '~') + '</h1'); $(document.body).append('<h1>' + __.concat(arr, '~') + '</h1'); ...
最後,儲存所有的文件,可以在瀏覽器中看到相似的結果(儲存後,nodemon自啟動瀏覽器) 。
cdn與externals
之前遇到了一些externals的問題,為什麼要詳細的說,是因為很多人不明白它到底用來幹什麼的。
場景再現:
之前,有一個項目使用了jquery,由於這個函式庫的比較經典,它在應用的各個模組中被頻繁引用。使用的方式如下:
import $ from 'jquery'
或
var $ = require('jquery')
結果是建置結束後,檔案比較大。那麼考慮使用cdn,如上文所描述的。這樣需要刪除import或require的引用,同時刪除安裝的jquery依賴,但是由於專案結構比較亂,模組比較多,為了避免造成少改或漏改的問題,會造成應用出錯。怎麼辦呢?
有的人說,不刪除jquery依賴,那麼使用cdn的目的就沒有意義了。而使用external則可以解決這個問題。
可以在module.js檔案中加入以下程式碼:
... var $ = require('jquery') ...
然後,儲存文件,發現建置輸出提示如下的錯誤:
ERROR in ./module.js Module not found: Error: Can't resolve 'jquery' in 'E:\workspace\me\webpack-play\demo\example-1' @ ./module.js 3:0-23 @ ./main.js @ multi (webpack)-dev-server/client?http://localhost:8080 ./main.js
模組module.js中的jquery不能被解析。
緊接著,在webpack.config.js中加入以下程式碼:
externals: { jquery: 'jQuery', jquery: '$' },
其中jquery代表的是require('jquery')中的jquery,而jQuery和$代表的是jquery這個函式庫本身提供的可是實例化的識別碼。其它的函式庫的cdn化,修改類似jquery。
但是,如果在專案一開始就決定用cdn的話,就不要在使用jquery的模組中,使用var $ = require('jquery') 或import $ from 'jquery';,雖然這樣做不會報錯,但是如果出於某方面的考慮,後期可能會引入jquery依賴,那麼就必須使用var $ = require('jquery') 或import $ from 'jquery';。
#以上是webpack引入第三方函式庫的方式及注意事項(程式碼範例)的詳細內容。更多資訊請關注PHP中文網其他相關文章!