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

標(biāo)簽(空格分隔): vue


這個(gè)配置文件是命令npm run devnpm run start 的入口配置文件,主要用于開(kāi)發(fā)環(huán)境

// 導(dǎo)入check-versions.js文件,并且執(zhí)行導(dǎo)入的函數(shù),用來(lái)確定當(dāng)前環(huán)境node和npm版本是否符合要求
require('./check-versions')()

// 導(dǎo)入config目錄下的index.js配置文件,此配置文件中定義了生產(chǎn)和開(kāi)發(fā)環(huán)境中所要用到的一些參數(shù)
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配置文件

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
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)題的插件
var proxyTable = config.dev.proxyTable

// 下面是創(chuàng)建node.js的express開(kāi)發(fā)框架的實(shí)例
var app = express()

// 把配置參數(shù)傳遞到webpack方法中,返回一個(gè)編譯對(duì)象
var compiler = webpack(webpackConfig)

// 下面是webpack-dev-middleware和webpack-hot-middleware兩兄弟,這兩個(gè)是黃金組合
// 而vue作者用這兩個(gè)插件也是用的最基本的形式
var devMiddleware = require('webpack-dev-middleware')(compiler, {
    publicPath: webpackConfig.output.publicPath,
    quiet: true  // 使用friendly-errors-webpack-plugin插件這個(gè)必須設(shè)置為true
})

var hotMiddleware = require('webpack-hot-middleware')(compiler, {
        log: () => {} // 使用friendly-errors-webpack-plugin插件這個(gè)必須設(shè)置為true
    })
    // force page reload when html-webpack-plugin template changes
compiler.plugin('compilation', function(compilation) {
// webpack任何一個(gè)插件都plugin這個(gè)方法,里面可以傳遞鉤子函數(shù),用來(lái)在插件各個(gè)階段做特殊處理,鉤子函數(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 requests
Object.keys(proxyTable).forEach(function(context) {
// 下面是代理表的處理方法
    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ò)誤

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
var staticPath = path.posix.join(config.dev.assetsPublicPath, config.dev.assetsSubDirectory)
// 掛載靜態(tài)資源,下面的方法是用虛擬目錄來(lái)訪問(wèn)資源,staticPath就是虛擬目錄路徑,不管設(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ù)專門(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ù)器
    }
}

npm init 新建package.json

opn

作為跨平臺(tái)的打開(kāi)文件或者網(wǎng)站的模塊,最常見(jiàn)的使用是比如項(xiàng)目開(kāi)發(fā)或者啟動(dòng)的時(shí)候打開(kāi)瀏覽器進(jìn)行訪問(wèn)

模塊地址
https://npm.taobao.org/package/opn

基本使用
安裝

$ npm install opn

使用

const opn = require('opn');

// Opens the image in the default image viewer
opn('unicorn.png').then(() => {
    // image viewer closed
});

// Opens the url in the default browser
opn('http://sindresorhus.com');

// Specify the app to open in
opn('http://sindresorhus.com', {app: 'firefox'});

// Specify app arguments
opn('http://sindresorhus.com', {app: ['google chrome', '--incognito']});

demo

6.0.0 被棄用 ======》open
在根目錄下新建scripts文件夾,寫(xiě)對(duì)應(yīng)的功能js文件,然后在package.json中直接node 執(zhí)行這個(gè)文件即可

//package.json
  "scripts": {
    "test": "teset",
    "opn": "gulp ",
    "opn2":"node ./scripts/opn"
  },
// opn.js 
let opn = require("opn")
let os = require("os")
let osStr = os.platform()
let uri = "http://www.baidu.com"
if(osStr.indexOf("win")>-1){
    opn(uri, {
        app: ['chrome']
    });
}

http-proxy-middleware

后臺(tái)將請(qǐng)求轉(zhuǎn)發(fā)給其它服務(wù)器
當(dāng)前主機(jī)A為http://localhost:3000/,現(xiàn)在瀏覽器發(fā)送一個(gè)請(qǐng)求,請(qǐng)求接口/api,這個(gè)請(qǐng)求的數(shù)據(jù)在另外一臺(tái)服務(wù)器B上(http://10.119.168.87:4000),這時(shí),就可通過(guò)在A主機(jī)設(shè)置代理,直接將請(qǐng)求發(fā)送給B主機(jī)

var express = require('express');
var proxy = require('http-proxy-middleware');

var app = express();

app.use('/api', proxy({target: 'http://10.119.168.87:4000', changeOrigin: true}));
app.listen(3000);

安裝

npm install --save-dev http-proxy-middleware
1 var proxy = require('http-proxy-middleware');
2 
3 var apiProxy = proxy('/api', {target: 'http://www.example.org'});
4 //                   \____/   \_____________________________/
5 //                     |                    |
6 //                需要轉(zhuǎn)發(fā)的請(qǐng)求           目標(biāo)服務(wù)器

說(shuō)明:第一個(gè)參數(shù)是可以省略的。

// 引用依賴
var express = require('express');
var proxy = require('http-proxy-middleware');

// proxy 中間件的選擇項(xiàng)
var options = {
        target: 'http://www.example.org', // 目標(biāo)服務(wù)器 host
        changeOrigin: true,               // 默認(rèn)false,是否需要改變?cè)贾鳈C(jī)頭為目標(biāo)URL
        ws: true,                         // 是否代理websockets
        pathRewrite: {
            '^/api/old-path' : '/api/new-path',     // 重寫(xiě)請(qǐng)求,比如我們?cè)丛L問(wèn)的是api/old-path,那么請(qǐng)求會(huì)被解析為/api/new-path
            '^/api/remove/path' : '/path'           // 同上
        },
        router: {
            // 如果請(qǐng)求主機(jī) == 'dev.localhost:3000',
            // 重寫(xiě)目標(biāo)服務(wù)器 'http://www.example.org' 為 'http://localhost:8000'
            'dev.localhost:3000' : 'http://localhost:8000'
        }
    };

// 創(chuàng)建代理
var exampleProxy = proxy(options);

// 使用代理
var app = express();
    app.use('/api', exampleProxy);
    app.listen(3000);

webpack-dev-middleware

一種快速式開(kāi)發(fā)中間件,用于webpack bundle,允許提供從webpack發(fā)出的文件。
這應(yīng)該僅用于開(kāi)發(fā)。
使用此中間件的一些好處包括:
沒(méi)有文件寫(xiě)入磁盤(pán),而是處理內(nèi)存中的文件
如果文件在監(jiān)視模式下更改,則中間件會(huì)延遲請(qǐng)求,直到編譯完成。
支持熱模塊重載(HMR)。
此模塊至少需要Node v6.9.0和Webpack v4.0.0,并且必須與接受快速中間件的服務(wù)器一起使用。

npm install webpack-dev-middleware --save-dev

使用

const webpack = require('webpack');
const middleware = require('webpack-dev-middleware');
const compiler = webpack({
  // webpack options
});
const express = require('express');
const app = express();
 
app.use(
  middleware(compiler, {
    // webpack-dev-middleware options
  })
);
 
app.listen(3000, () => console.log('Example app listening on port 3000!'));
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書(shū)系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

友情鏈接更多精彩內(nèi)容