Vite多环境配置

多环境配置的实现方式

使用vite创建的项目,相比原来的webpack项目确实在性能上带来了非常大的提升,我自己练手的一个项目也是使用vite+typescript+vue3来构建的。在实际开发场景中,我们很多时候会用到多环境配置,一般项目至少会区分dev和prod环境,然后在不同的环境下给相同参数设置一个不一样的值。在vite中也提供了这种能力,在官方文档中给出了一个示例:

.env                # 所有情况下都会加载
.env.local          # 所有情况下都会加载,但会被 git 忽略
.env.[mode]         # 只在指定模式下加载
.env.[mode].local   # 只在指定模式下加载,但会被 git 忽略

1. envDir

按照官方所说,vite会从环境目录中加载我们编写的.env.[mode]相关文件,这里默认取的是项目根目录,在实际开发时,我们肯定希望将配置文件放置在单独的文件夹下,这样可以使项目结构更加清晰,那么如何指定vite加载环境配置的目录呢?我们可以通过在vite.config.ts中指定envDir来告诉vite多环境配置文件加载的路径:

import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
import vueJsx from '@vitejs/plugin-vue-jsx'

// https://vitejs.dev/config/
export default defineConfig({
  envDir: "./viteEnv",//这里使用相对路径,绝对路径其实也可以
  server:{
    port: 3001,
    strictPort: true
  },
  plugins: [vue(), vueJsx()]
})

为了探究各个文件加载的情况,我这里创建了5个文件:

viteEnv/
    |--.env.local
    |--.env.develop
    |--.env.develop.local
    |--.env.production
    |--.env.production.local
# .env.local
# 所有模式下都会加载,但是会被git忽略
VITE_APP_NAME= venus

# .env.develop 测试环境参数值
VITE_OWNER=developer
VITE_POSITION=shanghai
VENUS_CONNECTION_TIMEOUT = 30000

# .env.develop.local 仅在develop模式下加载,但是会被git忽略,相同变量名时,此文件中的优先
VENUS_CONNECTION_TIMEOUT = 10000

# env.production 生产环境参数值
VITE_OWNER=production
VITE_POSITION=china
VENUS_CONNECTION_TIMEOUT = 3600

然后修改package.json,通过不同的指令,来启动不同环境:

  "scripts": {
    "start": "vite --mode develop",
    "start:prod": "vite --mode production",
    "build": "vue-tsc --noEmit && vite build --mode develop",
    "build:prod": "vue-tsc --noEmit && vite build --mode production",
    "preview": "vite preview"
  }

2. vite识别环境变量的规则

vite并非将你写在配置文件中的所有变量(或者说参数)都会透传给客户端,在我们没有特殊配置的时候,它只会识别VITE_开头的参数,我们可以在入口文件中打印一下:

# main.ts是我这个项目的入口文件,相关代码会在客户端执行,在这里打印一下变量
console.log(import.meta.env)

结果如下:

{
  "VITE_OWNER": "developer",
  "VITE_POSITION": "shanghai",
  "VITE_APP_NAME": "venus",
  "BASE_URL": "/",
  "MODE": "develop",
  "DEV": true,
  "PROD": false,
  "SSR": false
}

可以看到只有我们写的VITE_开头的变量才能打印出来。
其他变量是vite默认提供的几个值,含义如下:

import.meta.env.MODE: {string} 应用运行的模式。

import.meta.env.BASE_URL: {string} 部署应用时的基本 URL。他由base 配置项决定。

import.meta.env.PROD: {boolean} 应用是否运行在生产环境。

import.meta.env.DEV: {boolean} 应用是否运行在开发环境 (永远与 import.meta.env.PROD相反)。

那么有没有什么办法指定我们要读哪些参数呢,VITE_开头的这个规则是不是可以修改的?其实是可以的,我们在vite.config.ts中新加入一个参数envPrefix:

export default defineConfig({
  envDir: "./viteEnv",
  envPrefix: ["VITE", "VENUS"], //这个时候,我们可以将VITE_、VENUS_开头的变量统统透传给客户端
  server:{
    port: 3001,
    strictPort: true
  },
  plugins: [vue(), vueJsx()]
})

3. 同样的参数名,在.env.[mode], .env.local, .env.[mode].local中具有怎样的优先级顺序?

我们在.env.local, .env.develop.local, .env.develop中配置一个相同的参数VENUS_CONNECTION_TIMEOUT,然后在客户端打印就会发现,
.env.[mode].local 这个文件中的优先级最高
.env.[mode] 优先级次之
.env.local 优先级最低

4. 在服务端如何获取到env中的变量参数

上面我们看到的是vite将env中的变量透传给客户端的情况,然而有些参数我们可能需要在服务端用到,这个时候如何获取呢?以vite.config.ts文件为例,这是一个配置文件,在服务端启动时加载,相关内容会打印到服务端的控制台上。
vite提供了一个loadEnv函数,用于加载到相关参数

import { defineConfig,loadEnv } from 'vite'
import vue from '@vitejs/plugin-vue'
import vueJsx from '@vitejs/plugin-vue-jsx'
//在服务端获取配置参数
const console = require("console")
console.log(loadEnv('develop', './viteEnv'))

// https://vitejs.dev/config/
export default defineConfig({
  envDir: "./viteEnv",
  envPrefix: ["VITE", "VENUS"],
  server:{
    port: 3001,
    strictPort: true
  },
  plugins: [vue(), vueJsx()]
})

这样就可以在服务端获取到相关参数了,需要注意的是,我们在下面自定义的VENUS_开头的参数并不会获取到,如果需要,我们要在loadEnv函数参数中显式的指定前缀:

loadEnv('develop', './viteEnv', ["VITE", "VENUS"])

5. 变更为生产模式

这里是指在非生产模式下,将程序运行模式修改为生产模式,官方举了一个staging的例子,staging表示预发环境,在一些大公司,会有这样一个环境,用做准生产验证,这个环境启动时,我们可能希望staging应用应该具有类似于生产的行为。
只需要在.env.[mode]文件中加入一个参数:

NODE_ENV=production

然后我们就会发现,vite默认参数中用来标识生产的PROD值就会变为true。

{
  "VITE_USER_NODE_ENV": "production",
  "VITE_OWNER": "developer",
  "VITE_POSITION": "shanghai",
  "VITE_APP_NAME": "venus",
  "VENUS_CONNECTION_TIMEOUT": "600",
  "BASE_URL": "/",
  "MODE": "develop",
  "DEV": false,
  "PROD": true, //已经变为生产环境
  "SSR": false
}

为什么会是这样一个参数呢?看名字,这个似乎和node有关系,我们在vite.config.ts中打印一下node的环境变量看一下:

const process = require("process")
console.log(process.env)

环境变量中确实多了一个这样的参数。为什么会这样呢?这个值不仅将我的环境变成了生产模式,这个参数还出现在了nodejs的环境变量中。我猜测有两种可能:
1是NODE_ENV是个vite和nodejs都能识别的特殊参数,可以起到改变环境模式的作用。
2是vite的env中配置的NODE_开头的参数都会被传递给nodejs,用于控制nodejs的行为。
于是我又配置了一个NODE_DEMO,接着打印process.env,却发现并没有在这里出现。看来NODE_ENV确实是个特殊值。

这个项目是我自己准备拿来学习vue3的练手项目,想看完整代码的同学可以通过下面的地址访问到:
https://gitlab.com/Flnn/venus-admin

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

推荐阅读更多精彩内容