本文系統(tǒng)講解vue-cli腳手架build目錄中的dev-server.js配置文件
1.這個配置文件是命令npm run dev 和 npm run start 的入口配置文件,主要用于開發(fā)環(huán)境
2.由于這是一個系統(tǒng)的配置文件,將涉及很多的模塊和插件,所以這部分內(nèi)容我將分多個文章講解,請關(guān)注我博客的其他文章
3.關(guān)于注釋 •當(dāng)涉及到較復(fù)雜的解釋我將通過標(biāo)識的方式(如(1))將解釋寫到單獨(dú)的注釋模塊,請自行查看
4.上代碼
// 導(dǎo)入check-versions.js文件,并且執(zhí)行導(dǎo)入的函數(shù),用來確定當(dāng)前環(huán)境node和npm版本是否符合要求// 關(guān)于check-versions請查看我博客check-versions的相關(guān)文章require('./check-versions')()// 導(dǎo)入config目錄下的index.js配置文件,此配置文件中定義了生產(chǎn)和開發(fā)環(huán)境中所要用到的一些參數(shù)// 關(guān)于index.js的文件解釋請看我博客的index.js的相關(guān)文章var config = require('../config')// 下面表示如果如果沒有定義全局變量NODE_ENV,則將NODE_ENV設(shè)置為"development"if (!process.env.NODE_ENV) { process.env.NODE_ENV = JSON.parse(config.dev.env.NODE_ENV)}// opn插件是用來打開特定終端的,此文件用來在默認(rèn)瀏覽器中打開鏈接 opn(url)var opn = require('opn')// nodejs路徑模塊var path = require('path')// nodejs開發(fā)框架express,用來簡化操作,有興趣可以自行去了解var express = require('express')// 引入webpack模塊,用來使用webpack內(nèi)置插件var webpack = require('webpack')// 引入http-proxy-middleware插件,此插件是用來代理請求的只能用于開發(fā)環(huán)境,目的主要是解決跨域請求后臺apivar proxyMiddleware = require('http-proxy-middleware')// 下面的意思是指,如果不是testing環(huán)境就引入webpack.dev.conf.js配置文件// 關(guān)于webpack.dev.conf.js配置文件請關(guān)注我的相關(guān)文章,建議現(xiàn)在就去看,否則后面看著吃力var webpackConfig = process.env.NODE_ENV === 'testing' ? require('./webpack.prod.conf') : require('./webpack.dev.conf')// default port where dev server listens for incoming traffic// 下面是webpack-dev-server 監(jiān)聽的端口號,因?yàn)闆]有設(shè)置process.env.PORT,所以下面監(jiān)聽的就是config.dev.port即8080var port = process.env.PORT || config.dev.port // automatically open browser, if not set will be false// 下面是true,至于為啥,本來就是true還要加!!兩個感嘆號,估計(jì)是vue作者裝了個逼吧var autoOpenBrowser = !!config.dev.autoOpenBrowser // Define HTTP proxies to your custom API backend // https://github.com/chimurai/http-proxy-middleware// 下面是解決開發(fā)環(huán)境跨域問題的插件,我在config目錄index.js文章中有介紹,自行查看var proxyTable = config.dev.proxyTable// 下面是創(chuàng)建node.js的express開發(fā)框架的實(shí)例,別問我為什么這樣,自己看node.js去吧var app = express()// 把配置參數(shù)傳遞到webpack方法中,返回一個編譯對象,這個編譯對象上面有很多屬性,自己去看吧,主要是用到里面的狀態(tài)函數(shù) 如compilation,compile,after-emit這類的var compiler = webpack(webpackConfig)// 下面是webpack-dev-middleware和webpack-hot-middleware兩兄弟,這兩個是黃金組合// 而vue作者用這兩個插件也是用的最基本的形式,詳情看(1) (2)var devMiddleware = require('webpack-dev-middleware')(compiler, { publicPath: webpackConfig.output.publicPath, quiet: true // 使用friendly-errors-webpack-plugin插件這個必須設(shè)置為true,具體看我的wepback-dev-config.js})var hotMiddleware = require('webpack-hot-middleware')(compiler, { log: () => {} // 使用friendly-errors-webpack-plugin插件這個必須設(shè)置為true,具體看我的wepback-dev-config.js }) // force page reload when html-webpack-plugin template changescompiler.plugin('compilation', function(compilation) { // webpack任何一個插件都plugin這個方法,里面可以傳遞鉤子函數(shù),用來在插件各個階段做特殊處理,鉤子函數(shù)種類很多 compilation.plugin('html-webpack-plugin-after-emit', function(data, cb) { // 當(dāng)插件html-webpack-plugin產(chǎn)出完成之后,強(qiáng)制刷新瀏覽器 hotMiddleware.publish({ action: 'reload' }) cb() })})// proxy api requestsObject.keys(proxyTable).forEach(function(context) { // 下面是代理表的處理方法,看看就行了,幾乎用不上,除非你是全棧,不用webpack-dev-server,使用后臺語言做服務(wù)器 var options = proxyTable[context] if (typeof options === 'string') { options = { target: options } } app.use(proxyMiddleware(options.filter || context, options))})// handle fallback for HTML5 history API// 這個插件是用來解決單頁面應(yīng)用,點(diǎn)擊刷新按鈕和通過其他search值定位頁面的404錯誤// 詳情請看(3)app.use(require('connect-history-api-fallback')())// serve webpack bundle output// app.use是在響應(yīng)請求之前執(zhí)行的,用來指定靜態(tài)路徑,掛載靜態(tài)資源app.use(devMiddleware)// enable hot-reload and state-preserving// compilation error displayapp.use(hotMiddleware)// serve pure static assets// 下面的staticPath是 static ,path.posix.join其他配置文件中我已經(jīng)介紹了,這里不再贅述var staticPath = path.posix.join(config.dev.assetsPublicPath, config.dev.assetsSubDirectory)// 掛載靜態(tài)資源,下面的方法是用虛擬目錄來訪問資源,staticPath就是虛擬目錄路徑,其實(shí)不管設(shè)不設(shè)置都是staticapp.use(staticPath, express.static('./static'))// 下面結(jié)果就是 'http://localhost:8080'var uri = 'http://localhost:' + port// 下面是es6的promise規(guī)范,用來處理嵌套請求的var _resolvevar readyPromise = new Promise(resolve => { _resolve = resolve // resolve是一個回調(diào)函數(shù)專門用來傳遞成功請求的數(shù)據(jù)})// 下面是加載動畫console.log('> Starting dev server...')// waitUntilValid是webpack-dev-middleware實(shí)例的方法,在編譯成功之后調(diào)用devMiddleware.waitUntilValid(() => { console.log('> Listening at ' + uri + '/n') // when env is testing, don't need open it // 測試環(huán)境不打開瀏覽器 if (autoOpenBrowser && process.env.NODE_ENV !== 'testing') { opn(uri) } _resolve() // 這里沒有傳遞數(shù)據(jù),這只是在模擬})// node.js監(jiān)聽端口var server = app.listen(port)// 這個導(dǎo)出對象是用來對外提供操作服務(wù)器和接受數(shù)據(jù)的接口,vue作者可謂考慮頗深啊module.exports = { ready: readyPromise, // promise實(shí)例,可以通過readyPromise.then收到數(shù)據(jù) close: () => { server.close() // 關(guān)閉服務(wù)器 }}解釋
(1)webpack-dev-middleware插件
這個插件只能用于開發(fā)環(huán)境,下面是這個插件的解釋
這是一個簡潔的webpack包裝中間件,這個插件做這個主要為文件做一件事情,就是當(dāng)文件修改后提交到webpack服務(wù)器,然后處理這些修改后的文件
這個插件有一下幾個優(yōu)點(diǎn)
第一,所有的文件都是寫在disk上,文件的處理在內(nèi)存中進(jìn)行
第二,如果文件在watch模式下被改動,這個中間件將不會為這些老的bundle服務(wù)了,如果這些老的bundle上有文件改動, 這個中間件將不會發(fā)送請求,而是等到當(dāng)前編譯結(jié)束,當(dāng)前最新的文件有改動,才會發(fā)送請求,所以你不需要手動刷新了
第三,我會在以后的版本中優(yōu)化
總結(jié),這個中間件是webpack-dev-server的核心,實(shí)現(xiàn)修改文件,webapack自動刷新的功能
安裝 npm install webpack-deb-middleware --save-dev
使用方法如下,下面的使用方法也是webpack-dev-server實(shí)現(xiàn)的代碼
var webpackMiddleware = require("webpack-deb-middleware");app.use(webpackMiddleware(webpack({obj1}),{obj2}))app.use是express的方法,用來設(shè)置靜態(tài)路徑
上面的obj1是webpack配置對象,使用webpack方法轉(zhuǎn)換成compiler編譯對象,obj2配置的是更新文件打包后的配置,使用
webpackMiddleware處理之后,就返回一個靜態(tài)路徑,方便獲取文件關(guān)于obj2的配置項(xiàng),可以自行查閱,必須要添加publicPath
說到這里,我就不賣關(guān)子了,簡言之我們的靜態(tài)服務(wù)器是node.js,現(xiàn)在文件修改了,webpack-dev-middleware將修改的文件編譯后,告訴nodejs服務(wù)器哪些文件修改了并且把最新的文件上傳到靜態(tài)服務(wù)器,夠清楚了吧
(2)webpack-hot-middleware插件
這個插件是用來將webpack-dev-middleware編譯更新后的文件通知瀏覽器,并且告訴瀏覽器如何更新文件,從而實(shí)現(xiàn) Webpack hot reloading
將這兩個插件配合起來使用你就可以不需要webpack-dev-sever,即可以自己實(shí)現(xiàn)hot-replacement熱替換功能,webpack-hot-middleware插件通知瀏覽器更新文件大致是通過一個json對象實(shí)現(xiàn)的,具體實(shí)現(xiàn)機(jī)制這里不多說了,下面來看具體用法
安裝 npm install webpack-hot-middleware --save-dev
在使用了webpack-dev-middleware之后,在添加如下代碼即可
app.use(require("webpack-hot-middleware")(compiler));(3)connect-history-api-fallback插件
因?yàn)樵陂_發(fā)單頁面應(yīng)用時,總的來說項(xiàng)目就一個頁面,如果通過點(diǎn)擊刷新按鈕并且此時鏈接指的不是主頁的地址,就會404;或者我通過其他的鏈接比如 /login.html 但是并沒有l(wèi)ogin.html就會報錯,而這個插件的作用就是當(dāng)有不正當(dāng)?shù)牟僮鲗?dǎo)致404的情況,就把頁面定位到默認(rèn)的index.html使用起來也比較簡單,記住這樣用就可以了
安裝 npm install --save connect-history-api-fallback
使用
var history = require('connect-history-api-fallback'); var express = require('express'); var app = express(); app.use(history());以上就是本文的全部內(nèi)容,希望對大家的學(xué)習(xí)有所幫助,也希望大家多多支持武林網(wǎng)。
新聞熱點(diǎn)
疑難解答