Vite 中配置环境变量方法及完整示例

在 Vite 项目中配置环境变量是非常常见且重要的操作,Vite 提供了一种简便的方法来管理环境变量。以下是详细的步骤和完整的示例:

1. 创建环境变量文件

Vite 使用 .env、.env.local、.env.[mode] 等文件来存储不同环境下的变量。例如:

  • .env: 默认的环境变量配置文件
  • .env.development: 开发环境变量配置文件
  • .env.production: 生产环境变量配置文件

在项目根目录下创建这些文件并添加相应的变量:

.env

plaintext 复制代码
VITE_API_BASE_URL=https://api.example.com

.env.development

plaintext 复制代码
VITE_API_BASE_URL=https://dev.api.example.com

.env.production

plaintext 复制代码
VITE_API_BASE_URL=https://api.example.com

注意:变量名必须以 VITE_ 开头才能被 Vite 识别并在客户端代码中使用。

2. 读取环境变量

在你的 JavaScript/TypeScript 文件中,可以使用 import.meta.env 来访问环境变量:

javascript 复制代码
// src/main.js
console.log(import.meta.env.VITE_API_BASE_URL);

3. 配置 Vite (可选)

如果你需要自定义 Vite 的配置,可以在 vite.config.js 中进行设置:

javascript 复制代码
// vite.config.js
import { defineConfig } from 'vite';

export default defineConfig({
  // 根据环境变量选择不同的配置
  define: {
    'process.env.VITE_API_BASE_URL': process.env.VITE_API_BASE_URL,
  },
});

4. 完整示例

假设你有以下目录结构:

复制代码
my-vite-app/
├── .env
├── .env.development
├── .env.production
├── src/
│   └── main.js
└── vite.config.js

.env

plaintext 复制代码
VITE_API_BASE_URL=https://api.example.com

.env.development

plaintext 复制代码
VITE_API_BASE_URL=https://dev.api.example.com

.env.production

plaintext 复制代码
VITE_API_BASE_URL=https://api.example.com

src/main.js

javascript 复制代码
const apiBaseUrl = import.meta.env.VITE_API_BASE_URL;
console.log('API Base URL:', apiBaseUrl);

vite.config.js

javascript 复制代码
import { defineConfig } from 'vite';

export default defineConfig({
  // 其他 Vite 配置
});

5. 启动项目

根据不同的模式启动项目:

bash 复制代码
# 开发环境
npm run dev

# 生产环境
npm run build
npm run preview

通过以上步骤,你可以在 Vite 项目中轻松地管理和使用环境变量。

相关推荐
feixing_fx5 小时前
第一个 JS 程序:在浏览器控制台和 Node 中分别运行
开发语言·前端·javascript·前端框架·ecmascript
feixing_fx6 小时前
变量与声明:let、const、var 的选择边界
开发语言·前端·javascript·前端框架
JavaGuide8 小时前
Cloudflare 开源的这套神级安全审计 Skill 太好用了!
前端·后端
孟健9 小时前
用 unslop 拯救 AI 生成网页的塑料感,7 分钟重构落地实测
前端·人工智能·ai编程
feixing_fx10 小时前
JavaScript 是什么:从浏览器脚本到通用编程语言
开发语言·前端·javascript·前端框架·ecmascript
丘山望岳10 小时前
【开发工具】 cluade code常用快捷键
前端
小巫编程室10 小时前
我造了一个 Java 能力包:让 AI 直接调用你的业务代码
java·前端·后端
小y的笔记10 小时前
JavaScript URL 状态同步
前端·javascript
十有八七10 小时前
手搓 Agent(五):学会翻书——RAG,先查资料再回答
前端·人工智能·后端
Swot10 小时前
产品 RAG 知识库与 AI 顾问 设计与实现
前端·后端