詳解vue-cli腳手架build目錄中的dev-server.js配置文件

// 導(dǎo)入check-versions.js文件，并且執(zhí)行導(dǎo)入的函數(shù)，用來(lái)確定當(dāng)前環(huán)境node和npm版本是否符合要求
// 關(guān)于check-versions請(qǐng)查看我博客check-versions的相關(guān)文章
require('./check-versions')()
// 導(dǎo)入config目錄下的index.js配置文件，此配置文件中定義了生產(chǎn)和開(kāi)發(fā)環(huán)境中所要用到的一些參數(shù)
// 關(guān)于index.js的文件解釋請(qǐng)看我博客的index.js的相關(guān)文章
var config = require('../config')
// 下面表示如果如果沒(méi)有定義全局變量NODE_ENV，則將NODE_ENV設(shè)置為"development"
if (!process.env.NODE_ENV) {
  process.env.NODE_ENV = JSON.parse(config.dev.env.NODE_ENV)
}
// opn插件是用來(lái)打開(kāi)特定終端的，此文件用來(lái)在默認(rèn)瀏覽器中打開(kāi)鏈接 opn(url)
var opn = require('opn')
// nodejs路徑模塊
var path = require('path')
// nodejs開(kāi)發(fā)框架express，用來(lái)簡(jiǎn)化操作，有興趣可以自行去了解
var express = require('express')
// 引入webpack模塊，用來(lái)使用webpack內(nèi)置插件
var webpack = require('webpack')
// 引入http-proxy-middleware插件，此插件是用來(lái)代理請(qǐng)求的只能用于開(kāi)發(fā)環(huán)境，目的主要是解決跨域請(qǐng)求后臺(tái)api
var proxyMiddleware = require('http-proxy-middleware')
// 下面的意思是指，如果不是testing環(huán)境就引入webpack.dev.conf.js配置文件
// 關(guān)于webpack.dev.conf.js配置文件請(qǐng)關(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)聽(tīng)的端口號(hào)，因?yàn)闆](méi)有設(shè)置process.env.PORT，所以下面監(jiān)聽(tīng)的就是config.dev.port即8080
var port = process.env.PORT || config.dev.port
  // automatically open browser, if not set will be false
// 下面是true,至于為啥，本來(lái)就是true還要加!!兩個(gè)感嘆號(hào)，估計(jì)是vue作者裝了個(gè)逼吧
var autoOpenBrowser = !!config.dev.autoOpenBrowser
  // Define HTTP proxies to your custom API backend
  // https://github.com/chimurai/http-proxy-middleware
// 下面是解決開(kāi)發(fā)環(huán)境跨域問(wèn)題的插件，我在config目錄index.js文章中有介紹，自行查看
var proxyTable = config.dev.proxyTable
// 下面是創(chuàng)建node.js的express開(kāi)發(fā)框架的實(shí)例，別問(wèn)我為什么這樣，自己看node.js去吧
var app = express()
// 把配置參數(shù)傳遞到webpack方法中，返回一個(gè)編譯對(duì)象，這個(gè)編譯對(duì)象上面有很多屬性，自己去看吧，主要是用到里面的狀態(tài)函數(shù) 如compilation，compile，after-emit這類(lèi)的
var compiler = webpack(webpackConfig)
// 下面是webpack-dev-middleware和webpack-hot-middleware兩兄弟，這兩個(gè)是黃金組合
// 而vue作者用這兩個(gè)插件也是用的最基本的形式，詳情看(1) (2)
var devMiddleware = require('webpack-dev-middleware')(compiler, {
  publicPath: webpackConfig.output.publicPath,
  quiet: true // 使用friendly-errors-webpack-plugin插件這個(gè)必須設(shè)置為true，具體看我的wepback-dev-config.js
})

var hotMiddleware = require('webpack-hot-middleware')(compiler, {
    log: () => {} // 使用friendly-errors-webpack-plugin插件這個(gè)必須設(shè)置為true，具體看我的wepback-dev-config.js
  })
  // force page reload when html-webpack-plugin template changes
compiler.plugin('compilation', function(compilation) {
  // webpack任何一個(gè)插件都plugin這個(gè)方法，里面可以傳遞鉤子函數(shù)，用來(lái)在插件各個(gè)階段做特殊處理，鉤子函數(shù)種類(lèi)很多
  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 requests
Object.keys(proxyTable).forEach(function(context) {
  // 下面是代理表的處理方法，看看就行了，幾乎用不上，除非你是全棧，不用webpack-dev-server，使用后臺(tái)語(yǔ)言做服務(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
// 這個(gè)插件是用來(lái)解決單頁(yè)面應(yīng)用，點(diǎn)擊刷新按鈕和通過(guò)其他search值定位頁(yè)面的404錯(cuò)誤
// 詳情請(qǐng)看(3)
app.use(require('connect-history-api-fallback')())

// serve webpack bundle output
// app.use是在響應(yīng)請(qǐng)求之前執(zhí)行的，用來(lái)指定靜態(tài)路徑，掛載靜態(tài)資源
app.use(devMiddleware)

// enable hot-reload and state-preserving
// compilation error display
app.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)資源，下面的方法是用虛擬目錄來(lái)訪問(wèn)資源，staticPath就是虛擬目錄路徑，其實(shí)不管設(shè)不設(shè)置都是static
app.use(staticPath, express.static('./static'))
// 下面結(jié)果就是 'http://localhost:8080'
var uri = 'http://localhost:' + port

// 下面是es6的promise規(guī)范，用來(lái)處理嵌套請(qǐng)求的
var _resolve
var readyPromise = new Promise(resolve => {
  _resolve = resolve // resolve是一個(gè)回調(diào)函數(shù)專(zhuān)門(mén)用來(lái)傳遞成功請(qǐng)求的數(shù)據(jù)
})
// 下面是加載動(dòng)畫(huà)
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
    // 測(cè)試環(huán)境不打開(kāi)瀏覽器
  if (autoOpenBrowser && process.env.NODE_ENV !== 'testing') {
    opn(uri)
  }
  _resolve() // 這里沒(méi)有傳遞數(shù)據(jù)，這只是在模擬
})
// node.js監(jiān)聽(tīng)端口
var server = app.listen(port)
// 這個(gè)導(dǎo)出對(duì)象是用來(lái)對(duì)外提供操作服務(wù)器和接受數(shù)據(jù)的接口，vue作者可謂考慮頗深啊
module.exports = {
  ready: readyPromise, // promise實(shí)例，可以通過(guò)readyPromise.then收到數(shù)據(jù)
  close: () => {
    server.close() // 關(guān)閉服務(wù)器
  }
}

var webpackMiddleware = require("webpack-deb-middleware");
app.use(webpackMiddleware(webpack({obj1}),{obj2}))

app.use(require("webpack-hot-middleware")(compiler));

var history = require('connect-history-api-fallback');
  var express = require('express');
  var app = express();
  app.use(history());