詳解webpack與SPA實踐之開發(fā)環(huán)境搭建
目前,公司前端項目開發(fā)技術棧基本改造為使用gulp進行自動化構建,webpack進行項目模塊化依賴管理,Vue+ Vuex + Vue-Router作為項目組件化開發(fā)框架,為了更深入的理解、使用當前技術棧并與讀者分享、交流,計劃推出一系列相關學習與實踐文章。本篇為開篇,主要講述如何使用webpack搭建開發(fā)環(huán)境。
項目初始化
以你喜歡的任意方式,創(chuàng)建項目根目錄,如:
mkdir vue-hello
初始化包模塊管理文件
進入項目根目錄,初始化項目包模塊管理文件package.json:
npm init
命令臺會提示你輸入一堆信息,如果你想簡單一點,可以添加-y參數(shù),跳過輸入步驟,生成默認信息:
npm init -y

初始化源碼目錄
在項目根目錄下創(chuàng)建源碼目錄結構,通常源碼目錄是src或app,個人喜好是使用src:

webpack簡述及使用
雖然在本篇文章我們不會對webpack做太過詳細的介紹,但是依然希望能幫助讀者對webpack擁有更清晰的了解,webpack是什么?
webpack is a tool to build JavaScript modules in your application
webpack是一個幫助你的應用構建JavaScript模塊的工具。
接下來,我們介紹幾個知識點幫助理解webpack:模塊化,webpack原理及其與grunt和gulp的比較。
模塊化
模塊化 指解決一個復雜問題時自頂向下逐層把系統(tǒng)劃分成若干模塊的過程。
模塊是一個可組合、分解和更換的單元,將一個系統(tǒng)分解成若干模塊,單元;大家遵循一定的規(guī)范,各司其職,各自開發(fā)不同模塊;之后可以較低成本的將模塊組合起來,構成一個完整的系統(tǒng),極大方便了團隊成員之間的協(xié)助開發(fā),產(chǎn)出效率得到有效提升。
WEBPACK原理
webpack是一個幫助你的應用構建JavaScript模塊的工具,其本質(zhì)只能處理JavaScript,那你會疑惑了,不是說使用webpack,可以很方便的在JavaScript代碼中引用圖片,CSS等資源嘛?是的,這正是webpack的優(yōu)勢,那怎么實現(xiàn)的呢?這就要涉及到webpack中的一個概念:加載器(loader)。
加載器 是作用于應用資源文件的轉(zhuǎn)換器,它們是一系列JavaScript函數(shù),接受資源文件的內(nèi)容做參數(shù),然后返回新的資源(以一個JavaScript模塊的形式返回)。
所以,對于webpack,我們明確三點:
- 模塊:webpack中一切資源文件(JavaScript, 樣式, 圖片資源等)皆視為模塊;
- 加載器:webpack通過加載器(JavaScript函數(shù))將其他資源處理(構建)成JavaScript模塊;
- 管理依賴:webpack在編譯模塊時,就能分析查找該模塊內(nèi)的依賴,可以很好的處理不同模塊間的依賴;
WEBPACK對比GRUNT/GULP
grunt
打開grunt官網(wǎng),你可以看到最醒目的介紹:The JavaScript Task Runner,還有一個關鍵字automation – 自動化,其定位是一個JavaScript的自動化構建任務處理器,幫助開發(fā)者自動化處理項目的構建流程;
gulp
gulp官網(wǎng)的定義是:Automate and enhance your workflow,自動強化項目構建流程,其與grunt的目標一致,都是幫助開發(fā)者自動化處理項目的構建流程,不同的是gulp實現(xiàn)方式是基于流的,即以流的方式處理文件,而grunt是以二進制方式處理文件,gulp使用性能是要強于grunt的;
總結
- webpack定位是一個模塊化管理工具,而grunt/gulp都是自動化任務流程構建工具;
- grunt基于二進制處理文件,gulp基于流式處理文件,效率比grunt更高一些;
- webpack強大特性,使得其添加諸多插件可以替代grunt/gulp,但是目前的實踐項目中,通常webpack結合gulp或grunt使用(各自處理各自專長的任務);
安裝
首先安裝webpack,npm或yarn都可以,無甚區(qū)別:
npm install --save-dev webpack
關于此處的--save和-dev參數(shù)做簡要說明:
- --save是聲明將安裝依賴添加入package.json文件;
- 默認地,使用npm安裝包模塊依賴時,依賴關系存儲在在"dependencies"屬性對象內(nèi),表示項目依賴;
- webpack是作為開發(fā)環(huán)境依賴的,不是作為源碼直接調(diào)用,所以添加-dev參數(shù),以聲明其是開發(fā)環(huán)境依賴;
webpack配置介紹
實踐項目使用webpack完成自動化構建,本地服務調(diào)試與熱加載,首先在根目錄下創(chuàng)建webpack的配置入口文件webpack.config.js,基本內(nèi)容結構如下:
var path = require('path');
module.exports = {
context: path.resolve(__dirname, 'src/'),
entry: {
app: './scripts/app.js'
},
output: {
filename: '[name].js',
path: path.resolve(__dirname, 'dist/scripts/')
},
module: {
loaders: []
},
resolve: {
modules:[],
alias: {},
extensions: []
},
plugins: [],
devServer: {}
};
如上,webpack配置文件使用module.exports方式導出配置對象,webpack執(zhí)行時會默認讀取項目根目錄下webpack.config.js文件,當然可以手動配置指定一個文件作為配置文件,我們不討論,可以參考webpack文檔,接下來對webpack配置內(nèi)容做簡要介紹,如果你對webpack使用比較熟悉,可以跳過此節(jié)。
文件處理配置
和webpack文件處理相關的幾個配置屬性主要有三個:目錄上下文信息(context), 處理文件入口信息(entry), 文件輸出信息(output)。
目錄上下文信息(context)
設置解析處理文件入口的相對目錄,值為一個絕對目錄路徑,默認為當前執(zhí)行目錄,通常即項目根目錄,在Node中其值與process.cwd()相同,如:
context: path.resolve(__dirname, 'src/'),
如上即解析為項目根目錄下的src目錄。
處理文件入口信息(entry)
處理文件入口,值可以是字符串,或數(shù)組,或?qū)ο?,值為字符串或?shù)組時,即輸出單文件,值為對象,可以輸出多文件,輸出文件名稱等信息參考文件輸出信息(output)。
文件輸出信息(output)
此配置聲明webpack編譯輸出文件的文件名等信息,如:
filename: '[name].js',
聲明文件名就是模塊(chunk)名,對應在entry中定義的入口,你可能還見過[id],[hash],[chunkhash]這些用法,現(xiàn)做簡單介紹:
- [id]:該值表示webpack編譯模塊(chunk)的id,通常是一個數(shù)字;
- [name]:該值表示webpack編譯模塊(chunk)名,對應entry中定義的入口名或文件名;
- [chunkhash]:該值表示webpack編譯模塊(chunk)hash值,根據(jù)模塊內(nèi)容計算出的一個md5值;
- [hash]:該值表示webapck編譯對象hash值,根據(jù)編譯對象計算出的md5值;
編譯對象,即webpack執(zhí)行時讀取配置后生成的一個編譯配置對象,包含模塊,待編譯文件,相對于上次編譯的變更文件等諸多信息,需要注意的是該對象在webpack啟動讀取配置文件后形成,在此次編譯過程保持不變。
- output.path:定義輸出文件所在目錄;
- output.publicPath:定義輸出文件在瀏覽器訪問時的基礎相對路徑,可以與后文webpack-dev-server一起使用。
webpack加載器與模塊
在介紹加載器配置之前,先看看加載器是什么:
Loaders are transformations that are applied on a resource file of your app. They are functions (running in node.js) that take the source of a resource file as the parameter and return the new source.
加載器是作用于應用資源文件的轉(zhuǎn)換器,它們是一系列函數(shù),接受資源文件的內(nèi)容做參數(shù),然后返回新的資源(以一個模塊的形式返回)。
webpack
webpack解析文件時使用的加載器都聲明在module屬性的loaders數(shù)組中,可以設置一個或多個加載器。
module.noParse:指定某些文件不需要使用解析,支持傳入文件路徑或正則表達式;
module.loaders:指定解析文件的加載器模塊及各模塊解析規(guī)則,可以設置以下屬性:
- test: 待解析文件需匹配的規(guī)則,通常以文件后綴名稱匹配文件;
- include:待解析文件所處目錄;
- exclude: 過濾掉的目錄;
- loader:加載器模塊名稱;
- loaders多個加載器;
模塊解析規(guī)則配置
webpack支持在resolve屬性對象中配置模塊解析規(guī)則,主要有root,modules, alias和extensions屬性。
resolve.root與resolve.modules
該屬性設置的是在開發(fā)代碼中使用require或import加載某模塊時,webpack查找該模塊所遵循的查找目錄范圍,如在源代碼中存在:
var utils = require('utils/utils.js');
而root配置如下:
resolve: {
root: [
path.resolve('./src/'),
'node_modules'
]
}
webpack編譯時將自動在項目根目錄下的src目錄內(nèi)的utils目錄下查找utils.js,若存在,則返回,否則進入node_modules目錄內(nèi)查找utils.js模塊。
當然,若未設置resolve.root屬性值,則webpack默認先從node_modules查找模塊,然后在根目錄下查找。
注意:resolve.root在webpack v1版本中使用,而在webpack v2 中,使用modules代替,建議使用v2版本,后文也將統(tǒng)一使用modules屬性。
resolve.alias
alias,有別名的意思,這里的作用是設置其他模塊或路徑的別名,webpack在解析模塊時,將使用配置值替換該別名,如,在未設置alias屬性內(nèi)容時,即resolve.alias默認是空對象{}時,我們在代碼中引用模塊:
var Vue = require('vue/dist/vue.js');
var TopHeader = require('components/header.js');
webpack在編譯代碼時,按resolve.modules聲明的順序依次查找對應模塊,如按照上一節(jié)定義的resolve.modules:
resolve: {
root: [
path.resolve('./src/'),
'node_modules'
]
}
查找模塊時,將首先在src/vue/dist/目錄下尋找vue模塊,在src/components/目錄下查找header.js模塊,查找到后返回,否則進入node_modules目錄查找。
現(xiàn)在,我們還可以通過resolve.alias為模塊或路徑聲明一個別名,更方便的聲明加載模塊:
resolve: {
alias: {
'vue$': 'vue/dist/vue.js'
components: path.resolve(__dirname, 'src/components/')
}
}
我可以使用如下方式加載模塊:
var Vue = require('vue');
var TopHeader = require('components/header.js');
$符號
關于alias的詳細使用介紹,請參見文檔,本文并不是要介紹webpack文檔,在這里介紹一下聲明的vue$別名中的$符號:
這里的$符合是正則的文末匹配符,即只有當vue是最后一級路徑時,webpack才會將該值解析成別名,進行別名與對應值替換,如vue/test.js中的vue是不會當作別名解析的,而components/header.js中的components則會按照聲明的components別名進行解析,其結果是src/components/header.js。
resolve.extensions
該值定義解析模塊時的查找文件的后綴順序,如["", ".js", ".json"],會優(yōu)先返回js文件,其次json文件,然后是其他文件,注意,這里數(shù)組傳入了一個空字符串,他的作用是在未找到配置中所有列舉的類型文件時,支持webpack返回其他類型文件,但是webpack2.x版本修改了,不支持傳入空字符。
webpack插件配置
webpack還支持多種多樣的插件拓展,你可以使用它們對你的項目webpack模塊構建過程進行額外處理,如代碼壓縮,圖片等資源提交壓縮,構建異常捕獲和提升,構建流程時間消耗比,等等,而關于這些插件使用的配置在plugins屬性數(shù)組內(nèi),將在后續(xù)進行介紹。
項目本地調(diào)試與開發(fā)
為了方便開發(fā)和調(diào)試,通常都需要在本地主機開啟服務,提供局域網(wǎng)內(nèi)多終端訪問,并且在文件變更時,實時刷新頁面,正如grunt和gulp中Browsersync插件提供的功能一樣,webpack可以使用webpack-dev-server模塊實現(xiàn)。
webpack-dev-server是一個Node.js的express服務器,以webpack開發(fā)中間件的形式為webpack包提供服務,當監(jiān)聽到源碼文件變更時,會自動重新打包,并且支持配置自動刷新瀏覽器,重新加載資源。
安裝
由于該插件只用于開發(fā)模式,所以通過以下npm指令安裝:
npm install webpack-dev-server --save-dev
配置
啟用webpack-dev-server時,其默認開啟8080端口,訪問localhost:8080返回當前目錄下的index.html,即執(zhí)行指令當前目錄下的靜態(tài)資源,當然可以通過指令傳遞參數(shù)或在配置文件進行配置指定靜態(tài)資源目錄。
另外需要注意的是,開啟webpack-dev-server后,變更文件重新打包后,并不會實際輸出到配置的output目錄,而是在publicPath屬性聲明的相對路徑所在的內(nèi)存中讀取。
靜態(tài)資源目錄配置(CONTENT BASE)
webpack-dev-server --content-base src/
執(zhí)行以上指令開啟服務后,webpack-dev-server將默認在src/目錄返回靜態(tài)資源,當然也可以在webpack.config.js配置文件中指定:
devServer: {
contentBase: './src'
}
訪問http://localhost:8080和http://localhost:8080/index.html效果一樣,均返回src目錄下的index.html文件。
PUBLICPATH與輸出文件訪問
在前文webpack配置一節(jié)中提到output.publicPath屬性值表示,在瀏覽器訪問webpack output輸出的文件時的基礎相對路徑,如設置:
output: {
path: 'dist/scripts',
filename: 'app.js',
publicPath: 'assets/'
}
則在html文件中引用該app.js文件的方式如下:
<script src="assets/app.js"></script>
在瀏覽器中訪問app.js的方式為:http://localhost:8080/assets/app.js
自動刷新(AUTOMATIC REFRESH)
前面說到webpack-dev-server支持文件變更時,自動刷新瀏覽器,這也是開發(fā)者急需的功能,webpack-dev-server支持兩種方式實現(xiàn):
- iframe模式(iframe mode):頁面通過iframe窗口插入然后變更時自動重新加載;
- inline模式(inline mode):通過sock.js(比如websocket協(xié)議,輪詢等方式)在頁面嵌入一個小型客戶端與webpack-dev-server服務器建立連接,當發(fā)生變更重新打包時,通過此連接通知頁面重新加載;
iframe模式
使用默認的iframe模式時,不需要進行任何配置,可以直接訪問:http://localhost:8080/webpack-dev-server/index.html即可,如圖,通過iframe插入我們的頁面:

