轉載自:https://www.cnblogs.com/ye-hcj/p/7091706.html
dev-server.js詳解
require('./check-versions')()
var config = require('../config')
if (!process.env.NODE_ENV) {
process.env.NODE_ENV = JSON.parse(config.dev.env.NODE_ENV)
}
// opn插件是用來打開特定終端的,此文件用來在默認瀏覽器中打開鏈接 opn(url)
var opn = require('opn')
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')
var webpackConfig = require('./webpack.dev.conf')
//========================================================== var mockQueryCode = require('../mock/querySecuritiesCode')
var cookiejar = require('cookiejar')
var fs = require('fs')
var https = require('https')
//==========================================================
// default port where dev server listens for incoming traffic
// 下面是webpack-dev-server 監聽的端口號,因為沒有設置process.env.PORT,所以下面監聽的就是config.dev.port即443 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
//======================================================================
// 注釋https服務器,改回http服務器
//配置https服務器證書和秘鑰
var httpsOptions = {
key: fs.readFileSync('./ssl/server.key'),
cert: fs.readFileSync('./ssl/server.crt')
}
//======================================================================
// 下面是創建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: () => {}
})
// 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()
})
})
function relayRequestHeaders(proxyReq, req) {
Object.keys(req.headers).forEach(function (key) {
proxyReq.setHeader(key, req.headers[key]);
});
}
function relayResponseHeaders(proxyRes, req, res) {
var setCookieHeaders = proxyRes.headers['set-cookie'] || [];
var modifiedSetCookieHeaders = setCookieHeaders
.map(str => new cookiejar.Cookie(str))
.map(cookie => {
//if (cookie.path && cookie.path[0] === '/') {
cookie.path = '/api'
//}
return cookie
})
.map(cookie => cookie.toString());
proxyRes.headers['set-cookie'] = modifiedSetCookieHeaders;
}
// proxy api requests
Object.keys(proxyTable).forEach(function (context) {
// 下面是代理表的處理方法,看看就行了,幾乎用不上,除非你是全棧,不用webpack-dev-server,使用后台語言做服務器
var options = proxyTable[context]
if (typeof options === 'string') {
options = { target: options }
}
options.onProxyReq=relayRequestHeaders;
options.onProxyRes=relayResponseHeaders;
app.use(proxyMiddleware(options.filter || context, options))
})
app.use('/mock', mockQueryCode)
// 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
var staticPath = path.posix.join(config.dev.assetsPublicPath, config.dev.assetsSubDirectory)
// 掛載靜態資源,下面的方法是用虛擬目錄來訪問資源,staticPath就是虛擬目錄路徑,其實不管設不設置都是static
app.use(staticPath, express.static('./static'))
//mock 數據
//app.use(staticPath,express.static('./mock'))
var uri = 'https://localhost:' + port ;
var _resolve
var readyPromise = new Promise(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()
})
//var server = app.listen(port)
//啟動https服務器
var server = https.createServer(httpsOptions,app);
server.listen(port);
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());
