1、设置.env中的内容信息
vue3+vite 必须使用VITE开头的配置信息 否则无法获取
NODE_ENV = "env"
VITE_NODE_ENV = "env" //VITE开头的给vue3+vite使用
如果不想使用VITE开头自己修改就在vite.config.ts文件中添加 envPrefix:“APP_
//vite.config.ts
export default defineConfig({
plugins: [vue()],
envPrefix:"APP_",//APP_ 为自定义开头名
})
2、在 vite 中使用环境变量 import.meta.env
有四种环境变量,如下所示:
- MODE,用来指明现在所处于的模式,一般通过它进行不同环境的区分,比如 dev、test、pre、prd 等等,默认为:“development”
- BASE_URL,用来请求静态资源初始的 url
- PROD,用来判断当前环境是否是正式环境
- DEV,用来与 PROD 相反的环境
- SSR,用来判断是否是服务端渲染的环境
3、使用环境变量
使用 import.meta.env.VITE_NODE_ENV 获取环境变量
console.log( import.meta.env) //查看相关信息 这里不显示非VITE开头的变量
4、配置env.d.ts文件,为环境变量增加智能提示
正常使用的时候没有提示信息,想增加提示信息在vite-env.d.ts或者env.d.ts进行如下配置即可
// <reference types="vite/client" />
interface ImportMetaEnv {
readonly VITE_NODE_ENV:string;//定义提示信息 数据是只读的无法被修改
//多个变量定义多个...
}
declare module '*.vue' {
import type { DefineComponent } from 'vue'
const component: DefineComponent<{}, {}, any>
export default component
}
5、在package.json中配置模式
上面使用的时候是固定写法 需要切换.env 和 .env.pro 中不同的变量信息
在打包中配置 如下:
使用 --mode pro 进行设置
"scripts": {
"serve": "vite", //未指定默认取.env中的配置
"dev": "vite --mode dev", // 取 .env.dev文件中的配置
"pro": "vite --mode pro", // 取 .env.pro文件中的配置
"build": "vue-tsc --noEmit && vite build", //未指定默认取.env中的配置
"build:dev": "vue-tsc --noEmit && vite build --mode dev", // build的时候取dev的配置
"build:pro": "vue-tsc --noEmit && vite build --mode pro", // build的时候取pro的配置
"preview": "vite preview"
},
最后, 想要在提交代码时忽略本地.env文件,还要在.gitignore文件中添加.local
node_modules
dist
dist-ssr
*.local
6、Vue3的Env环境变量配置的应用
.env.development(# 开发环境)
# 开发环境
# 指定构建模式
VITE_NODE_ENV=development
# 页面 title 前缀
VUE_APP_TITLE=开发环境
# 网络请求公用地址
VITE_API_BASE_URL='https://huy.com/dev'
.env.production(# 生产环境)
# 构建预览页面
# 指定构建模式 production
VITE_NODE_ENV=production
# 页面 title 前缀
VUE_APP_TITLE=生产环境
# 网络请求公用地址
VITE_API_BASE_URL='https://huy.com/sit'
注:在vite.config.js中使用,不能用import.meta.env,具体使用如下
export default defineConfig(({ mode, command }) => {
const env = loadEnv(mode, process.cwd());
const { VITE_APP_ENV, VITE_APP_BASE_PATH } = env;
return {...}
})