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

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

1. 這個配置文件是命令npm run dev 和 npm run start 的入口配置文件，主要用於開發環境
2. 因爲這是一個系統的配置文件，將涉及不少的模塊和插件，因此這部份內容我將分多個文章講解，請關注我博客的其餘文章
3. 關於註釋
   • 當涉及到較複雜的解釋我將經過標識的方式(如（1）)將解釋寫到單獨的註釋模塊，請自行查看
4. 上代碼

// 導入check-versions.js文件，而且執行導入的函數，用來肯定當前環境node和npm版本是否符合要求
// 關於check-versions請查看我博客check-versions的相關文章
require('./check-versions')()
// 導入config目錄下的index.js配置文件，此配置文件中定義了生產和開發環境中所要用到的一些參數
// 關於index.js的文件解釋請看我博客的index.js的相關文章
var config = require('../config')
// 下面表示若是若是沒有定義全局變量NODE_ENV，則將NODE_ENV設置爲"development"
if (!process.env.NODE_ENV) {
    process.env.NODE_ENV = JSON.parse(config.dev.env.NODE_ENV)
}
// opn插件是用來打開特定終端的，此文件用來在默認瀏覽器中打開連接 opn(url)
var opn = require('opn')
// nodejs路徑模塊
var path = require('path')
// nodejs開發框架express，用來簡化操做，有興趣能夠自行去了解
var express = require('express')
// 引入webpack模塊，用來使用webpack內置插件
var webpack = require('webpack')
// 引入http-proxy-middleware插件，此插件是用來代理請求的只能用於開發環境，目的主要是解決跨域請求後臺api
var proxyMiddleware = require('http-proxy-middleware')
// 下面的意思是指，若是不是testing環境就引入webpack.dev.conf.js配置文件
// 關於webpack.dev.conf.js配置文件請關注個人相關文章，建議如今就去看，不然後面看着吃力
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 監聽的端口號，由於沒有設置process.env.PORT，因此下面監聽的就是config.dev.port即8080
var port = process.env.PORT || config.dev.port
    // automatically open browser, if not set will be false
// 下面是true,至於爲啥，原本就是true還要加!!兩個感嘆號，估計是vue做者裝了個逼吧
var autoOpenBrowser = !!config.dev.autoOpenBrowser
    // Define HTTP proxies to your custom API backend
    // https://github.com/chimurai/http-proxy-middleware
// 下面是解決開發環境跨域問題的插件，我在config目錄index.js文章中有介紹，自行查看
var proxyTable = config.dev.proxyTable
// 下面是建立node.js的express開發框架的實例，別問我爲何這樣，本身看node.js去吧
var app = express()
// 把配置參數傳遞到webpack方法中，返回一個編譯對象，這個編譯對象上面有不少屬性，本身去看吧，主要是用到裏面的狀態函數 如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插件這個必須設置爲true，具體看個人wepback-dev-config.js
})

var hotMiddleware = require('webpack-hot-middleware')(compiler, {
        log: () => {} // 使用friendly-errors-webpack-plugin插件這個必須設置爲true，具體看個人wepback-dev-config.js
    })
    // force page reload when html-webpack-plugin template changes
compiler.plugin('compilation', function(compilation) {
    // webpack任何一個插件都plugin這個方法，裏面能夠傳遞鉤子函數，用來在插件各個階段作特殊處理，鉤子函數種類不少
    compilation.plugin('html-webpack-plugin-after-emit', function(data, cb) {
        // 當插件html-webpack-plugin產出完成以後，強制刷新瀏覽器
        hotMiddleware.publish({ action: 'reload' })
        cb()
    })
})

// proxy api requests
Object.keys(proxyTable).forEach(function(context) {
    // 下面是代理表的處理方法，看看就好了，幾乎用不上，除非你是全棧，不用webpack-dev-server，使用後臺語言作服務器
    var options = proxyTable[context]
    if (typeof options === 'string') {
        options = { target: options }
    }
    app.use(proxyMiddleware(options.filter || context, options))
})

// handle fallback for HTML5 history API
// 這個插件是用來解決單頁面應用，點擊刷新按鈕和經過其餘search值定位頁面的404錯誤
// 詳情請看(3)
app.use(require('connect-history-api-fallback')())

// serve webpack bundle output
// app.use是在響應請求以前執行的，用來指定靜態路徑，掛載靜態資源
app.use(devMiddleware)

// enable hot-reload and state-preserving
// compilation error display
app.use(hotMiddleware)

