认识一个文件 src/utils/env.ts

一句话总结

“env” 是 “environment” 的缩写，顾名思义，该文件主要用于集中管理和封装环境变量的读取。

详解

src/utils/env 这个文件通常用于管理和读取环境变量。环境变量在开发和生产环境中提供了配置和敏感信息，例如 API 密钥、数据库连接字符串等。文件的内容和结构可能会因项目需求而异，但一般来说，它们包含以下内容：

常见用途

1. 环境变量加载：在文件中可以使用 dotenv 或类似的库来加载 .env 文件中的环境变量到 process.env 中。

2. 环境变量读取：封装环境变量的读取逻辑，以便于在应用中方便地访问这些变量，而不是直接访问 process.env。

3. 配置管理：提供项目的配置信息，如 API 基础 URL、开发模式标志等。

代码示例

以下是 src/utils/env 文件的一些常见实现示例：

1. 使用 dotenv 加载 .env 文件

// src/utils/env.js
import dotenv from 'dotenv';

// 加载环境变量
dotenv.config();

// 导出环境变量
export const API_URL = process.env.API_URL || 'http://localhost:3000';
export const NODE_ENV = process.env.NODE_ENV || 'development';
export const DATABASE_URL = process.env.DATABASE_URL || 'mongodb://localhost:27017/myapp';

在这种实现中，dotenv 库被用来加载 .env 文件中的环境变量，然后这些变量被导出以供其他部分的代码使用。

2. 封装环境变量访问

// src/utils/env.js

const getEnvVar = (key, defaultValue = '') => {
  const value = process.env[key];
  if (value === undefined || value === null) {
    return defaultValue;
  }
  return value;
};

export const API_URL = getEnvVar('API_URL', 'http://localhost:3000');
export const NODE_ENV = getEnvVar('NODE_ENV', 'development');
export const DATABASE_URL = getEnvVar('DATABASE_URL', 'mongodb://localhost:27017/myapp');

这种方式提供了一个函数 getEnvVar，用于获取环境变量并提供默认值。

3. 类型安全（TypeScript）

// src/utils/env.ts

export const API_URL: string = process.env.API_URL || 'http://localhost:3000';
export const NODE_ENV: string = process.env.NODE_ENV || 'development';
export const DATABASE_URL: string = process.env.DATABASE_URL || 'mongodb://localhost:27017/myapp';

在 TypeScript 项目中，环境变量的访问可以加上类型注解以增强类型安全。

总结

src/utils/env 文件主要用于集中管理和封装环境变量的读取。这样做可以使环境变量的使用更加一致和可维护，避免直接在应用中到处硬编码环境变量。