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'
                },
                ...
        ]
},
...

注:underscorelodash都是用的是單例的模式開發的,它們實例化的構造函數的名字都是_,爲了作區分,需要對其中一個做一下改變。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,如上文描述的那樣。這樣需要刪除importrequire的引用,同時刪除安裝的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';

參考源代碼

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章