// serve pure static assets
// 下面的staticPath是 static ，path.posix.join其餘配置文件中我已經介紹了，這裏再也不贅述
var staticPath = path.posix.join(config.dev.assetsPublicPath, config.dev.assetsSubDirectory)
// 掛載靜態資源，下面的方法是用虛擬目錄來訪問資源，staticPath就是虛擬目錄路徑，其實無論設不設置都是static
app.use(staticPath, express.static('./static'))
// 下面結果就是 'http://localhost:8080'
var uri = 'http://localhost:' + port

// 下面是es6的promise規範，用來處理嵌套請求的
var _resolve
var readyPromise = new Promise(resolve => {
    _resolve = resolve // resolve是一個回調函數專門用來傳遞成功請求的數據
})
// 下面是加載動畫
console.log('> Starting dev server...')
// waitUntilValid是webpack-dev-middleware實例的方法，在編譯成功以後調用
devMiddleware.waitUntilValid(() => {
    console.log('> Listening at ' + uri + '\n')
        // when env is testing, don't need open it
        // 測試環境不打開瀏覽器
    if (autoOpenBrowser && process.env.NODE_ENV !== 'testing') {
        opn(uri)
    }
    _resolve() // 這裏沒有傳遞數據，這只是在模擬
})
// node.js監聽端口
var server = app.listen(port)
// 這個導出對象是用來對外提供操做服務器和接受數據的接口，vue做者可謂考慮頗深啊
module.exports = {
    ready: readyPromise, // promise實例，能夠經過readyPromise.then收到數據
    close: () => {
        server.close() // 關閉服務器
    }
}

解釋

(1)webpack-dev-middleware插件
   這個插件只能用於開發環境，下面是這個插件的解釋
   這是一個簡潔的webpack包裝中間件，這個插件作這個主要爲文件作一件事情，就是當文件修改後提交到webpack服務器，而後處理這些修改後的文件
   這個插件有一下幾個優勢
   第一，全部的文件都是寫在disk上，文件的處理在內存中進行
   第二，若是文件在watch模式下被改動，這個中間件將不會爲這些老的bundle服務了，若是這些老的bundle上有文件改動，
         這個中間件將不會發送請求，而是等到當前編譯結束，當前最新的文件有改動，纔會發送請求，因此你不須要手動刷新了
   第三，我會在之後的版本中優化
   總結，這個中間件是webpack-dev-server的核心，實現修改文件，webapack自動刷新的功能
   安裝 npm install webpack-deb-middleware --save-dev
   使用方法以下，下面的使用方法也是webpack-dev-server實現的代碼
   var webpackMiddleware = require("webpack-deb-middleware");
   app.use(webpackMiddleware(webpack({obj1}),{obj2}))
   app.use是express的方法，用來設置靜態路徑
   上面的obj1是webpack配置對象，使用webpack方法轉換成compiler編譯對象，obj2配置的是更新文件打包後的配置，使用
   webpackMiddleware處理以後，就返回一個靜態路徑，方便獲取文件關於obj2的配置項，能夠自行查閱，必需要添加publicPath
   說到這裏，我就不賣關子了，簡言之
   咱們的靜態服務器是node.js，如今文件修改了，webpack-dev-middleware將修改的文件編譯後，告訴nodejs服務器哪些文件修改了
   而且把最新的文件上傳到靜態服務器，夠清楚了吧
(2)webpack-hot-middleware插件
   這個插件是用來將webpack-dev-middleware編譯更新後的文件通知瀏覽器，而且告訴瀏覽器如何更新文件，從而實現 Webpack hot reloading
   將這兩個插件配合起來使用你就能夠不須要webpack-dev-sever，便可以本身實現hot-replacement熱替換功能，
   webpack-hot-middleware插件通知瀏覽器更新文件大體是經過一個json對象實現的，具體實現機制這裏很少說了，下面來看具體用法
   安裝 npm install webpack-hot-middleware --save-dev
   在使用了webpack-dev-middleware以後，在添加以下代碼便可
   app.use(require("webpack-hot-middleware")(compiler));
(3)connect-history-api-fallback插件
   由於在開發單頁面應用時，總的來講項目就一個頁面，若是經過點擊刷新按鈕而且此時連接指的不是主頁的地址，就會404；或者我經過其餘的連接好比 /login.html 可是並無login.html就會報錯
   而這個插件的做用就是當有不正當的操做致使404的狀況，就把頁面定位到默認的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());