[Vue CLI 3] 环境变量和模式配置实践与源码分析

在官方文档中,我们可以看到在新版本的 Vue CLI 中去掉了我们熟悉的 config 目录

比如之前在 prod.env.js 中我们会如下配置:


'use strict'

module.exports = {

  NODE_ENV: '"production"'

}

然后再代码里面也可以通过 process.env.NODE_ENV 进行一些环境代码的判断

在新版 Vue CLI 的项目中,我们一般在项目根目录放置几个文件:


.env.development

.env.production

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


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

里面的内容不是之前的那种对象了,只是键=值


VUE_APP_API_PREFIX=http://****

当我们执行 vue-cli-service 时候会使用:

在文件 lib/Service.jsinit 函数:


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 函数内部:


const res = loadEnv(path)

这里的 loadEnv 来自: util/loadEnv.js 文件


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

我们看看文件内部:

依赖了 fs 模块


const fs = require('fs')

对外暴露了一个函数 loadEnv,接受一个参数 path,默认值是 '.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 函数就是处理上面提到的键=值,具体如下:

换行符号来循环,用正则匹配出内容


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

}

在使用的时候,请注意

只有以 VUE_APP_ 开头的才可以使用

我们看一下代码实现的原理:

cli-service/lib/util/resolveClientEnv.js

一开始定义了一个正则:


const prefixRE = /^VUE_APP_/

对外暴露了一个函数:resolveClientEnv 接受 2 个参数: 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 默认是一个对象,循环 process.env

分解成几部分:

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

  • 一直用的 BASE_URL:


env.BASE_URL = options.baseUrl

这个函数会被 2 个地方用到,我们这里只提和业务代码有关系的那个:cli-service/lib/config/app.js

看过我们之前的 webpack-chain 文章的应该很熟悉:


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

    webpackConfig

      .plugin('define')

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

          resolveClientEnv(options)

        ])

它会被 webpack.DefinePlugin 静态嵌入到业务代码中

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,717评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,501评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,311评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,417评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,500评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,538评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,557评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,310评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,759评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,065评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,233评论 1 343
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,909评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,548评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,172评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,420评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,103评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,098评论 2 352

推荐阅读更多精彩内容