vue-cli系列之vue-cli-service整體架構(gòu)淺析
概述
vue啟動一個項目的時候,需要執(zhí)行npm run serve,其中這個serve的內(nèi)容就是vue-cli-service serve。可見,項目的啟動關(guān)鍵是這個vue-cli-service與它的參數(shù)serve。接下來我們一起看看service中主要寫了什么東東(主要內(nèi)容以備注形式寫到代碼中。)。
關(guān)鍵代碼
vue-cli-service.js
const semver = require('semver')
const { error } = require('@vue/cli-shared-utils')
const requiredVersion = require('../package.json').engines.node
// 檢測node版本是否符合vue-cli運行的需求。不符合則打印錯誤并退出。
if (!semver.satisfies(process.version, requiredVersion)) {
error(
`You are using Node ${process.version}, but vue-cli-service ` +
`requires Node ${requiredVersion}.\nPlease upgrade your Node version.`
)
process.exit(1)
}
// cli-service的核心類。
const Service = require('../lib/Service')
// 新建一個service的實例。并將項目路徑傳入。一般我們在項目根路徑下運行該cli命令。所以process.cwd()的結(jié)果一般是項目根路徑
const service = new Service(process.env.VUE_CLI_CONTEXT || process.cwd())
// 參數(shù)處理。
const rawArgv = process.argv.slice(2)
const args = require('minimist')(rawArgv, {
boolean: [
// build
'modern',
'report',
'report-json',
'watch',
// serve
'open',
'copy',
'https',
// inspect
'verbose'
]
})
const command = args._[0]
// 將參數(shù)傳入service這個實例并啟動后續(xù)工作。如果我們運行的是npm run serve。則command = "serve"。
service.run(command, args, rawArgv).catch(err => {
error(err)
process.exit(1)
})
Service.js
上面實例化并調(diào)用了service的run方法,這里從構(gòu)造函數(shù)到run一路瀏覽即可。
const fs = require('fs')
const path = require('path')
const debug = require('debug')
const chalk = require('chalk')
const readPkg = require('read-pkg')
const merge = require('webpack-merge')
const Config = require('webpack-chain')
const PluginAPI = require('./PluginAPI')
const loadEnv = require('./util/loadEnv')
const defaultsDeep = require('lodash.defaultsdeep')
const { warn, error, isPlugin, loadModule } = require('@vue/cli-shared-utils')
const { defaults, validate } = require('./options')
module.exports = class Service {
constructor (context, { plugins, pkg, inlineOptions, useBuiltIn } = {}) {
process.VUE_CLI_SERVICE = this
this.initialized = false
// 一般是項目根目錄路徑。
this.context = context
this.inlineOptions = inlineOptions
// webpack相關(guān)收集。不是本文重點。所以未列出該方法實現(xiàn)
this.webpackChainFns = []
this.webpackRawConfigFns = []
this.devServerConfigFns = []
//存儲的命令。
this.commands = {}
// Folder containing the target package.json for plugins
this.pkgContext = context
// 鍵值對存儲的pakcage.json對象,不是本文重點。所以未列出該方法實現(xiàn)
this.pkg = this.resolvePkg(pkg)
// **這個方法下方需要重點閱讀。**
this.plugins = this.resolvePlugins(plugins, useBuiltIn)
// 結(jié)果為{build: production, serve: development, ... }。大意是收集插件中的默認配置信息
// 標注build命令主要用于生產(chǎn)環(huán)境。
this.modes = this.plugins.reduce((modes, { apply: { defaultModes }}) => {
return Object.assign(modes, defaultModes)
}, {})
}
init (mode = process.env.VUE_CLI_MODE) {
if (this.initialized) {
return
}
this.initialized = true
this.mode = mode
// 加載.env文件中的配置
if (mode) {
this.loadEnv(mode)
}
// load base .env
this.loadEnv()
// 讀取用戶的配置信息.一般為vue.config.js
const userOptions = this.loadUserOptions()
// 讀取項目的配置信息并與用戶的配置合并(用戶的優(yōu)先級高)
this.projectOptions = defaultsDeep(userOptions, defaults())
debug('vue:project-config')(this.projectOptions)
// 注冊插件。
this.plugins.forEach(({ id, apply }) => {
apply(new PluginAPI(id, this), this.projectOptions)
})
// wepback相關(guān)配置收集
if (this.projectOptions.chainWebpack) {
this.webpackChainFns.push(this.projectOptions.chainWebpack)
}
if (this.projectOptions.configureWebpack) {
this.webpackRawConfigFns.push(this.projectOptions.configureWebpack)
}
}
resolvePlugins (inlinePlugins, useBuiltIn) {
const idToPlugin = id => ({
id: id.replace(/^.\//, 'built-in:'),
apply: require(id)
})
let plugins
// 主要是這里。map得到的每個插件都是一個{id, apply的形式}
// 其中require(id)將直接import每個插件的默認導出。
// 每個插件的導出api為
// module.exports = (PluginAPIInstance,projectOptions) => {
// PluginAPIInstance.registerCommand('cmdName(例如npm run serve中的serve)', args => {
// // 根據(jù)命令行收到的參數(shù),執(zhí)行該插件的業(yè)務(wù)邏輯
// })
// // 業(yè)務(wù)邏輯需要的其他函數(shù)
//}
// 注意著里是先在構(gòu)造函數(shù)中resolve了插件。然后再run->init->方法中將命令,通過這里的的apply方法,
// 將插件對應(yīng)的命令注冊到了service實例。
const builtInPlugins = [
'./commands/serve',
'./commands/build',
'./commands/inspect',
'./commands/help',
// config plugins are order sensitive
'./config/base',
'./config/css',
'./config/dev',
'./config/prod',
'./config/app'
].map(idToPlugin)
// inlinePlugins與非inline得處理。默認生成的項目直接運行時候,除了上述數(shù)組的插件['./commands/serve'...]外,還會有
// ['@vue/cli-plugin-babel','@vue/cli-plugin-eslint','@vue/cli-service']。
// 處理結(jié)果是兩者的合并,細節(jié)省略。
if (inlinePlugins) {
//...
} else {
//...默認走這條路線
plugins = builtInPlugins.concat(projectPlugins)
}
// Local plugins 處理package.json中引入插件的形式,具體代碼省略。
return plugins
}
async run (name, args = {}, rawArgv = []) {
// mode是dev還是prod?
const mode = args.mode || (name === 'build' && args.watch ? 'development' : this.modes[name])
// 收集環(huán)境變量、插件、用戶配置
this.init(mode)
args._ = args._ || []
let command = this.commands[name]
if (!command && name) {
error(`command "${name}" does not exist.`)
process.exit(1)
}
if (!command || args.help) {
command = this.commands.help
} else {
args._.shift() // remove command itself
rawArgv.shift()
}
// 執(zhí)行命令。例如vue-cli-service serve 則,執(zhí)行serve命令。
const { fn } = command
return fn(args, rawArgv)
}
// 收集vue.config.js中的用戶配置。并以對象形式返回。
loadUserOptions () {
// 此處代碼省略,可以簡單理解為
// require(vue.config.js)
return resolved
}
}
PluginAPI
這里主要是連接了plugin的注冊和service實例。抽象過的代碼如下
class PluginAPI {
constructor (id, service) {
this.id = id
this.service = service
}
// 在service的init方法中
// 該函數(shù)會被調(diào)用,調(diào)用處如下。
// // apply plugins.
// 這里的apply就是插件暴露出來的函數(shù)。該函數(shù)將PluginAPI實例和項目配置信息(例如vue.config.js)作為參數(shù)傳入
// 通過PluginAPIInstance.registerCommand方法,將命令注冊到service實例。
// this.plugins.forEach(({ id, apply }) => {
// apply(new PluginAPI(id, this), this.projectOptions)
// })
registerCommand (name, opts, fn) {
if (typeof opts === 'function') {
fn = opts
opts = null
}
this.service.commands[name] = { fn, opts: opts || {}}
}
}
module.exports = PluginAPI
總結(jié)
通過vue-cli-service中的new Service,加載插件信息,緩存到Service實例的plugins變量中。
當?shù)玫矫钚袇?shù)后,在通過new Service的run方法,執(zhí)行命令。
該run方法中調(diào)用了init方法獲取到項目中的配置信息(默認&用戶的合并),例如用戶的配置在vue.config.js中。
init過程中通過pluginAPI這個類,將service和插件plugins建立關(guān)聯(lián)。關(guān)系存放到service.commands中。
最后通過commands[cmdArgName]調(diào)用該方法,完成了插件方法的調(diào)用。
初次閱讀,只是看到了命令模式的實際應(yīng)用。能想到的好就是,新增加一個插件的時候,只需要增加一個插件的文件,并不需要更改其他文件的邏輯。其他的部分,再慢慢體會吧。。。以上就是本文的全部內(nèi)容,希望對大家的學習有所幫助,也希望大家多多支持腳本之家。
相關(guān)文章
vue實現(xiàn)el-menu和el-tab聯(lián)動的示例代碼
本文主要介紹了vue實現(xiàn)el-menu和el-tab聯(lián)動的示例代碼,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2023-04-04
vue?axios?form-data格式傳輸數(shù)據(jù)和文件方式
這篇文章主要介紹了vue?axios?form-data格式傳輸數(shù)據(jù)和文件方式,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2023-05-05
Vue+Springboot實現(xiàn)接口簽名的示例代碼
這篇文章主要介紹了Vue+Springboot實現(xiàn)接口簽名的示例代碼,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2021-04-04
解決vue初始化項目時,一直卡在Project description上的問題
今天小編就為大家分享一篇解決vue初始化項目時,一直卡在Project description上的問題,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧2019-10-10
el-table實現(xiàn)轉(zhuǎn)置表格的示例代碼(行列互換)
這篇文章主要介紹了el-table實現(xiàn)轉(zhuǎn)置表格的示例代碼(行列互換),本文結(jié)合示例代碼給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友參考下吧2024-02-02
vue3子組件上綁定(v-model="xx")父組件傳過來的值后報錯解決
這篇文章主要給大家介紹了關(guān)于vue3子組件上綁定(v-model="xx")父組件傳過來的值后報錯解決辦法,文中通過示例代碼介紹的非常詳細,對大家學習或者使用vue3具有一定的參考學習價值,需要的朋友可以參考下2023-07-07

