当前位置: 首页 > news >正文

如何在 Node.js 中使用 .env 文件管理环境变量 ?

Using .env File in Node.js

Node.js 应用程序通常依赖于环境变量来管理敏感信息或配置设置。.env 文件已经成为一种流行的本地管理这些变量的方法,而无需在代码存储库中公开它们。本文将探讨 .env 文件为什么重要,以及如何在 Node.js 应用程序中有效的使用它。

为什么使用 .env 文件 ?

Security

在源代码中保留敏感信息 (如 API 密钥、数据库凭据) 可能会将它们暴露给意想不到的访问者。将此数据分离到特定于环境的文件中,您可以使用 .gitignore 轻松地将其排除在版本控制之外。

Configurability

随着应用程序的迭代增长,它们可能需要针对不同环境 (开发、测试、生产) 使用不同配置。使用 .env 文件有助于在配置和代码之间保持清晰的分离。

Portability

通过在代码中引用环境变量,您可以维护一个易于在不同环境之间移动的一致的代码库,只需要更新 .env 文件或给定部署的实际环境变量。

如何在 Node.js 中使用 .env 文件

1. Creating the .env file

在项目的根目录中创建一个 .env 文件,环境变量定义:key = value

DATABASE_URL=mongodb://localhost:27017/mydb
SECRET_KEY=my-secret-key
API_KEY=abcdef123456

2. Ignoring the .env file

为了防止你的 .env 文件提交到存储库,将其添加到 .gitignore 文件中。

# .gitignore
node_modules/
.env

3. Reading the .env file in your application

Node.js 应用程序访问 .env 文件中定义的变量,通常会使用 dotenv 软件包。

npm install dotenv

在主应用程序文件的顶部(通常是 index.js 或 server.js),导入并配置 dotenv

require('dotenv').config();

console.log(process.env.DATABASE_URL); // Outputs: mongodb://localhost:27017/mydb

通过调用 dotenv.config().env 文件中的所有变量加载到 process.env,它们在整个应用程序中都可以访问。

4. Using environment variables in the application

既然已经加载了环境变量,就可以在整个应用程序中使用它们了。例如,当连接到 MongoDB 实例时

const mongoose = require('mongoose');

mongoose.connect(process.env.DATABASE_URL, { useNewUrlParser: true, useUnifiedTopology: true });

或者在配置 API 时

const apiKey = process.env.API_KEY;

最佳实践

Never commit your .env file:

一定要确保 .env 文件被添加到你的 .gitignore 文件中。

Use descriptive variable names

清晰的名称使团队成员更容易理解每个变量的用途。

Provide a .env.example

与其共享 .env 文件,不如创建一个 .env.example 文件,包含所有键但不包含值,这可以作为团队成员或部署的模板。

Use fallbacks

有时,您可能希望在缺少环境变量的情况下提供一个默认值。

const apiKey = process.env.API_KEY || 'default-api-key';

Don’t over-rely on .env

对于较大的应用程序或微服务架构,请考虑使用专用的配置管理系统或服务。

我的开源项目

酷瓜云课堂-在线教育解决方案

  • course-tencent-cloud(酷瓜云课堂 - gitee仓库)
  • course-tencent-cloud(酷瓜云课堂 - github仓库)

相关文章:

  • Rust嵌入式开发环境搭建指南(基于Stm32+Vscode)
  • ASP3605同步降压调节器——满足汽车电子严苛要求的电源芯片方案
  • 数学之握手问题
  • Java替换jar包中class文件
  • Matlab概率区间预测全家桶更新了,新增光伏出力区间预测,4种分布可供预测
  • 【单片机通信技术应用——学习笔记三】液晶屏显示技术,取模软件的应用
  • AI重构工程设计、施工、总承包行业:从智能优化到数字孪生的产业革命
  • 【C++】八大常见的设计模式的实现与实践指南
  • Flink 内存管理
  • 3.18练习
  • 实现图片多种处理需求的实用工具
  • 功能安全实战系列06-英飞凌Tricore系列SMU详解
  • cc1.日期和进制问题———选择题。
  • Hadoop 启动,发现 namenode、secondary namenodes,这两个没有启动,报错超时。
  • dify重磅升级:从0.15.3安全升级1.1.0新手避坑指南
  • 前端 | debounce 防抖 vs 节流(throttle)
  • 【人工智能-前端OpenWebUI】--图表显示
  • Oracle 19C分区表索引小结
  • 链式二叉树概念和结构
  • 【Java】Mybatis学习笔记
  • 马上评|起名“朱雀玄武敕令”?姓名权别滥用
  • 这个器官健康的人,不容易得抑郁症
  • 昆明一小区电梯突然从40楼降到负4楼,回应:临时断电引起
  • 药企销售的茶碱层层流转后部分被用于制毒,销售人员一审被判15年
  • 3岁男童疑遭父亲虐待,杭州警方:在异地发生,嫌疑人已被抓
  • 中国海外宏洋集团:一季度经营溢利同比降48.6%,密切关注行业收并购机会等