注意:
- 在應用頁面上方會有狀態(tài)欄顯示當前應用信息;
- 應用URL的變更發(fā)生在iframe內(nèi)部,不會反映在瀏覽器地址欄;
inline模式
要開啟inline模式,只需要指定--inline命令行參數(shù)或在配置文件中指定inline: true:
devServer: {
contentBase: './src',
inline: true
}
在此模式下,直接訪問http://localhost:8080/index.html或http://localhost:8080即可,此模式與iframe模式的區(qū)別在于:
- 訪問URL不同;
- 需指定inline配置參數(shù);
- 應用信息在控制臺輸出;
- 應用URL的變更直接反映在瀏覽器地址欄;
其實inline模式還可以配合Node.Js服務運行,之后再介紹,這里只說明了其在HTML文檔中的使用。
熱替換(HOT MODULE REPLACEMENT)
除了自動刷新,webpack-dev-server的另一大賣點是模塊熱替換,那么熱替換到底是什么?
熱替換,即文件發(fā)生變更時,webpack包只替換發(fā)生變更的模塊,而不需要全部替換;瀏覽器不需要完全重新加載,而可以直接將變更的模塊注入到運行中的應用。
開啟熱替換功能需要指定--hot指令參數(shù),或在配置文件中添加:
devServer: {
contentBase: './src',
inline: true,
hot: true
}
注意到以上代碼,熱替換需要與inline模式一起使用,另外需要指定output.publicPath值。
HotModuleReplacementPlugin
配置好后還需要使用webpack.HotModuleReplacementPlugin插件,才能真正啟用熱替換功能:
plugins: [
new webpack.HotModuleReplacementPlugin()
]
同樣的,熱替換可以搭配Node.js服務一起使用,之后介紹。
如圖,為每個文件(app.js, test.js)都實現(xiàn)了HMR熱替換,當發(fā)生變更時,只更新變更模塊,而不是重新加載所有文件:

