[Vue CLI 3] 環(huán)境變量和模式配置實(shí)踐與源碼分析

在官方文檔中媒佣,我們可以看到在新版本的 Vue CLI 中去掉了我們熟悉的 config 目錄

比如之前在 prod.env.js 中我們會如下配置:


'use strict'

module.exports = {

  NODE_ENV: '"production"'

}

然后再代碼里面也可以通過 process.env.NODE_ENV 進(jìn)行一些環(huán)境代碼的判斷

在新版 Vue CLI 的項(xiàng)目中,我們一般在項(xiàng)目根目錄放置幾個(gè)文件:


.env.development

.env.production

符合官方文檔中提到的如下模式:


.env.[mode]        # 只在指定的模式中被載入

里面的內(nèi)容不是之前的那種對象了魁淳,只是鍵=值


VUE_APP_API_PREFIX=http://****

當(dāng)我們執(zhí)行 vue-cli-service 時(shí)候會使用:

在文件 lib/Service.jsinit 函數(shù):


init (mode = process.env.VUE_CLI_MODE) {

  // load mode .env

  if (mode) {

    this.loadEnv(mode)

  }



  // load base .env

  this.loadEnv()

}

我們看一下


loadEnv (mode) {

  const basePath = path.resolve(this.context, `.env${mode ? `.${mode}` : ``}`)

  const localPath = `${basePath}.local`

  const load = path => {

  }

}

在 load 函數(shù)內(nèi)部:


const res = loadEnv(path)

這里的 loadEnv 來自: util/loadEnv.js 文件


const loadEnv = require('./util/loadEnv')

我們看看文件內(nèi)部:

依賴了 fs 模塊


const fs = require('fs')

對外暴露了一個(gè)函數(shù) loadEnv琅催,接受一個(gè)參數(shù) path,默認(rèn)值是 '.env'

最終賦值給了 process.env


module.exports = function loadEnv (path = '.env') {

  const config = parse(fs.readFileSync(path, 'utf-8'))

  Object.keys(config).forEach(key => {

    if (typeof process.env[key] === 'undefined') {

      process.env[key] = config[key]

    }

  })

  return config

}

parse 函數(shù)就是處理上面提到的鍵=值滩愁,具體如下:

換行符號來循環(huán)躯喇,用正則匹配出內(nèi)容


