Vite env 环境配置

简介: Vite env 环境配置

获取环境变量配置

通过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相反)。
  • import.meta.env.SSR: {boolean} 应用是否运行在 server 上。

.env 文件

在项目根文件下创建 .env 文件,

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

配置环境变量

通过 以VITE_ 前缀 来设置环境变量属性,这样可以防止意外将一些环境变量泄露到客户端。

VITE_KEY=1234234
VITE_API=192.168.98.189

获取环境变量

通过import.meta.env 获取环境变量详细配置,可以在 vite.config.ts 或者 项目 任何地方访问使用。

console.log(import.meta.env)
console.log(import.meta.env.MODE)   'test'

输出的内容

如果想要在环境变量中使用 $ 符号,则必须使用 \ 对其进行转义

VITE_KEY=1234234
VITE_API=192.168.98.189
VITE_http=\$http

TypeScript  env 提示

我们可以通过在 src 下 新建一个 env.d.ts 文件,在 interface  importMetaEnv 中增加环境变量即可,这样就可以有 提示了。

/// <reference types="vite/client" />
interface ImportMetaEnv {
  readonly VITE_APP_TITLE: string
  readonly VITE_TEST_KEY: string
  // 更多环境变量...
}

如果你的代码依赖于浏览器环境的类型,比如 DOMWebWorker,你可以在 tsconfig.json 中修改 lib 字段来获取类型支持。

{
  "lib": ["WebWorker"]
}

 

HTML 环境变量替换

Vite 还支持在 HTML 文件中替换环境变量。import.meta.env 中的任何属性都可以通过特殊的 %ENV_NAME% 语法在 HTML 文件中使用:

<p>Using data from  %VITE_API_URL% </p>

如果环境变量在 import.meta.env 中不存在,比如不存在的 %NON_EXISTENT%,则会将被忽略而不被替换,这与 JS 中的 import.meta.env.NON_EXISTENT 不同,JS 中会被替换为 undefined

模式 Mode

默认情况下,开发服务器(dev) 运行在development 开发模式,build 命令运行在production 生产模式.

这意味着当执行 vite build 时,它会自动加载 .env.production 中可能存在的环境变量

# .env.production
VITE_APP_TITLE=My App

指定模式

当启动项目或者构建项目时,我们可以通过指令 指定 当前系统环境,--mode name

yarn dev --mode test
yarn build --mode test

需要在根目录下新建一个 为 test 的环境变量文件, .env.test

参考文献:

https://cn.vitejs.dev/guide/env-and-mode.html

相关文章
|
10月前
|
前端开发 JavaScript 搜索推荐
一文 Next / React / SSR / SSG / CSR 扫盲
一文 Next / React / SSR / SSG / CSR 扫盲
358 6
|
缓存 JavaScript Cloud Native
阿里云发布 Spring Boot 新脚手架,真香
本文,围绕 spring initializr 框架,以 start.spring.io 为例,全面的给大家介绍如何使用和扩展这个框架,以及背后的运行原理。
56869 1
阿里云发布 Spring Boot 新脚手架,真香
|
10月前
|
JSON 前端开发 JavaScript
Vite 共享配置
本文介绍了 Vite 配置中的 `base`、`mode`、`plugins`、`resolve` 和 `css` 等关键配置项。`base` 用于设置公共基础路径,`mode` 指定环境模式,默认为 `development` 和 `production`。`plugins` 注册项目中使用的插件。`resolve` 包含别名配置、去重依赖项和模块入口字段等选项。`css` 配置 CSS 预处理器及其选项,如导入样式变量文件。
209 6
|
10月前
一文带你封装Vue3 Echarts
一文带你封装Vue3 Echarts
858 7
一文带你封装Vue3 Echarts
|
安全 JavaScript Shell
vite中环境变量的使用与配置,非常实用详细!
【8月更文挑战第2天】vite中如何使用环境变量?根据当前的代码环境产生值的变化的变量就叫做环境变量。本文将详细介绍vite中如何使用环境变量
1611 1
|
前端开发 C++
使用 Vite 创建 React+TS+SW 项目并整合 AntDesign 、Scss 等组件或插件
本文记录了如何使用Vite创建一个React+TypeScript+Service Workers(SW)项目,并整合AntDesign组件库和Scss等插件,包括项目的创建、配置问题解决、AntDesign和Scss的整合方法。
836 1
|
11月前
|
应用服务中间件 网络安全 nginx
轻松上手Nginx Proxy Manager:安装、配置与实战
Nginx Proxy Manager (NPM) 是一款基于 Nginx 的反向代理管理工具,提供直观的 Web 界面,方便用户配置和管理反向代理、SSL 证书等。本文档介绍了 NPM 的安装步骤,包括 Docker 和 Docker Compose 的安装、Docker Compose 文件的创建与配置、启动服务、访问 Web 管理界面、基本使用方法以及如何申请和配置 SSL 证书,帮助用户快速上手 NPM。
7420 1
|
JavaScript 测试技术 API
如何从 Vue 2 无痛升级到 Vue 3,一文搞定!
如何从 Vue 2 无痛升级到 Vue 3,一文搞定!
10012 8
|
JavaScript 前端开发 Linux
vite 中使用环境变量的相关总结
vite 中使用环境变量的相关总结
553 0
|
存储 Java 测试技术
阿里巴巴java开发手册
这篇文章是关于阿里巴巴Java开发手册的整理,内容包括编程规约、异常日志、单元测试、安全规约、MySQL数据库使用以及工程结构等方面的详细规范和建议,旨在帮助开发者编写更加规范、高效和安全的代码。