Vite从入门到精通(四)环境变量与模式

环境变量是我们前端工程中很常见的一个配置,例如我们想在development(开发)模式或者production(生产)模式下,根据不同的环境变量的配置,运行不同的代码、不同环境产生不同的代码逻辑。这时候,就需要我们的环境变量上场了。

内置环境变量

在Vite中,可以通过import.meta.env对象,获取环境变量的值。这里有一些在所有情况下都可以使用的内建变量。
我们现在打印下import.meta.env 对象


import.meta.env 对象有下面5个属性值:

  • MODE: {string} 应用运行的模式
  • BASE_URL: {string} 部署应用时的基本 URL。他由base 配置项决定。
  • PROD: {boolean} 应用是否运行在生产环境。
  • DEV: {boolean} 应用是否运行在开发环境。
  • SSR: {boolean} 应用是否运行在 server 上。

上面我们打印出MODE = "development",说明我们现在是在开发环境。
现在我们在执行下npm run build打包下看下

//打印import.meta.env
console.log(import.meta.env)

可以看到,打包完成的js文件里,我们可以发现,此时的MODE变成了production(生产)模式,并且在打包完成后的js文件里import.meta.env 会被替换成了他真正的值{BASE_URL:"/",MODE:"production",DEV:!1,PROD:!0,SSR:!1} ,这就是生产环境值的替换。

自定义环境变量

例如,我们现在在项目的根目录下,新建一个.env 文件。
加载的环境变量也会通过 import.meta.env 以字符串形式暴露给客户端源码。
为了防止意外地将一些环境变量泄漏到客户端,Vite规定:只有以 VITE_ 为前缀的变量才会暴露给经过 vite 处理的代码。例如下面这些环境变量:

  • .env 内容
VITE_MY_KEY= 123

此时,我们再打印下import.meta.env 对象,就会出现VITE_MY_KEY变量

  • TypeScript 的智能提示
    这里需要注意的一点是,vite内置的环境变量属性是有代码智能提示补全的,如果你想要自己自定义的环境变量也有智能提示补全,你可以在 src 目录下创建一个 env.d.ts 文件,接着按下面这样增加 ImportMetaEnv 的定义:
/// <reference types="vite/client" />

interface ImportMetaEnv {
  readonly VITE_MY_KEY: string
  // 更多环境变量...
}

interface ImportMeta {
  readonly env: ImportMetaEnv
}

在真正项目的开发中,我们并不会直接去用.env文件,而是会新建.env.development文件和.env.production文件:

  • .env.development文件:开发环境下会读取文件里面定义的数据
  • .env.production文件:生产环境下会读取文件里面定义的数据
# .env.development
VITE_TITLE=开发环境的标题
# .env.production
VITE_TITLE=生产环境的标题

然后我们可以使用 import.meta.env.VITE_TITLE,在不同的环境下渲染不同的值



模式

我们现在在项目的根目录下,新建一个.env.test 文件,内容如下:

# .env.test
VITE_TITLE=test

package.json里 新增配置


然后我们在 npm run dev的时候给他指定运行模式是test,最后运行得到下面的结果


同理,如果我们给 npm run build的时候增加 mode,也是会改变 VITE_TITLE的值的。

总结

不同的方式,配置不同的环境变量,这样我们可以非常灵活的通过不同的.env 文件,在(不)相同的环境下或者服务器下,得到不同的结果。这个对于比较复杂的集成项目来说,是非常有用的。

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

推荐阅读更多精彩内容