function parse (src) {

  const res = {}

  src.split('\n').forEach(line => {

    // matching "KEY' and 'VAL' in 'KEY=VAL'

    const keyValueArr = line.match(/^\s*([\w\.\-]+)\s*=\s*(.*)?\s*$/)

    // matched?

    if (keyValueArr != null) {

      const key = keyValueArr[1]

      let value = keyValueArr[2] || ''

      // expand newlines in quoted values

      const len = value ? value.length : 0

      if (len > 0 && value.charAt(0) === '"' && value.charAt(len - 1) === '"') {

        value = value.replace(/\\n/gm, '\n')

      }

      // remove any surrounding quotes and extra spaces

      value = value.replace(/(^['"]|['"]$)/g, '').trim()

      res[key] = value

    }

  })

  return res

}

在使用的時(shí)候,請注意

只有以 VUE_APP_ 開頭的才可以使用

我們看一下代碼實(shí)現(xiàn)的原理:

cli-service/lib/util/resolveClientEnv.js

一開始定義了一個(gè)正則:


const prefixRE = /^VUE_APP_/

對外暴露了一個(gè)函數(shù):resolveClientEnv 接受 2 個(gè)參數(shù): options 和 raw


module.exports = function resolveClientEnv (options, raw) {

  const env = {}

  Object.keys(process.env).forEach(key => {

    if (prefixRE.test(key) || key === 'NODE_ENV') {

      env[key] = process.env[key]

    }

  })

  env.BASE_URL = options.baseUrl

  if (raw) {

    return env

  }

  for (const key in env) {

    env[key] = JSON.stringify(env[key])

  }

  return {

    'process.env': env

  }

}

env 默認(rèn)是一個(gè)對象硝枉,循環(huán) process.env

分解成幾部分:

  • 匹配上 prefixRE.test(key) 或者 key 是 NODE_ENV 的

  • 一直用的 BASE_URL:


env.BASE_URL = options.baseUrl

這個(gè)函數(shù)會被 2 個(gè)地方用到廉丽,我們這里只提和業(yè)務(wù)代碼有關(guān)系的那個(gè):cli-service/lib/config/app.js

看過我們之前的 webpack-chain 文章的應(yīng)該很熟悉:


const resolveClientEnv = require('../util/resolveClientEnv')

    webpackConfig

      .plugin('define')

        .use(require('webpack/lib/DefinePlugin'), [

          resolveClientEnv(options)

        ])

它會被 webpack.DefinePlugin 靜態(tài)嵌入到業(yè)務(wù)代碼中

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市妻味,隨后出現(xiàn)的幾起案子正压,更是在濱河造成了極大的恐慌,老刑警劉巖责球,帶你破解...
    沈念sama閱讀 221,888評論 6 515
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件焦履,死亡現(xiàn)場離奇詭異拓劝,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)嘉裤,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,677評論 3 399
  • 文/潘曉璐 我一進(jìn)店門郑临,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人屑宠,你說我怎么就攤上這事厢洞。” “怎么了典奉?”我有些...
    開封第一講書人閱讀 168,386評論 0 360
  • 文/不壞的土叔 我叫張陵躺翻,是天一觀的道長。 經(jīng)常有香客問我卫玖,道長公你,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 59,726評論 1 297
  • 正文 為了忘掉前任骇笔,我火速辦了婚禮省店,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘笨触。我一直安慰自己懦傍,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 68,729評論 6 397
  • 文/花漫 我一把揭開白布芦劣。 她就那樣靜靜地躺著粗俱,像睡著了一般。 火紅的嫁衣襯著肌膚如雪虚吟。 梳的紋絲不亂的頭發(fā)上寸认,一...
    開封第一講書人閱讀 52,337評論 1 310
  • 那天,我揣著相機(jī)與錄音串慰,去河邊找鬼偏塞。 笑死,一個(gè)胖子當(dāng)著我的面吹牛邦鲫,可吹牛的內(nèi)容都是我干的灸叼。 我是一名探鬼主播,決...
    沈念sama閱讀 40,902評論 3 421
  • 文/蒼蘭香墨 我猛地睜開眼庆捺,長吁一口氣:“原來是場噩夢啊……” “哼古今!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起滔以,我...
    開封第一講書人閱讀 39,807評論 0 276
  • 序言:老撾萬榮一對情侶失蹤捉腥,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后你画,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體抵碟,經(jīng)...
    沈念sama閱讀 46,349評論 1 318
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡桃漾,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,439評論 3 340
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了立磁。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片呈队。...
    茶點(diǎn)故事閱讀 40,567評論 1 352
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡剥槐,死狀恐怖唱歧,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情粒竖,我是刑警寧澤颅崩,帶...
    沈念sama閱讀 36,242評論 5 350
  • 正文 年R本政府宣布,位于F島的核電站蕊苗,受9級特大地震影響沿后,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜朽砰,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,933評論 3 334
  • 文/蒙蒙 一尖滚、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧瞧柔,春花似錦漆弄、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,420評論 0 24
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至哥蔚,卻和暖如春倒谷,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背糙箍。 一陣腳步聲響...
    開封第一講書人閱讀 33,531評論 1 272
  • 我被黑心中介騙來泰國打工渤愁, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人深夯。 一個(gè)月前我還...
    沈念sama閱讀 48,995評論 3 377
  • 正文 我出身青樓抖格,卻偏偏與公主長得像,于是被迫代替她去往敵國和親塌西。 傳聞我的和親對象是個(gè)殘疾皇子他挎,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,585評論 2 359

推薦閱讀更多精彩內(nèi)容