webpack引入第三方庫的方式，以及注意事項

時間 2019-11-07

標籤 webpack 引入第三方方式以及注意事項简体版

原文原文鏈接

通常狀況下，咱們不用擔憂所使用的第三方庫，在npm管理倉庫中找不到。css

若是須要某一個庫，如：jquery，能夠直接運行npm install jquery腳本命令來安裝這個項目所須要的依賴；html

而後，在使用jquery的模塊文件中，經過import $ from 'jquery'或者var $ = require('jquery')來引入。node

這是經常使用的在webpack構建的項目中引入第三方庫的方式。jquery

注：爲了更好的演示示例代碼，示例是在nodemon這篇文章的基礎上操做的。webpack

可是，在不一樣的場景下，對webpack構建的項目有不一樣的需求:git

項目的體積足夠小(cdn)

若是是webapck的處理方式，可參考webapck——實現構建輸出最小這篇文章。github

使用非webapck的處理方式，如：CDN。web

操做也很簡單，若是使用html-webpack-plugin直接在模板文件template/index.html中引入某個cdn（如：boot CDN）上的某個第三方庫（如：jquery），參考代碼以下：npm

<!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';。

相關標籤/搜索

每日一句

每一个你不满意的现在，都有一个你没有努力的曾经。