擁抱ES6
ES6推出以來,廣受Jser們青睞,其確實有很多新特性和新規(guī)范,值得我們深入學習并使用,未來所有的JavaScript應用都應該擁抱ES6,不過,目前各大瀏覽器都在推進ES6的實現(xiàn),在兼容實現(xiàn)之前,我們還需要過渡性的將其轉(zhuǎn)換成ES5語法,最通用的方式就是使用babel轉(zhuǎn)換。
使用BABEL加載器
首先,為了能使用webpack和babel轉(zhuǎn)換js代碼,需要使用babel-loader加載器,另外還需要安裝babel轉(zhuǎn)換js的轉(zhuǎn)換規(guī)則插件,如babel-preset-es2015定義了轉(zhuǎn)換規(guī)則,安裝方式如下:
npm install --save-dev babel-loader babel-preset-es2015
然后在根目錄下創(chuàng)建.babelrc文件,內(nèi)容:
{
"presets": ["es2015"]
}
在webpack.config.js配置文件中,添加相關loader配置:
module: {
loaders: [
{
test: /\.(js|vue)$/,
exclude: /node_modules/,
loader: 'babel-loader'
}
]
}
其中,test匹配需要轉(zhuǎn)換的文件,exclude匹配不需要轉(zhuǎn)換的文件或目錄。
BABEL-POLYFILL
我們需要明白的一點是babel-preset-es2015能做的,只是轉(zhuǎn)換ES6代碼成ES5,使得瀏覽器可以解析執(zhí)行,但是對于ES6新提出的API,如Promise,Generator等無法簡單的轉(zhuǎn)換成ES5代碼,這時就需要babel-polyfill了,babel-polyfill是一個墊片,它可以模擬提供所有的ES6功能和特性,可以看作是提供了一個模擬的全局ES6環(huán)境。
安裝
安裝依然很簡單,由于是墊片,是需要在源碼中使用的,所有指定--save參數(shù):
npm install --save babel-polyfill
使用
不同于babel-preset-es2015,babel-polyfill需要直接打包進源碼,而且需要在使用ES6代碼前引入一次:
import 'babel-polyfill'
只需要引入一次,因為該墊片提供的是一個模擬的全局ES6環(huán)境,而不是模塊內(nèi)部的。
或者直接在webpack.config.js中配置打包入口文件時加入該墊片:
entry: {
app: ['babel-polyfill', './scripts/app.js']
},
現(xiàn)在你可以在你的代碼中使用任何你想用的ES6 API了。
到此,基本介紹了如何使用webpack搭建開發(fā)環(huán)境,下一篇將開始介紹如何使用webpack處理CSS及如何使用Vue進行組件化開發(fā)。
以上就是本文的全部內(nèi)容,希望對大家的學習有所幫助,也希望大家多多支持腳本之家。
- windows下vue-cli及webpack搭建安裝環(huán)境
- vue+node+webpack環(huán)境搭建教程
- 詳解webpack+angular2開發(fā)環(huán)境搭建
- 詳解基于webpack搭建react運行環(huán)境
- webpack入門+react環(huán)境配置
- karma+webpack搭建vue單元測試環(huán)境的方法示例
- webpack 2.x配置reactjs基本開發(fā)環(huán)境詳解
- 淺談Webpack下多環(huán)境配置的思路
- 詳解webpack4多入口、多頁面項目構建案例
- 如何用webpack4帶你實現(xiàn)一個vue的打包的項目
- webpack4.x開發(fā)環(huán)境配置詳解
相關文章
JavaScript中異步與回調(diào)的基本概念及回調(diào)地獄現(xiàn)象
這篇文章主要介紹了JavaScript中異步與回調(diào)的基本概念,以及回調(diào)地獄現(xiàn)象,本文主要介紹了異步和回調(diào)的基本概念,二者是JavaScript的核心內(nèi)容,需要所有熱愛JS的小伙伴深入了解,需要的朋友可以參考下2022-07-07
JavaScript 通過Ajax 動態(tài)加載CheckBox復選框
本文通過實例代碼給大家介紹了JavaScript 通過Ajax 動態(tài)加載CheckBox復選框的方法,需要的朋友參考下吧2017-08-08

