寫在前面的話
閱讀本文之前,先看下面這個webpack的配置文件,如果每一項你都懂,那本文能帶給你的收獲也許就比較有限,你可以快速瀏覽或直接跳過;如果你和十天前的我一樣,對很多選項存在著疑惑,那花一段時間慢慢閱讀本文,你的疑惑一定一個一個都會消失;如果你以前沒怎么接觸過Webpack,而你又你對webpack感興趣,那么動手跟著本文中那個貫穿始終的例子寫一次,寫完以后你會發(fā)現(xiàn)你已明明白白的走進了Webpack的大門。
// 一個常見的`webpack`配置文件constwebpack =require('webpack');constHtmlWebpackPlugin =require('html-webpack-plugin');constExtractTextPlugin =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: [newwebpack.BannerPlugin('版權(quán)所有,翻版必究'),newHtmlWebpackPlugin({template: __dirname +"/app/index.tmpl.html"http://new 一個這個插件的實例,并傳入相關(guān)的參數(shù)}),newwebpack.optimize.OccurrenceOrderPlugin(),newwebpack.optimize.UglifyJsPlugin(),newExtractTextPlugin("style.css")? ? ]};
什么是WebPack,為什么要使用它?
為什要使用WebPack
現(xiàn)今的很多網(wǎng)頁其實可以看做是功能豐富的應(yīng)用,它們擁有著復(fù)雜的JavaScript代碼和一大堆依賴包。為了簡化開發(fā)的復(fù)雜度,前端社區(qū)涌現(xiàn)出了很多好的實踐方法
模塊化,讓我們可以把復(fù)雜的程序細化為小的文件;
類似于TypeScript這種在JavaScript基礎(chǔ)上拓展的開發(fā)語言:使我們能夠?qū)崿F(xiàn)目前版本的JavaScript不能直接使用的特性,并且之后還能轉(zhuǎn)換為JavaScript文件使瀏覽器可以識別;
Scss,less等CSS預(yù)處理器
...
這些改進確實大大的提高了我們的開發(fā)效率,但是利用它們開發(fā)的文件往往需要進行額外的處理才能讓瀏覽器識別,而手動處理又是非常繁瑣的,這就為WebPack類的工具的出現(xiàn)提供了需求。
什么是Webpack
WebPack可以看做是模塊打包機:它做的事情是,分析你的項目結(jié)構(gòu),找到JavaScript模塊以及其它的一些瀏覽器不能直接運行的拓展語言(Scss,TypeScript等),并將其轉(zhuǎn)換和打包為合適的格式供瀏覽器使用。
WebPack和Grunt以及Gulp相比有什么特性
其實Webpack和另外兩個并沒有太多的可比性,Gulp/Grunt是一種能夠優(yōu)化前端的開發(fā)流程的工具,而WebPack是一種模塊化的解決方案,不過Webpack的優(yōu)點使得Webpack在很多場景下可以替代Gulp/Grunt類的工具。
Grunt和Gulp的工作方式是:在一個配置文件中,指明對某些文件進行類似編譯,組合,壓縮等任務(wù)的具體步驟,工具之后可以自動替你完成這些任務(wù)。
Grunt和Gulp的工作流程
Webpack的工作方式是:把你的項目當(dāng)做一個整體,通過一個給定的主文件(如:index.js),Webpack將從這個文件開始找到你的項目的所有依賴文件,使用loaders處理它們,最后打包為一個(或多個)瀏覽器可識別的JavaScript文件。
Webpack工作方式
如果實在要把二者進行比較,Webpack的處理速度更快更直接,能打包更多不同類型的文件。
開始使用Webpack
初步了解了Webpack工作方式后,我們一步步的開始學(xué)習(xí)使用Webpack。
安裝
Webpack可以使用npm安裝,新建一個空的練習(xí)文件夾(此處命名為webpack sample project),在終端中轉(zhuǎn)到該文件夾后執(zhí)行下述指令就可以完成安裝。
//全局安裝npm install -g webpack//安裝到你的項目目錄npm install --save-dev webpack
正式使用Webpack前的準備
在上述練習(xí)文件夾中創(chuàng)建一個package.json文件,這是一個標準的npm說明文件,里面蘊含了豐富的信息,包括當(dāng)前項目的依賴模塊,自定義的腳本任務(wù)等等。在終端中使用npm init命令可以自動創(chuàng)建這個package.json文件
npm init
輸入這個命令后,終端會問你一系列諸如項目名稱,項目描述,作者等信息,不過不用擔(dān)心,如果你不準備在npm中發(fā)布你的模塊,這些問題的答案都不重要,回車默認即可。
package.json文件已經(jīng)就緒,我們在本項目中安裝Webpack作為依賴包
// 安裝Webpacknpm 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文件夾中;
此時項目結(jié)構(gòu)如下圖所示
項目結(jié)構(gòu)
我們在index.html文件中寫入最基礎(chǔ)的html代碼,它在這里目的在于引入打包后的js文件(這里我們先把之后打包后的js文件命名為bundle.js,之后我們還會詳細講述)。
Webpack Sample Project
我們在Greeter.js中定義一個返回包含問候信息的html元素的函數(shù),并依據(jù)CommonJS規(guī)范導(dǎo)出這個函數(shù)為一個模塊:
// Greeter.jsmodule.exports =function(){vargreet =document.createElement('div');? greet.textContent ="Hi there and greetings!";returngreet;};
main.js文件中我們寫入下述代碼,用以把Greeter模塊返回的節(jié)點插入頁面。
//main.js constgreeter =require('./Greeter.js');document.querySelector("#root").appendChild(greeter());
正式使用Webpack
webpack可以在終端中使用,在基本的使用方法如下:
# {extry file}出填寫入口文件的路徑,本文中就是上述main.js的路徑,# {destination for bundled file}處填寫打包文件的存放路徑# 填寫路徑的時候不用添加{}webpack {entry file} {destinationforbundled file}
指定入口文件后,webpack將自動識別項目所依賴的其它文件,不過需要注意的是如果你的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打包了一個文件了。不過在終端中進行復(fù)雜的操作,其實是不太方便且容易出錯的,接下來看看Webpack的另一種更常見的使用方法。
通過配置文件來使用Webpack
Webpack擁有很多其它的比較高級的功能(比如說本文后面會介紹的loaders和plugins),這些功能其實都可以通過命令行模式實現(xiàn),但是正如前面提到的,這樣不太方便且容易出錯的,更好的辦法是定義一個配置文件,這個配置文件其實也是一個簡單的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í)行腳本所在的目錄。
有了這個配置之后,再打包文件,只需在終端里運行webpack(非全局安裝需使用node_modules/.bin/webpack)命令就可以了,這條命令會自動引用webpack.config.js文件中的配置選項,示例如下:
配合配置文件進行打包
又學(xué)會了一種使用Webpack的方法,這種方法不用管那煩人的命令行參數(shù),有沒有感覺很爽。如果我們可以連webpack(非全局安裝需使用node_modules/.bin/webpack)這條命令都可以不用,那種感覺會不會更爽~,繼續(xù)看下文。
更快捷的執(zhí)行打包任務(wù)
在命令行中輸入命令需要代碼類似于node_modules/.bin/webpack這樣的路徑其實是比較煩人的,不過值得慶幸的是npm可以引導(dǎo)任務(wù)執(zhí)行,對npm進行配置后可以在命令行中使用簡單的npm start命令來替代上面略微繁瑣的命令。在package.json中對scripts對象進行相關(guān)設(shè)置即可,設(shè)置方法如下。
{"name":"webpack-sample-project","version":"1.0.0","description":"Sample webpack project","scripts": {"start":"webpack"http:// 修改的是這里,JSON文件不支持注釋,引用時請清除? },"author":"zhang","license":"ISC","devDependencies": {"webpack":"3.10.0"}}
注:package.json中的script會安裝一定順序?qū)ふ颐顚?yīng)位置,本地的node_modules/.bin路徑就在這個尋找清單中,所以無論是全局還是局部安裝的Webpack,你都不需要寫前面那指明詳細的路徑了。
npm的start命令是一個特殊的腳本名稱,其特殊性表現(xiàn)在,在命令行中使用npm start就可以執(zhí)行其對于的命令,如果對應(yīng)的此腳本名稱不是start,想要在命令行中運行時,需要這樣用npm run {script name}如npm run build,我們在命令行中輸入npm start試試,輸出結(jié)果如下:
使用npm start 打包代碼
現(xiàn)在只需要使用npm start就可以打包文件了,有沒有覺得webpack也不過如此嘛,不過不要太小瞧webpack,要充分發(fā)揮其強大的功能我們需要修改配置文件的其它選項,一項項來看。
Webpack的強大功能
生成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,它有以下四種不同的配置選項,各具優(yōu)缺點,描述如下:
devtool選項配置結(jié)果
source-map在一個單獨的文件中產(chǎn)生一個完整且功能完全的文件。這個文件具有最好的source map,但是它會減慢打包速度;
cheap-module-source-map在一個單獨的文件中生成一個不帶列映射的map,不帶列映射提高了打包速度,但是也使得瀏覽器開發(fā)者工具只能對應(yīng)到具體的行,不能對應(yīng)到具體的列(符號),會對調(diào)試造成不便;
eval-source-map使用eval打包源文件模塊,在同一個文件中生成干凈的完整的source map。這個選項可以在不影響構(gòu)建速度的前提下生成完整的sourcemap,但是對打包后輸出的JS文件的執(zhí)行具有性能和安全的隱患。在開發(fā)階段這是一個非常好的選項,在生產(chǎn)階段則一定不要啟用這個選項;
cheap-module-eval-source-map這是在打包文件時最快的生成source map的方法,生成的Source Map會和打包后的JavaScript文件同行顯示,沒有列映射,和eval-source-map選項具有相似的缺點;
正如上表所述,上述選項由上到下打包速度越來越快,不過同時也具有越來越多的負面作用,較快的打包速度的后果就是對打包后的文件的的執(zhí)行有一定影響。
對小到中型的項目中,eval-source-map是一個很好的選項,再次強調(diào)你只應(yīng)該開發(fā)階段使用它,我們繼續(xù)對上文新建的webpack.config.js,進行如下配置:
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)試,推薦在大型項目考慮時間成本時使用。
使用webpack構(gòu)建本地服務(wù)器
想不想讓你的瀏覽器監(jiān)聽你的代碼的修改,并自動刷新顯示修改后的結(jié)果,其實Webpack提供一個可選的本地開發(fā)服務(wù)器,這個本地服務(wù)器基于node.js構(gòu)建,可以實現(xiàn)你想要的這些功能,不過它是一個單獨的組件,在webpack中進行配置之前需要單獨安裝它作為項目依賴
npm install --save-dev webpack-dev-server
devserver作為webpack配置選項中的一項,以下是它的一些配置選項,更多配置可參考這里
devserver的配置選項功能描述
contentBase默認webpack-dev-server會為根文件夾提供本地服務(wù)器,如果想為另外一個目錄下的文件提供本地服務(wù)器,應(yīng)該在這里設(shè)置其所在目錄(本例設(shè)置到“public"目錄)
port設(shè)置默認監(jiā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//實時刷新} }
在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)用外部的腳本或工具,實現(xiàn)對不同格式的文件的處理,比如說分析轉(zhuǎn)換scss為css,或者把下一代的JS文件(ES6,ES7)轉(zhuǎn)換為現(xiàn)代瀏覽器兼容的JS文件,對React的開發(fā)而言,合適的Loaders可以把React的中用到的JSX文件轉(zhuǎn)換為JS文件。
Loaders需要單獨安裝并且需要在webpack.config.js中的modules關(guān)鍵字下進行配置,Loaders的配置包括以下幾方面:
test:一個用以匹配loaders所處理文件的拓展名的正則表達式(必須)
loader:loader的名稱(必須)
include/exclude:手動添加必須處理的文件(文件夾)或屏蔽不需要處理的文件(文件夾)(可選);
query:為loaders提供額外的設(shè)置選項(可選)
不過在配置loader之前,我們把Greeter.js里的問候消息放在一個單獨的JSON文件里,并通過合適的配置使Greeter.js可以讀取該JSON文件的值,各文件修改后的代碼如下:
在app文件夾中創(chuàng)建帶有問候信息的JSON文件(命名為config.json)
{"greetText":"Hi there and greetings from JSON!"}
更新后的Greeter.js
varconfig =require('./config.json');module.exports =function(){vargreet =document.createElement('div');? greet.textContent = config.greetText;returngreet;};
注由于webpack3.*/webpack2.*已經(jīng)內(nèi)置可處理JSON文件,這里我們無需再添加webpack1.*需要的json-loader。在看如何具體使用loader之前我們先看看Babel是什么?
Babel
Babel其實是一個編譯JavaScript的平臺,它可以編譯代碼幫你達到以下目的:
讓你能使用最新的JavaScript代碼(ES6,ES7...),而不用管新標準是否被當(dāng)前使用的瀏覽器完全支持;
讓你能使用基于JavaScript進行了拓展的語言,比如React的JSX;
Babel的安裝與配置
Babel其實是幾個模塊化的包,其核心功能位于稱為babel-core的npm包中,webpack可以把其不同的包整合在一起使用,對于每一個你需要的功能或拓展,你都需要安裝單獨的包(用得最多的是解析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//實時刷新},module: {? ? ? ? rules: [? ? ? ? ? ? {? ? ? ? ? ? ? ? test: /(\.jsx|\.js)$/,? ? ? ? ? ? ? ? use: {? ? ? ? ? ? ? ? ? ? loader:"babel-loader",? ? ? ? ? ? ? ? ? ? options: {? ? ? ? ? ? ? ? ? ? ? ? presets: ["env","react"]? ? ? ? ? ? ? ? ? ? }? ? ? ? ? ? ? ? },? ? ? ? ? ? ? ? exclude: /node_modules/? ? ? ? ? ? }? ? ? ? ]? ? }};
現(xiàn)在你的webpack的配置已經(jīng)允許你使用ES6以及JSX的語法了。繼續(xù)用上面的例子進行測試,不過這次我們會使用React,記得先安裝 React 和 React-DOM
npm install --save react react-dom
接下來我們使用ES6的語法,更新Greeter.js并返回一個React組件
//Greeter,jsimportReact, {Component}from'react'importconfigfrom'./config.json';classGreeterextendsComponent{? render() {return(
修改main.js如下,使用ES6的模塊定義和渲染Greeter模塊
// main.jsimportReactfrom'react';import{render}from'react-dom';importGreeterfrom'./Greeter';render(, document.getElementById('root'));
重新使用npm start打包,如果之前打開的本地服務(wù)器沒有關(guān)閉,你應(yīng)該可以在localhost:8080下看到與之前一樣的內(nèi)容,這說明react和es6被正常打包了。
localhost:8080
Babel的配置
Babel其實可以完全在webpack.config.js中進行配置,但是考慮到babel具有非常多的配置選項,在單一的webpack.config.js文件中進行配置往往使得這個文件顯得太復(fù)雜,因此一些開發(fā)者支持把babel的配置選項放在一個單獨的名為 ".babelrc" 的配置文件中。我們現(xiàn)在的babel的配置并不算復(fù)雜,不過之后我們會再加一些東西,因此現(xiàn)在我們就提取出相關(guān)部分,分兩個配置文件進行配置(webpack會自動調(diào)用.babelrc里的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//實時刷新},module: {? ? ? ? rules: [? ? ? ? ? ? {? ? ? ? ? ? ? ? test: /(\.jsx|\.js)$/,? ? ? ? ? ? ? ? use: {? ? ? ? ? ? ? ? ? ? loader:"babel-loader"},? ? ? ? ? ? ? ? exclude: /node_modules/? ? ? ? ? ? }? ? ? ? ]? ? }};
//.babelrc{"presets": ["react","env"]}
到目前為止,我們已經(jīng)知道了,對于模塊,Webpack能提供非常強大的處理功能,那那些是模塊呢。
一切皆模塊
Webpack有一個不可不說的優(yōu)點,它把所有的文件都都當(dāng)做模塊處理,JavaScript代碼,CSS和fonts以及圖片等等通過合適的loader都可以被處理。
CSS
webpack提供兩個工具處理樣式表,css-loader和style-loader,二者處理的任務(wù)不同,css-loader使你能夠使用類似@import和url(...)的方法實現(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.jsimportReactfrom'react';import{render}from'react-dom';importGreeterfrom'./Greeter';import'./main.css';//使用require導(dǎo)入css文件render(, document.getElementById('root'));
通常情況下,css會和js打包到同一個文件中,并不會打包為一個單獨的css文件,不過通過合適的配置webpack也可以把css打包為單獨的文件的。
上面的代碼說明webpack是怎么把css當(dāng)做模塊看待的,咱們繼續(xù)看一個更加真實的css模塊實踐。
CSS module
在過去的一些年里,JavaScript通過一些新的語言特性,更好的工具以及更好的實踐方法(比如說模塊化)發(fā)展得非常迅速。模塊使得開發(fā)者把復(fù)雜的代碼轉(zhuǎn)化為小的,干凈的,依賴聲明明確的單元,配合優(yōu)化工具,依賴管理和加載管理可以自動完成。
不過前端的另外一部分,CSS發(fā)展就相對慢一些,大多的樣式表卻依舊巨大且充滿了全局類名,維護和修改都非常困難。
被稱為CSS modules的技術(shù)意在把JS的模塊化思想帶入CSS中來,通過CSS模塊,所有的類名,動畫名默認都只作用于當(dāng)前模塊。Webpack對CSS模塊化提供了非常好的支持,只需要在CSS loader中進行簡單配置即可,然后就可以直接把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 moduleslocalIdentName:'[name]__[local]--[hash:base64:5]'// 指定css的類名格式}? ? ? ? ? ? ? ? ? ? }? ? ? ? ? ? ? ? ]? ? ? ? ? ? }? ? ? ? ]? ? }};
我們在app文件夾下創(chuàng)建一個Greeter.css文件來進行一下測試
/* Greeter.css */.root{background-color:#eee;padding:10px;border:3pxsolid#ccc;}
導(dǎo)入.root到Greeter.js中
importReact, {Component}from'react';importconfigfrom'./config.json';importstylesfrom'./Greeter.css';//導(dǎo)入classGreeterextendsComponent{? render() {return(//使用cssModule添加類名的方法? ? ? ? {config.greetText});? }}exportdefaultGreeter
放心使用把,相同的類名也不會造成不同組件之間的污染。
應(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進行配置就可以使用了,以下是常用的CSS 處理loaders:
Less Loader
Sass Loader
Stylus Loader
不過其實也存在一個CSS的處理平臺-PostCSS,它可以幫助你的CSS實現(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.jsmodule.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.jsmodule.exports= {? ? plugins: [? ? ? ? require('autoprefixer')? ? ]}
至此,本文已經(jīng)談?wù)摿颂幚鞪S的Babel和處理CSS的PostCSS的基本用法,它們其實也是兩個單獨的平臺,配合webpack可以很好的發(fā)揮它們的作用。接下來介紹Webpack中另一個非常重要的功能-Plugins
插件(Plugins)
插件(Plugins)是用來拓展Webpack功能的,它們會在整個構(gòu)建過程中生效,執(zhí)行相關(guān)的任務(wù)。
Loaders和Plugins常常被弄混,但是他們其實是完全不同的東西,可以這么來說,loaders是在打包構(gòu)建過程中用來處理源文件的(JSX,Scss,Less..),一次處理一個,插件并不直接操作單個文件,它直接對整個構(gòu)建過程其作用。
Webpack有很多內(nèi)置插件,同時也有很多第三方插件,可以讓我們完成更加豐富的功能。
使用插件的方法
要使用某個插件,我們需要通過npm安裝它,然后要做的就是在webpack配置中的plugins關(guān)鍵字部分添加該插件的一個實例(plugins是一個數(shù)組)繼續(xù)上面的例子,我們添加了一個給打包后代碼添加版權(quán)聲明的插件。
constwebpack =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: [newwebpack.BannerPlugin('版權(quán)所有,翻版必究')? ? ],};
通過這個插件,打包后的JS文件顯示如下
版權(quán)所有,翻版必究
這就是webpack插件的基礎(chǔ)用法了,下面給大家推薦幾個常用的插件
HtmlWebpackPlugin
這個插件的作用是依據(jù)一個簡單的index.html模板,生成一個自動引用你打包后的JS文件的新index.html。這在每次生成的js文件名稱不同時非常有用(比如添加了hash值)。
安裝
npm install --save-dev html-webpack-plugin
這個插件自動完成了我們之前手動做的一些事情,在正式使用之前需要對一直以來的項目結(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中的模板源代碼如下:
Webpack Sample Project
3.更新webpack的配置文件,方法同上,新建一個build文件夾用來存放最終的輸出文件
constwebpack =require('webpack');constHtmlWebpackPlugin =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//實時刷新},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: [newwebpack.BannerPlugin('版權(quán)所有,翻版必究'),newHtmlWebpackPlugin({template: __dirname +"/app/index.tmpl.html"http://new 一個這個插件的實例,并傳入相關(guān)的參數(shù)})? ? ],};
再次執(zhí)行npm start你會發(fā)現(xiàn),build文件夾下面生成了bundle.js和index.html。
build文件夾
Hot Module Replacement
Hot Module Replacement(HMR)也是webpack里很有用的一個插件,它允許你在修改組件代碼后,自動刷新實時預(yù)覽修改后的效果。
在webpack中實現(xiàn)HMR也很簡單,只需要做兩項配置
在webpack配置文件中添加HMR插件;
在Webpack Dev Server中添加“hot”參數(shù);
不過配置完這些后,JS模塊其實還是不能自動熱加載的,還需要在你的JS模塊中執(zhí)行一個Webpack提供的API才能實現(xiàn)熱加載,雖然這個API不難使用,但是如果是React模塊,使用我們已經(jīng)熟悉的Babel可以更方便的實現(xiàn)功能熱加載。
整理下我們的思路,具體實現(xiàn)方法如下
Babel和webpack是獨立的工具
二者可以一起工作
二者都可以通過插件拓展功能
HMR是一個webpack插件,它讓你能瀏覽器中實時觀察模塊修改后的效果,但是如果你想讓它工作,需要對模塊進行額外的配額;
Babel有一個叫做react-transform-hrm的插件,可以在不對React模塊進行額外的配置的前提下讓HMR正常工作;
還是繼續(xù)上例來實際看看如何配置
constwebpack =require('webpack');constHtmlWebpackPlugin =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: [newwebpack.BannerPlugin('版權(quán)所有,翻版必究'),newHtmlWebpackPlugin({template: __dirname +"/app/index.tmpl.html"http://new 一個這個插件的實例,并傳入相關(guān)的參數(shù)}),newwebpack.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)品階段,可能還需要對打包的文件進行額外的處理,比如說優(yōu)化,壓縮,緩存以及分離CSS和JS。
對于復(fù)雜的項目來說,需要復(fù)雜的配置,這時候分解配置文件為多個小的文件可以使得事情井井有條,以上面的例子來說,我們創(chuàng)建一個webpack.production.config.js的文件,在里面加上基本的配置,它和原始的webpack.config.js很像,如下
// webpack.production.config.jsconstwebpack =require('webpack');constHtmlWebpackPlugin =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: [newwebpack.BannerPlugin('版權(quán)所有,翻版必究'),newHtmlWebpackPlugin({template: __dirname +"/app/index.tmpl.html"http://new 一個這個插件的實例,并傳入相關(guān)的參數(shù)}),newwebpack.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.jsconstwebpack =require('webpack');constHtmlWebpackPlugin =require('html-webpack-plugin');constExtractTextPlugin =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: [newwebpack.BannerPlugin('版權(quán)所有,翻版必究'),newHtmlWebpackPlugin({template: __dirname +"/app/index.tmpl.html"}),newwebpack.optimize.OccurrenceOrderPlugin(),newwebpack.optimize.UglifyJsPlugin(),newExtractTextPlugin("style.css")? ? ],};
此時執(zhí)行npm run build可以看見代碼是被壓縮后的
壓縮后的代碼
緩存
緩存無處不在,使用緩存的最好方法是保證你的文件名和文件內(nèi)容是匹配的(內(nèi)容改變,名稱相應(yīng)改變)
webpack可以把一個哈希值添加到打包的文件名中,使用方法如下,添加特殊的字符串混合體([name], [id] and [hash])到輸出文件名前
constwebpack =require('webpack');constHtmlWebpackPlugin =require('html-webpack-plugin');constExtractTextPlugin =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)配置即可:
constCleanWebpackPlugin =require("clean-webpack-plugin");? plugins: [? ? ...// 這里是之前配置的其它各種插件newCleanWebpackPlugin('build/*.*', {root: __dirname,verbose:true,dry:false})? ]
關(guān)于clean-webpack-plugin的詳細使用可參考這里
總結(jié)
其實這是一年前的文章了,趁周末重新運行和修改了一下,現(xiàn)在所有的代碼都可以正常運行,所用webpack基于最新的webpack3.5.3。希望依舊能對你有幫助。
這是一篇好長的文章,謝謝你的耐心,能仔細看到了這里,大概半個月前我第一次自己一步步配置項目所需的Webpack后就一直想寫一篇筆記做總結(jié),幾次動筆都不能讓自己滿意,總覺得寫不清楚。其實關(guān)于Webpack本文講述得仍不完全,不過相信你看完后已經(jīng)進入Webpack的大門,能夠更好的探索其它的關(guān)于Webpack的知識了。
歡迎大家在文后發(fā)表自己的觀點討論。
更新說明
2017-12-11更新,修改css module部分代碼及示例圖片,css module真的非常好用,希望大家都能用上。
2017年9月18日更新,添加了一個使用webpack配置多頁應(yīng)用的demo,可以點擊此處查看
2017年8月13日更新,本文依據(jù)webpack3.5.3將文章涉及代碼完全重寫,所有代碼都在Mac上正常運行過。希望依舊對你學(xué)習(xí)webpack有幫助。
2017年8月16號更新:
最近在Gitchat上將發(fā)起了一場關(guān)于webpack的分享,目的在于一起花最短的時間理解和學(xué)會webpack,感興趣的童鞋可以微信掃描注冊哈。
作者:zhangwang
鏈接:http://www.lxweimin.com/p/42e11515c10f
來源:簡書
簡書著作權(quán)歸作者所有,任何形式的轉(zhuǎn)載都請聯(lián)系作者獲得授權(quán)并注明出處。