vue3+vite中使用环境变量 .env 的一些配置情况说明

Posted 2023-03-30 一室易安

在项目文件中新建文件.env .env.pro 两个文件其中.env 是默认设置 .env.pro 为正式环境设置

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开头的变量

//老版本的vue2+webpack的情况
还是使用 process.env.NODE_ENV
console.log( process.env) //查看相关信息

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

在vite里获取env环境变量

在vite里获取env环境变量

• .env环境配置文件
• 在cli项目中我们可以是配置.env.[mode]文件来配置环境变量
• 在cli项目中使用.env.[mode]
• 在vite中使用.env文件

.env环境配置文件

在项目中总会遇到一些默认的配置,需要我们配置到静态文件中方便我们去获取,这时候就可以用到这个.env环境变量文件,在cli创建的项目中顶层的nodejs会有一个process对象,这个对象可以根据不同的环境获取不同的环境配置文件,但是,在vite里面无法使用process对象,通过研究,在vite里使用环境变量更加简便

在cli项目中我们可以是配置.env.[mode]文件来配置环境变量

代码展示。

ENV='development'
# base api
VUE_APP_BASE_URL='www.baidu.com'
VUE_APP_BASE_NAME='VUE项目'

ENV='development'
# base api
VUE_APP_BASE_URL='www.baidu.com'
VUE_APP_BASE_NAME='VUE项目'

注意：属性名必须以 VUE_APP_ 开头，如：VUE_APP_XXX

在cli项目中使用.env.[mode]

可以在js文件中是用process.env来获取环境配置。

//code
process.env

// An highlighted block
let baseURL = process.env.VUE_APP_BASE_API;

在vite中使用.env文件

Vite 在一个特殊的 import.meta.env 对象上暴露环境变量。这里有一些在所有情况下都可以使用的内建变量：

• 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 处理的代码

代码展示。

ENV='development'
# base api
VITE_APP_BASE_URL='http://10.243.11.35:7200/'
VITE_APP_BASE_NAME='vite项目'

ENV='development'
# base api
VITE_APP_BASE_URL='http://10.243.11.35:7200/'
VITE_APP_BASE_NAME='vite项目'

console.log(import.meta.env)

打印结果如下

vite使用环境配置的具体文档参考vite官网链接: https://vitejs.cn/guide/env-and-mode.html