vue-cli腳手架的dev-server.js設定檔使用詳解
- php中世界最好的语言原創
- 2018-04-14 13:57:572557瀏覽
這次帶給大家vue-cli腳手架的dev-server.js設定檔使用詳解，使用vue-cli腳手架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());
相信看了本文案例你已經掌握了方法，更多精彩請關注php中文網其它相關文章！
推薦閱讀：
以上是vue-cli腳手架的dev-server.js設定檔使用詳解的詳細內容。更多資訊請關注PHP中文網其他相關文章！