2017年12月7日更新,添加了
clean-webpack-plugin
,babel-env-preset
,添加本文涉及到的所有代碼的示例毅桃,如果你在學(xué)習(xí)過程中出錯了够话,可點(diǎn)擊此處參考
寫在前面的話
閱讀本文之前,先看下面這個webpack的配置文件明也,如果每一項(xiàng)你都懂洼冻,那本文能帶給你的收獲也許就比較有限漫试,你可以快速瀏覽或直接跳過;如果你和十天前的我一樣碘赖,對很多選項(xiàng)存在著疑惑,那花一段時間慢慢閱讀本文外构,你的疑惑一定一個一個都會消失普泡;如果你以前沒怎么接觸過Webpack,而你又你對webpack感興趣审编,那么動手跟著本文中那個貫穿始終的例子寫一次撼班,寫完以后你會發(fā)現(xiàn)你已明明白白的走進(jìn)了Webpack的大門。
// 一個常見的`webpack`配置文件
const webpack = require('webpack');
const HtmlWebpackPlugin = require('html-webpack-plugin');
const ExtractTextPlugin = require('extract-text-webpack-plugin');
module.exports = {
entry: __dirname + "/app/main.js", //已多次提及的唯一入口文件
output: {
path: __dirname + "/build",
filename: "bundle-[hash].js"
},
devtool: 'none',
devServer: {
contentBase: "./public", //本地服務(wù)器所加載的頁面所在的目錄
historyApiFallback: true, //不跳轉(zhuǎn)
inline: true,
hot: true
},
module: {
rules: [{
test: /(\.jsx|\.js)$/,
use: {
loader: "babel-loader"
},
exclude: /node_modules/
}, {
test: /\.css$/,
use: ExtractTextPlugin.extract({
fallback: "style-loader",
use: [{
loader: "css-loader",
options: {
modules: true,
localIdentName: '[name]__[local]--[hash:base64:5]'
}
}, {
loader: "postcss-loader"
}],
})
}
}
]
},
plugins: [
new webpack.BannerPlugin('版權(quán)所有垒酬,翻版必究'),
new HtmlWebpackPlugin({
template: __dirname + "/app/index.tmpl.html" //new 一個這個插件的實(shí)例砰嘁,并傳入相關(guān)的參數(shù)
}),
new webpack.optimize.OccurrenceOrderPlugin(),
new webpack.optimize.UglifyJsPlugin(),
new ExtractTextPlugin("style.css")
]
};
什么是WebPack件炉,為什么要使用它?
為什要使用WebPack
現(xiàn)今的很多網(wǎng)頁其實(shí)可以看做是功能豐富的應(yīng)用矮湘,它們擁有著復(fù)雜的JavaScript代碼和一大堆依賴包斟冕。為了簡化開發(fā)的復(fù)雜度,前端社區(qū)涌現(xiàn)出了很多好的實(shí)踐方法
- 模塊化缅阳,讓我們可以把復(fù)雜的程序細(xì)化為小的文件;
- 類似于TypeScript這種在JavaScript基礎(chǔ)上拓展的開發(fā)語言:使我們能夠?qū)崿F(xiàn)目前版本的JavaScript不能直接使用的特性磕蛇,并且之后還能轉(zhuǎn)換為JavaScript文件使瀏覽器可以識別;
- Scss十办,less等CSS預(yù)處理器
- ...
這些改進(jìn)確實(shí)大大的提高了我們的開發(fā)效率秀撇,但是利用它們開發(fā)的文件往往需要進(jìn)行額外的處理才能讓瀏覽器識別,而手動處理又是非常繁瑣的,這就為WebPack類的工具的出現(xiàn)提供了需求向族。
什么是Webpack
WebPack可以看做是模塊打包機(jī):它做的事情是呵燕,分析你的項(xiàng)目結(jié)構(gòu),找到JavaScript模塊以及其它的一些瀏覽器不能直接運(yùn)行的拓展語言(Scss件相,TypeScript等)再扭,并將其轉(zhuǎn)換和打包為合適的格式供瀏覽器使用。
WebPack和Grunt以及Gulp相比有什么特性
其實(shí)Webpack和另外兩個并沒有太多的可比性适肠,Gulp/Grunt是一種能夠優(yōu)化前端的開發(fā)流程的工具霍衫,而WebPack是一種模塊化的解決方案,不過Webpack的優(yōu)點(diǎn)使得Webpack在很多場景下可以替代Gulp/Grunt類的工具侯养。
Grunt和Gulp的工作方式是:在一個配置文件中敦跌,指明對某些文件進(jìn)行類似編譯,組合逛揩,壓縮等任務(wù)的具體步驟柠傍,工具之后可以自動替你完成這些任務(wù)。
Grunt和Gulp的工作流程
Webpack的工作方式是:把你的項(xiàng)目當(dāng)做一個整體辩稽,通過一個給定的主文件(如:index.js)惧笛,Webpack將從這個文件開始找到你的項(xiàng)目的所有依賴文件,使用loaders處理它們逞泄,最后打包為一個(或多個)瀏覽器可識別的JavaScript文件患整。
Webpack工作方式
如果實(shí)在要把二者進(jìn)行比較,Webpack的處理速度更快更直接喷众,能打包更多不同類型的文件各谚。
開始使用Webpack
初步了解了Webpack工作方式后,我們一步步的開始學(xué)習(xí)使用Webpack到千。
安裝
Webpack可以使用npm安裝昌渤,新建一個空的練習(xí)文件夾(此處命名為webpack sample project),在終端中轉(zhuǎn)到該文件夾后執(zhí)行下述指令就可以完成安裝憔四。
//全局安裝
npm install -g webpack
//安裝到你的項(xiàng)目目錄
npm install --save-dev webpack
正式使用Webpack前的準(zhǔn)備
- 在上述練習(xí)文件夾中創(chuàng)建一個package.json文件膀息,這是一個標(biāo)準(zhǔn)的npm說明文件般眉,里面蘊(yùn)含了豐富的信息,包括當(dāng)前項(xiàng)目的依賴模塊潜支,自定義的腳本任務(wù)等等甸赃。在終端中使用
npm init
命令可以自動創(chuàng)建這個package.json文件
npm init
輸入這個命令后,終端會問你一系列諸如項(xiàng)目名稱毁腿,項(xiàng)目描述辑奈,作者等信息,不過不用擔(dān)心已烤,如果你不準(zhǔn)備在npm中發(fā)布你的模塊鸠窗,這些問題的答案都不重要,回車默認(rèn)即可胯究。
- package.json文件已經(jīng)就緒稍计,我們在本項(xiàng)目中安裝Webpack作為依賴包
// 安裝Webpack
npm install --save-dev webpack
- 回到之前的空文件夾,并在里面創(chuàng)建兩個文件夾,app文件夾和public文件夾裕循,app文件夾用來存放原始數(shù)據(jù)和我們將寫的JavaScript模塊臣嚣,public文件夾用來存放之后供瀏覽器讀取的文件(包括使用webpack打包生成的js文件以及一個
index.html
文件)。接下來我們再創(chuàng)建三個文件:
-
index.html
--放在public文件夾中; -
Greeter.js
-- 放在app文件夾中; -
main.js
-- 放在app文件夾中;
此時項(xiàng)目結(jié)構(gòu)如下圖所示
項(xiàng)目結(jié)構(gòu)
我們在index.html文件中寫入最基礎(chǔ)的html代碼剥哑,它在這里目的在于引入打包后的js文件(這里我們先把之后打包后的js文件命名為bundle.js
硅则,之后我們還會詳細(xì)講述)。
<!-- index.html -->
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Webpack Sample Project</title>
</head>
<body>
<div id='root'>
</div>
<script src="bundle.js"></script>
</body>
</html>
我們在Greeter.js
中定義一個返回包含問候信息的html
元素的函數(shù),并依據(jù)CommonJS規(guī)范導(dǎo)出這個函數(shù)為一個模塊:
// Greeter.js
module.exports = function() {
var greet = document.createElement('div');
greet.textContent = "Hi there and greetings!";
return greet;
};
main.js
文件中我們寫入下述代碼株婴,用以把Greeter模塊
返回的節(jié)點(diǎn)插入頁面怎虫。
//main.js
const greeter = require('./Greeter.js');
document.querySelector("#root").appendChild(greeter());
正式使用Webpack
webpack可以在終端中使用,在基本的使用方法如下:
# {extry file}出填寫入口文件的路徑困介,本文中就是上述main.js的路徑大审,
# {destination for bundled file}處填寫打包文件的存放路徑
# 填寫路徑的時候不用添加{}
webpack {entry file} {destination for bundled file}
指定入口文件后,webpack將自動識別項(xiàng)目所依賴的其它文件座哩,不過需要注意的是如果你的webpack不是全局安裝的徒扶,那么當(dāng)你在終端中使用此命令時,需要額外指定其在node_modules中的地址根穷,繼續(xù)上面的例子姜骡,在終端中輸入如下命令
# webpack非全局安裝的情況
node_modules/.bin/webpack app/main.js public/bundle.js
結(jié)果如下
使用命令行打包
可以看出webpack
同時編譯了main.js
和Greeter,js
,現(xiàn)在打開index.html
,可以看到如下結(jié)果
htmlResult1
有沒有很激動,已經(jīng)成功的使用Webpack
打包了一個文件了屿良。不過在終端中進(jìn)行復(fù)雜的操作溶浴,其實(shí)是不太方便且容易出錯的,接下來看看Webpack的另一種更常見的使用方法管引。
通過配置文件來使用Webpack
Webpack擁有很多其它的比較高級的功能(比如說本文后面會介紹的loaders
和plugins
),這些功能其實(shí)都可以通過命令行模式實(shí)現(xiàn)闯两,但是正如前面提到的褥伴,這樣不太方便且容易出錯的谅将,更好的辦法是定義一個配置文件,這個配置文件其實(shí)也是一個簡單的JavaScript模塊重慢,我們可以把所有的與打包相關(guān)的信息放在里面饥臂。
繼續(xù)上面的例子來說明如何寫這個配置文件,在當(dāng)前練習(xí)文件夾的根目錄下新建一個名為webpack.config.js
的文件似踱,我們在其中寫入如下所示的簡單配置代碼隅熙,目前的配置主要涉及到的內(nèi)容是入口文件路徑和打包后文件的存放路徑。
module.exports = {
entry: __dirname + "/app/main.js",//已多次提及的唯一入口文件
output: {
path: __dirname + "/public",//打包后的文件存放的地方
filename: "bundle.js"http://打包后輸出文件的文件名
}
}
注:“__dirname”是node.js中的一個全局變量核芽,它指向當(dāng)前執(zhí)行腳本所在的目錄囚戚。
有了這個配置之后,再打包文件轧简,只需在終端里運(yùn)行webpack(非全局安裝需使用node_modules/.bin/webpack)
命令就可以了驰坊,這條命令會自動引用webpack.config.js
文件中的配置選項(xiàng),示例如下:
配合配置文件進(jìn)行打包
又學(xué)會了一種使用Webpack
的方法哮独,這種方法不用管那煩人的命令行參數(shù)拳芙,有沒有感覺很爽。如果我們可以連webpack(非全局安裝需使用node_modules/.bin/webpack)
這條命令都可以不用皮璧,那種感覺會不會更爽~舟扎,繼續(xù)看下文。
更快捷的執(zhí)行打包任務(wù)
在命令行中輸入命令需要代碼類似于node_modules/.bin/webpack
這樣的路徑其實(shí)是比較煩人的悴务,不過值得慶幸的是npm
可以引導(dǎo)任務(wù)執(zhí)行睹限,對npm
進(jìn)行配置后可以在命令行中使用簡單的npm start
命令來替代上面略微繁瑣的命令。在package.json
中對scripts
對象進(jìn)行相關(guān)設(shè)置即可惨寿,設(shè)置方法如下邦泄。
{
"name": "webpack-sample-project",
"version": "1.0.0",
"description": "Sample webpack project",
"scripts": {
"start": "webpack" // 修改的是這里,JSON文件不支持注釋裂垦,引用時請清除
},
"author": "zhang",
"license": "ISC",
"devDependencies": {
"webpack": "3.10.0"
}
}
注:
package.json
中的script
會安裝一定順序?qū)ふ颐顚?yīng)位置顺囊,本地的node_modules/.bin
路徑就在這個尋找清單中,所以無論是全局還是局部安裝的Webpack蕉拢,你都不需要寫前面那指明詳細(xì)的路徑了特碳。
npm的start
命令是一個特殊的腳本名稱,其特殊性表現(xiàn)在晕换,在命令行中使用npm start
就可以執(zhí)行其對于的命令午乓,如果對應(yīng)的此腳本名稱不是start
,想要在命令行中運(yùn)行時闸准,需要這樣用npm run {script name}
如npm run build
益愈,我們在命令行中輸入npm start
試試,輸出結(jié)果如下:
使用npm start 打包代碼
現(xiàn)在只需要使用npm start
就可以打包文件了,有沒有覺得webpack
也不過如此嘛蒸其,不過不要太小瞧webpack
敏释,要充分發(fā)揮其強(qiáng)大的功能我們需要修改配置文件的其它選項(xiàng),一項(xiàng)項(xiàng)來看摸袁。
Webpack的強(qiáng)大功能
生成Source Maps(使調(diào)試更容易)
開發(fā)總是離不開調(diào)試钥顽,方便的調(diào)試能極大的提高開發(fā)效率,不過有時候通過打包后的文件靠汁,你是不容易找到出錯了的地方蜂大,對應(yīng)的你寫的代碼的位置的,Source Maps
就是來幫我們解決這個問題的蝶怔。
通過簡單的配置奶浦,webpack
就可以在打包時為我們生成的source maps
,這為我們提供了一種對應(yīng)編譯文件和源文件的方法添谊,使得編譯后的代碼可讀性更高财喳,也更容易調(diào)試。
在webpack
的配置文件中配置source maps
斩狱,需要配置devtool
耳高,它有以下四種不同的配置選項(xiàng),各具優(yōu)缺點(diǎn)所踊,描述如下:
devtool選項(xiàng) | 配置結(jié)果 |
---|---|
source-map |
在一個單獨(dú)的文件中產(chǎn)生一個完整且功能完全的文件泌枪。這個文件具有最好的source map ,但是它會減慢打包速度秕岛; |
cheap-module-source-map |
在一個單獨(dú)的文件中生成一個不帶列映射的map 碌燕,不帶列映射提高了打包速度,但是也使得瀏覽器開發(fā)者工具只能對應(yīng)到具體的行继薛,不能對應(yīng)到具體的列(符號)修壕,會對調(diào)試造成不便; |
eval-source-map |
使用eval 打包源文件模塊遏考,在同一個文件中生成干凈的完整的source map 慈鸠。這個選項(xiàng)可以在不影響構(gòu)建速度的前提下生成完整的sourcemap ,但是對打包后輸出的JS文件的執(zhí)行具有性能和安全的隱患灌具。在開發(fā)階段這是一個非常好的選項(xiàng)青团,在生產(chǎn)階段則一定不要啟用這個選項(xiàng); |
cheap-module-eval-source-map |
這是在打包文件時最快的生成source map 的方法咖楣,生成的Source Map 會和打包后的JavaScript 文件同行顯示仪或,沒有列映射喉磁,和eval-source-map 選項(xiàng)具有相似的缺點(diǎn); |
正如上表所述胁赢,上述選項(xiàng)由上到下打包速度越來越快采呐,不過同時也具有越來越多的負(fù)面作用,較快的打包速度的后果就是對打包后的文件的的執(zhí)行有一定影響。
對小到中型的項(xiàng)目中,eval-source-map
是一個很好的選項(xiàng)锨阿,再次強(qiáng)調(diào)你只應(yīng)該開發(fā)階段使用它,我們繼續(xù)對上文新建的webpack.config.js
记罚,進(jìn)行如下配置:
module.exports = {
devtool: 'eval-source-map',
entry: __dirname + "/app/main.js",
output: {
path: __dirname + "/public",
filename: "bundle.js"
}
}
cheap-module-eval-source-map
方法構(gòu)建速度更快,但是不利于調(diào)試壳嚎,推薦在大型項(xiàng)目考慮時間成本時使用桐智。
使用webpack構(gòu)建本地服務(wù)器
想不想讓你的瀏覽器監(jiān)聽你的代碼的修改,并自動刷新顯示修改后的結(jié)果烟馅,其實(shí)Webpack
提供一個可選的本地開發(fā)服務(wù)器说庭,這個本地服務(wù)器基于node.js構(gòu)建,可以實(shí)現(xiàn)你想要的這些功能郑趁,不過它是一個單獨(dú)的組件刊驴,在webpack中進(jìn)行配置之前需要單獨(dú)安裝它作為項(xiàng)目依賴
npm install --save-dev webpack-dev-server
devserver作為webpack配置選項(xiàng)中的一項(xiàng),以下是它的一些配置選項(xiàng)寡润,更多配置可參考這里
devserver的配置選項(xiàng) | 功能描述 |
---|---|
contentBase | 默認(rèn)webpack-dev-server會為根文件夾提供本地服務(wù)器捆憎,如果想為另外一個目錄下的文件提供本地服務(wù)器,應(yīng)該在這里設(shè)置其所在目錄(本例設(shè)置到“public"目錄) |
port | 設(shè)置默認(rèn)監(jiān)聽端口梭纹,如果省略躲惰,默認(rèn)為”8080“ |
inline | 設(shè)置為true ,當(dāng)源文件改變時會自動刷新頁面 |
historyApiFallback | 在開發(fā)單頁應(yīng)用時非常有用变抽,它依賴于HTML5 history API础拨,如果設(shè)置為true ,所有的跳轉(zhuǎn)將指向index.html |
把這些命令加到webpack的配置文件中绍载,現(xiàn)在的配置文件webpack.config.js
如下所示
module.exports = {
devtool: 'eval-source-map',
entry: __dirname + "/app/main.js",
output: {
path: __dirname + "/public",
filename: "bundle.js"
},
devServer: {
contentBase: "./public",//本地服務(wù)器所加載的頁面所在的目錄
historyApiFallback: true,//不跳轉(zhuǎn)
inline: true//實(shí)時刷新
}
}
在package.json
中的scripts
對象中添加如下命令诡宗,用以開啟本地服務(wù)器:
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1",
"start": "webpack",
"server": "webpack-dev-server --open"
},
在終端中輸入npm run server
即可在本地的8080
端口查看結(jié)果
開啟本地服務(wù)器
Loaders
鼎鼎大名的Loaders登場了!
Loaders
是webpack
提供的最激動人心的功能之一了击儡。通過使用不同的loader
塔沃,webpack
有能力調(diào)用外部的腳本或工具,實(shí)現(xiàn)對不同格式的文件的處理曙痘,比如說分析轉(zhuǎn)換scss為css芳悲,或者把下一代的JS文件(ES6,ES7)轉(zhuǎn)換為現(xiàn)代瀏覽器兼容的JS文件边坤,對React的開發(fā)而言名扛,合適的Loaders可以把React的中用到的JSX文件轉(zhuǎn)換為JS文件。
Loaders需要單獨(dú)安裝并且需要在webpack.config.js
中的modules
關(guān)鍵字下進(jìn)行配置茧痒,Loaders的配置包括以下幾方面:
-
test
:一個用以匹配loaders所處理文件的拓展名的正則表達(dá)式(必須) -
loader
:loader的名稱(必須) -
include/exclude
:手動添加必須處理的文件(文件夾)或屏蔽不需要處理的文件(文件夾)(可選)肮韧; -
query
:為loaders提供額外的設(shè)置選項(xiàng)(可選)
不過在配置loader之前,我們把Greeter.js
里的問候消息放在一個單獨(dú)的JSON文件里,并通過合適的配置使Greeter.js
可以讀取該JSON文件的值,各文件修改后的代碼如下:
在app文件夾中創(chuàng)建帶有問候信息的JSON文件(命名為config.json
)
{
"greetText": "Hi there and greetings from JSON!"
}
更新后的Greeter.js
var config = require('./config.json');
module.exports = function() {
var greet = document.createElement('div');
greet.textContent = config.greetText;
return greet;
};
注 由于
webpack3.*/webpack2.*
已經(jīng)內(nèi)置可處理JSON文件弄企,這里我們無需再添加webpack1.*
需要的json-loader
超燃。在看如何具體使用loader之前我們先看看Babel是什么?
Babel
Babel其實(shí)是一個編譯JavaScript的平臺拘领,它可以編譯代碼幫你達(dá)到以下目的:
- 讓你能使用最新的JavaScript代碼(ES6意乓,ES7...),而不用管新標(biāo)準(zhǔn)是否被當(dāng)前使用的瀏覽器完全支持约素;
- 讓你能使用基于JavaScript進(jìn)行了拓展的語言届良,比如React的JSX;
Babel的安裝與配置
Babel其實(shí)是幾個模塊化的包圣猎,其核心功能位于稱為babel-core
的npm包中士葫,webpack可以把其不同的包整合在一起使用,對于每一個你需要的功能或拓展送悔,你都需要安裝單獨(dú)的包(用得最多的是解析Es6的babel-env-preset
包和解析JSX的babel-preset-react
包)慢显。
我們先來一次性安裝這些依賴包
// npm一次性安裝多個依賴模塊,模塊之間用空格隔開
npm install --save-dev babel-core babel-loader babel-preset-env babel-preset-react
在webpack
中配置Babel的方法如下:
module.exports = {
entry: __dirname + "/app/main.js",//已多次提及的唯一入口文件
output: {
path: __dirname + "/public",//打包后的文件存放的地方
filename: "bundle.js"http://打包后輸出文件的文件名
},
devtool: 'eval-source-map',
devServer: {
contentBase: "./public",//本地服務(wù)器所加載的頁面所在的目錄
historyApiFallback: true,//不跳轉(zhuǎn)
inline: true//實(shí)時刷新
},
module: {
rules: [
{
test: /(\.jsx|\.js)$/,
use: {
loader: "babel-loader",
options: {
presets: [
"env", "react"
]
}
},
exclude: /node_modules/
}
]
}
};
現(xiàn)在你的webpack的配置已經(jīng)允許你使用ES6以及JSX的語法了欠啤。繼續(xù)用上面的例子進(jìn)行測試荚藻,不過這次我們會使用React,記得先安裝 React 和 React-DOM
npm install --save react react-dom
接下來我們使用ES6的語法跪妥,更新Greeter.js
并返回一個React組件
//Greeter,js
import React, {Component} from 'react'
import config from './config.json';
class Greeter extends Component{
render() {
return (
<div>
{config.greetText}
</div>
);
}
}
export default Greeter
修改main.js
如下鞋喇,使用ES6的模塊定義和渲染Greeter模塊
// main.js
import React from 'react';
import {render} from 'react-dom';
import Greeter from './Greeter';
render(<Greeter />, document.getElementById('root'));
重新使用npm start
打包,如果之前打開的本地服務(wù)器沒有關(guān)閉眉撵,你應(yīng)該可以在localhost:8080
下看到與之前一樣的內(nèi)容侦香,這說明react
和es6
被正常打包了。
localhost:8080
Babel的配置
Babel其實(shí)可以完全在 webpack.config.js
中進(jìn)行配置纽疟,但是考慮到babel具有非常多的配置選項(xiàng)罐韩,在單一的webpack.config.js
文件中進(jìn)行配置往往使得這個文件顯得太復(fù)雜,因此一些開發(fā)者支持把babel的配置選項(xiàng)放在一個單獨(dú)的名為 ".babelrc" 的配置文件中污朽。我們現(xiàn)在的babel的配置并不算復(fù)雜散吵,不過之后我們會再加一些東西,因此現(xiàn)在我們就提取出相關(guān)部分蟆肆,分兩個配置文件進(jìn)行配置(webpack會自動調(diào)用.babelrc
里的babel配置選項(xiàng))矾睦,如下:
module.exports = {
entry: __dirname + "/app/main.js",//已多次提及的唯一入口文件
output: {
path: __dirname + "/public",//打包后的文件存放的地方
filename: "bundle.js"http://打包后輸出文件的文件名
},
devtool: 'eval-source-map',
devServer: {
contentBase: "./public",//本地服務(wù)器所加載的頁面所在的目錄
historyApiFallback: true,//不跳轉(zhuǎn)
inline: true//實(shí)時刷新
},
module: {
rules: [
{
test: /(\.jsx|\.js)$/,
use: {
loader: "babel-loader"
},
exclude: /node_modules/
}
]
}
};
//.babelrc
{
"presets": ["react", "env"]
}
到目前為止,我們已經(jīng)知道了炎功,對于模塊枚冗,Webpack能提供非常強(qiáng)大的處理功能,那那些是模塊呢蛇损。
一切皆模塊
Webpack有一個不可不說的優(yōu)點(diǎn),它把所有的文件都都當(dāng)做模塊處理,JavaScript代碼,CSS和fonts以及圖片等等通過合適的loader都可以被處理。
CSS
webpack提供兩個工具處理樣式表缨该,css-loader
和 style-loader
蛤袒,二者處理的任務(wù)不同,css-loader
使你能夠使用類似@import
和 url(...)
的方法實(shí)現(xiàn) require()
的功能,style-loader
將所有的計算后的樣式加入頁面中,二者組合在一起使你能夠把樣式表嵌入webpack打包后的JS文件中。
繼續(xù)上面的例子
//安裝
npm install --save-dev style-loader css-loader
//使用
module.exports = {
...
module: {
rules: [
{
test: /(\.jsx|\.js)$/,
use: {
loader: "babel-loader"
},
exclude: /node_modules/
},
{
test: /\.css$/,
use: [
{
loader: "style-loader"
}, {
loader: "css-loader"
}
]
}
]
}
};
請注意這里對同一個文件引入多個loader的方法誊役。
接下來击孩,在app文件夾里創(chuàng)建一個名字為"main.css"的文件,對一些元素設(shè)置樣式
/* main.css */
html {
box-sizing: border-box;
-ms-text-size-adjust: 100%;
-webkit-text-size-adjust: 100%;
}
*, *:before, *:after {
box-sizing: inherit;
}
body {
margin: 0;
font-family: 'Helvetica Neue', Helvetica, Arial, sans-serif;
}
h1, h2, h3, h4, h5, h6, p, ul {
margin: 0;
padding: 0;
}
我們這里例子中用到的webpack
只有單一的入口,其它的模塊需要通過 import
, require
, url
等與入口文件建立其關(guān)聯(lián),為了讓webpack能找到”main.css“文件,我們把它導(dǎo)入”main.js “中,如下
//main.js
import React from 'react';
import {render} from 'react-dom';
import Greeter from './Greeter';
import './main.css';//使用require導(dǎo)入css文件
render(<Greeter />, document.getElementById('root'));
通常情況下,css會和js打包到同一個文件中,并不會打包為一個單獨(dú)的css文件,不過通過合適的配置webpack也可以把css打包為單獨(dú)的文件的拐纱。
上面的代碼說明webpack是怎么把css當(dāng)做模塊看待的未斑,咱們繼續(xù)看一個更加真實(shí)的css模塊實(shí)踐。
CSS module
在過去的一些年里,JavaScript通過一些新的語言特性钠糊,更好的工具以及更好的實(shí)踐方法(比如說模塊化)發(fā)展得非常迅速。模塊使得開發(fā)者把復(fù)雜的代碼轉(zhuǎn)化為小的箩朴,干凈的钱床,依賴聲明明確的單元拐格,配合優(yōu)化工具撞叨,依賴管理和加載管理可以自動完成枷餐。
不過前端的另外一部分,CSS發(fā)展就相對慢一些,大多的樣式表卻依舊巨大且充滿了全局類名,維護(hù)和修改都非常困難。
被稱為CSS modules
的技術(shù)意在把JS的模塊化思想帶入CSS中來,通過CSS模塊,所有的類名冻河,動畫名默認(rèn)都只作用于當(dāng)前模塊擂错。Webpack對CSS模塊化提供了非常好的支持爽醋,只需要在CSS loader中進(jìn)行簡單配置即可田度,然后就可以直接把CSS的類名傳遞到組件的代碼中奸笤,這樣做有效避免了全局污染绒瘦。具體的代碼如下
module.exports = {
...
module: {
rules: [
{
test: /(\.jsx|\.js)$/,
use: {
loader: "babel-loader"
},
exclude: /node_modules/
},
{
test: /\.css$/,
use: [
{
loader: "style-loader"
}, {
loader: "css-loader",
options: {
modules: true, // 指定啟用css modules
localIdentName: '[name]__[local]--[hash:base64:5]' // 指定css的類名格式
}
}
]
}
]
}
};
我們在app文件夾下創(chuàng)建一個Greeter.css
文件來進(jìn)行一下測試
/* Greeter.css */
.root {
background-color: #eee;
padding: 10px;
border: 3px solid #ccc;
}
導(dǎo)入.root
到Greeter.js中
import React, {Component} from 'react';
import config from './config.json';
import styles from './Greeter.css';//導(dǎo)入
class Greeter extends Component{
render() {
return (
<div className={styles.root}> //使用cssModule添加類名的方法
{config.greetText}
</div>
);
}
}
export default Greeter
放心使用把呜魄,相同的類名也不會造成不同組件之間的污染赚窃。
應(yīng)用了css module后的樣式
CSS modules 也是一個很大的主題,有興趣的話可以去其官方文檔了解更多虑鼎。
CSS預(yù)處理器
Sass
和 Less
之類的預(yù)處理器是對原生CSS的拓展辱匿,它們允許你使用類似于variables
, nesting
, mixins
, inheritance
等不存在于CSS中的特性來寫CSS,CSS預(yù)處理器可以這些特殊類型的語句轉(zhuǎn)化為瀏覽器可識別的CSS語句炫彩,
你現(xiàn)在可能都已經(jīng)熟悉了匾七,在webpack里使用相關(guān)loaders進(jìn)行配置就可以使用了,以下是常用的CSS 處理loaders
:
Less Loader
Sass Loader
Stylus Loader
不過其實(shí)也存在一個CSS的處理平臺-PostCSS
江兢,它可以幫助你的CSS實(shí)現(xiàn)更多的功能昨忆,在其官方文檔可了解更多相關(guān)知識。
舉例來說如何使用PostCSS杉允,我們使用PostCSS來為CSS代碼自動添加適應(yīng)不同瀏覽器的CSS前綴邑贴。
首先安裝postcss-loader
和 autoprefixer
(自動添加前綴的插件)
npm install --save-dev postcss-loader autoprefixer
接下來席里,在webpack配置文件中添加postcss-loader
,在根目錄新建postcss.config.js
,并添加如下代碼之后拢驾,重新使用npm start
打包時奖磁,你寫的css會自動根據(jù)Can i use里的數(shù)據(jù)添加不同前綴了。
//webpack.config.js
module.exports = {
...
module: {
rules: [
{
test: /(\.jsx|\.js)$/,
use: {
loader: "babel-loader"
},
exclude: /node_modules/
},
{
test: /\.css$/,
use: [
{
loader: "style-loader"
}, {
loader: "css-loader",
options: {
modules: true
}
}, {
loader: "postcss-loader"
}
]
}
]
}
}
// postcss.config.js
module.exports = {
plugins: [
require('autoprefixer')
]
}
至此繁疤,本文已經(jīng)談?wù)摿颂幚鞪S的Babel和處理CSS的PostCSS的基本用法咖为,它們其實(shí)也是兩個單獨(dú)的平臺,配合webpack
可以很好的發(fā)揮它們的作用稠腊。接下來介紹Webpack中另一個非常重要的功能-Plugins
插件(Plugins)
插件(Plugins)是用來拓展Webpack功能的躁染,它們會在整個構(gòu)建過程中生效,執(zhí)行相關(guān)的任務(wù)麻养。
Loaders和Plugins常常被弄混褐啡,但是他們其實(shí)是完全不同的東西,可以這么來說鳖昌,loaders是在打包構(gòu)建過程中用來處理源文件的(JSX备畦,Scss,Less..)许昨,一次處理一個懂盐,插件并不直接操作單個文件,它直接對整個構(gòu)建過程其作用糕档。
Webpack有很多內(nèi)置插件莉恼,同時也有很多第三方插件,可以讓我們完成更加豐富的功能速那。
使用插件的方法
要使用某個插件俐银,我們需要通過npm
安裝它,然后要做的就是在webpack配置中的plugins關(guān)鍵字部分添加該插件的一個實(shí)例(plugins是一個數(shù)組)繼續(xù)上面的例子端仰,我們添加了一個給打包后代碼添加版權(quán)聲明的插件捶惜。
const webpack = require('webpack');
module.exports = {
...
module: {
rules: [
{
test: /(\.jsx|\.js)$/,
use: {
loader: "babel-loader"
},
exclude: /node_modules/
},
{
test: /\.css$/,
use: [
{
loader: "style-loader"
}, {
loader: "css-loader",
options: {
modules: true
}
}, {
loader: "postcss-loader"
}
]
}
]
},
plugins: [
new webpack.BannerPlugin('版權(quán)所有,翻版必究')
],
};
通過這個插件荔烧,打包后的JS文件顯示如下
版權(quán)所有吱七,翻版必究
這就是webpack插件的基礎(chǔ)用法了,下面給大家推薦幾個常用的插件
HtmlWebpackPlugin
這個插件的作用是依據(jù)一個簡單的index.html
模板鹤竭,生成一個自動引用你打包后的JS文件的新index.html
踊餐。這在每次生成的js文件名稱不同時非常有用(比如添加了hash
值)。
安裝
npm install --save-dev html-webpack-plugin
這個插件自動完成了我們之前手動做的一些事情臀稚,在正式使用之前需要對一直以來的項(xiàng)目結(jié)構(gòu)做一些更改:
- 移除public文件夾吝岭,利用此插件,
index.html
文件會自動生成,此外CSS已經(jīng)通過前面的操作打包到JS中了苍碟。 - 在app目錄下酒觅,創(chuàng)建一個
index.tmpl.html
文件模板,這個模板包含title
等必須元素微峰,在編譯過程中舷丹,插件會依據(jù)此模板生成最終的html頁面,會自動添加所依賴的 css, js蜓肆,favicon等文件颜凯,index.tmpl.html
中的模板源代碼如下:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Webpack Sample Project</title>
</head>
<body>
<div id='root'>
</div>
</body>
</html>
3.更新webpack
的配置文件,方法同上,新建一個build
文件夾用來存放最終的輸出文件
const webpack = require('webpack');
const HtmlWebpackPlugin = require('html-webpack-plugin');
module.exports = {
entry: __dirname + "/app/main.js",//已多次提及的唯一入口文件
output: {
path: __dirname + "/build",
filename: "bundle.js"
},
devtool: 'eval-source-map',
devServer: {
contentBase: "./public",//本地服務(wù)器所加載的頁面所在的目錄
historyApiFallback: true,//不跳轉(zhuǎn)
inline: true//實(shí)時刷新
},
module: {
rules: [
{
test: /(\.jsx|\.js)$/,
use: {
loader: "babel-loader"
},
exclude: /node_modules/
},
{
test: /\.css$/,
use: [
{
loader: "style-loader"
}, {
loader: "css-loader",
options: {
modules: true
}
}, {
loader: "postcss-loader"
}
]
}
]
},
plugins: [
new webpack.BannerPlugin('版權(quán)所有仗扬,翻版必究'),
new HtmlWebpackPlugin({
template: __dirname + "/app/index.tmpl.html"http://new 一個這個插件的實(shí)例症概,并傳入相關(guān)的參數(shù)
})
],
};
再次執(zhí)行npm start
你會發(fā)現(xiàn),build文件夾下面生成了bundle.js
和index.html
早芭。
build文件夾
Hot Module Replacement
Hot Module Replacement
(HMR)也是webpack里很有用的一個插件彼城,它允許你在修改組件代碼后,自動刷新實(shí)時預(yù)覽修改后的效果退个。
在webpack中實(shí)現(xiàn)HMR也很簡單募壕,只需要做兩項(xiàng)配置
- 在webpack配置文件中添加HMR插件;
- 在Webpack Dev Server中添加“hot”參數(shù)语盈;
不過配置完這些后舱馅,JS模塊其實(shí)還是不能自動熱加載的,還需要在你的JS模塊中執(zhí)行一個Webpack提供的API才能實(shí)現(xiàn)熱加載刀荒,雖然這個API不難使用代嗤,但是如果是React模塊,使用我們已經(jīng)熟悉的Babel可以更方便的實(shí)現(xiàn)功能熱加載缠借。
整理下我們的思路干毅,具體實(shí)現(xiàn)方法如下
-
Babel
和webpack
是獨(dú)立的工具 - 二者可以一起工作
- 二者都可以通過插件拓展功能
- HMR是一個webpack插件,它讓你能瀏覽器中實(shí)時觀察模塊修改后的效果泼返,但是如果你想讓它工作硝逢,需要對模塊進(jìn)行額外的配額;
- Babel有一個叫做
react-transform-hrm
的插件符隙,可以在不對React模塊進(jìn)行額外的配置的前提下讓HMR正常工作;
還是繼續(xù)上例來實(shí)際看看如何配置
const webpack = require('webpack');
const HtmlWebpackPlugin = require('html-webpack-plugin');
module.exports = {
entry: __dirname + "/app/main.js",//已多次提及的唯一入口文件
output: {
path: __dirname + "/build",
filename: "bundle.js"
},
devtool: 'eval-source-map',
devServer: {
contentBase: "./public",//本地服務(wù)器所加載的頁面所在的目錄
historyApiFallback: true,//不跳轉(zhuǎn)
inline: true,
hot: true
},
module: {
rules: [
{
test: /(\.jsx|\.js)$/,
use: {
loader: "babel-loader"
},
exclude: /node_modules/
},
{
test: /\.css$/,
use: [
{
loader: "style-loader"
}, {
loader: "css-loader",
options: {
modules: true
}
}, {
loader: "postcss-loader"
}
]
}
]
},
plugins: [
new webpack.BannerPlugin('版權(quán)所有垫毙,翻版必究'),
new HtmlWebpackPlugin({
template: __dirname + "/app/index.tmpl.html"http://new 一個這個插件的實(shí)例霹疫,并傳入相關(guān)的參數(shù)
}),
new webpack.HotModuleReplacementPlugin()//熱加載插件
],
};
安裝react-transform-hmr
npm install --save-dev babel-plugin-react-transform react-transform-hmr
配置Babel
// .babelrc
{
"presets": ["react", "env"],
"env": {
"development": {
"plugins": [["react-transform", {
"transforms": [{
"transform": "react-transform-hmr",
"imports": ["react"],
"locals": ["module"]
}]
}]]
}
}
}
現(xiàn)在當(dāng)你使用React時,可以熱加載模塊了,每次保存就能在瀏覽器上看到更新內(nèi)容综芥。
產(chǎn)品階段的構(gòu)建
目前為止丽蝎,我們已經(jīng)使用webpack構(gòu)建了一個完整的開發(fā)環(huán)境。但是在產(chǎn)品階段,可能還需要對打包的文件進(jìn)行額外的處理屠阻,比如說優(yōu)化红省,壓縮,緩存以及分離CSS和JS国觉。
對于復(fù)雜的項(xiàng)目來說吧恃,需要復(fù)雜的配置,這時候分解配置文件為多個小的文件可以使得事情井井有條麻诀,以上面的例子來說痕寓,我們創(chuàng)建一個webpack.production.config.js
的文件,在里面加上基本的配置,它和原始的webpack.config.js很像蝇闭,如下
// webpack.production.config.js
const webpack = require('webpack');
const HtmlWebpackPlugin = require('html-webpack-plugin');
module.exports = {
entry: __dirname + "/app/main.js", //已多次提及的唯一入口文件
output: {
path: __dirname + "/build",
filename: "bundle.js"
},
devtool: 'null', //注意修改了這里呻率,這能大大壓縮我們的打包代碼
devServer: {
contentBase: "./public", //本地服務(wù)器所加載的頁面所在的目錄
historyApiFallback: true, //不跳轉(zhuǎn)
inline: true,
hot: true
},
module: {
rules: [{
test: /(\.jsx|\.js)$/,
use: {
loader: "babel-loader"
},
exclude: /node_modules/
}, {
test: /\.css$/,
use: ExtractTextPlugin.extract({
fallback: "style-loader",
use: [{
loader: "css-loader",
options: {
modules: true
}
}, {
loader: "postcss-loader"
}],
})
}]
},
plugins: [
new webpack.BannerPlugin('版權(quán)所有,翻版必究'),
new HtmlWebpackPlugin({
template: __dirname + "/app/index.tmpl.html" //new 一個這個插件的實(shí)例呻引,并傳入相關(guān)的參數(shù)
}),
new webpack.HotModuleReplacementPlugin() //熱加載插件
],
};
//package.json
{
"name": "test",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1",
"start": "webpack",
"server": "webpack-dev-server --open",
"build": "NODE_ENV=production webpack --config ./webpack.production.config.js --progress"
},
"author": "",
"license": "ISC",
"devDependencies": {
...
},
"dependencies": {
"react": "^15.6.1",
"react-dom": "^15.6.1"
}
}
注意:如果是window電腦礼仗,
build
需要配置為"build": "set NODE_ENV=production && webpack --config ./webpack.production.config.js --progress"
.謝謝評論區(qū)簡友提醒。
優(yōu)化插件
webpack提供了一些在發(fā)布階段非常有用的優(yōu)化插件逻悠,它們大多來自于webpack社區(qū)元践,可以通過npm安裝,通過以下插件可以完成產(chǎn)品發(fā)布階段所需的功能
-
OccurenceOrderPlugin
:為組件分配ID蹂风,通過這個插件webpack可以分析和優(yōu)先考慮使用最多的模塊卢厂,并為它們分配最小的ID -
UglifyJsPlugin
:壓縮JS代碼; -
ExtractTextPlugin
:分離CSS和JS文件
我們繼續(xù)用例子來看看如何添加它們惠啄,OccurenceOrder 和 UglifyJS plugins 都是內(nèi)置插件慎恒,你需要做的只是安裝其它非內(nèi)置插件
npm install --save-dev extract-text-webpack-plugin
在配置文件的plugins后引用它們
// webpack.production.config.js
const webpack = require('webpack');
const HtmlWebpackPlugin = require('html-webpack-plugin');
const ExtractTextPlugin = require('extract-text-webpack-plugin');
module.exports = {
entry: __dirname + "/app/main.js",//已多次提及的唯一入口文件
output: {
path: __dirname + "/build",
filename: "bundle.js"
},
devtool: 'none',
devServer: {
contentBase: "./public",//本地服務(wù)器所加載的頁面所在的目錄
historyApiFallback: true,//不跳轉(zhuǎn)
inline: true,
hot: true
},
module: {
rules: [
{
test: /(\.jsx|\.js)$/,
use: {
loader: "babel-loader"
},
exclude: /node_modules/
},
{
test: /\.css$/,
use: [
{
loader: "style-loader"
}, {
loader: "css-loader",
options: {
modules: true
}
}, {
loader: "postcss-loader"
}
]
}
]
},
plugins: [
new webpack.BannerPlugin('版權(quán)所有,翻版必究'),
new HtmlWebpackPlugin({
template: __dirname + "/app/index.tmpl.html"
}),
new webpack.optimize.OccurrenceOrderPlugin(),
new webpack.optimize.UglifyJsPlugin(),
new ExtractTextPlugin("style.css")
],
};
此時執(zhí)行npm run build
可以看見代碼是被壓縮后的
壓縮后的代碼
緩存
緩存無處不在撵渡,使用緩存的最好方法是保證你的文件名和文件內(nèi)容是匹配的(內(nèi)容改變融柬,名稱相應(yīng)改變)
webpack可以把一個哈希值添加到打包的文件名中,使用方法如下,添加特殊的字符串混合體([name], [id] and [hash])到輸出文件名前
const webpack = require('webpack');
const HtmlWebpackPlugin = require('html-webpack-plugin');
const ExtractTextPlugin = require('extract-text-webpack-plugin');
module.exports = {
..
output: {
path: __dirname + "/build",
filename: "bundle-[hash].js"
},
...
};
現(xiàn)在用戶會有合理的緩存了趋距。
帶hash值的js名
去除build
文件中的殘余文件
添加了hash
之后粒氧,會導(dǎo)致改變文件內(nèi)容后重新打包時,文件名不同而內(nèi)容越來越多节腐,因此這里介紹另外一個很好用的插件clean-webpack-plugin
外盯。
安裝:
cnpm install clean-webpack-plugin --save-dev
使用:
引入clean-webpack-plugin
插件后在配置文件的plugins
中做相應(yīng)配置即可:
const CleanWebpackPlugin = require("clean-webpack-plugin");
plugins: [
...// 這里是之前配置的其它各種插件
new CleanWebpackPlugin('build/*.*', {
root: __dirname,
verbose: true,
dry: false
})
]
關(guān)于clean-webpack-plugin
的詳細(xì)使用可參考這里
總結(jié)
其實(shí)這是一年前的文章了,趁周末重新運(yùn)行和修改了一下翼雀,現(xiàn)在所有的代碼都可以正常運(yùn)行饱苟,所用webpack基于最新的
webpack3.5.3
。希望依舊能對你有幫助狼渊。