.env文件的作用是什么

dotenv#

dotenv 是什么：Dotenv 是一个零依赖模块，它将环境变量从 .env 文件加载到 process.env 中。

我们可以初始化一个 npm 项目，按照步骤使用 dotenv 来创建一个 demo。

• 初始化

  1
  mkdir dotenv-test
  2
  # 初始化npm项目
  3
  pnpm init & pnpm i dotenv
  4
  # 创建.env文件和index.ts文件
  5
  touch .evn & touch index.ts

• 在.env 中添加变量

  1
  # 测试变量
  2
  APP_NAME="dotenv-test"
  3
  APP_PKG_MANAGER="pnpm"
  4
  
  5
  # 测试多行变量
  6
  PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----
  7
  ...
  8
  Kh9NV...
  9
  ...
  10
  -----END RSA PRIVATE KEY-----"
  11
  
  12
  # 也可以使用\n换行符一行输入
  13
  PRIVATE_KEY_CHARACTER="-----BEGIN RSA PRIVATE KEY-----\n...\nKh9NV...\n...\n-----END RSA PRIVATE KEY-----"

• index.ts 中输出测试

  1
  import * as dotenv from 'dotenv'
  2
  dotenv.config()
  3
  
  4
  console.log(`Current project name is ${process.env.APP_NAME}`)
  5
  console.log(`The package manager used is ${process.env.APP_PKG_MANAGER}`)
  6
  
  7
  console.log('多行输出：')
  8
  console.log(process.env.PRIVATE_KEY)
  9
  console.log('使用\\n字符多行输出：')
  10
  console.log(process.env.PRIVATE_KEY_CHARACTER)

  执行npx esno index.ts，可以看到输出结果如下：

  

  dotenv.config() 会自动读取当前路径下.env 文件，解析内容，将其分配给 process.env，并返回一个对象，该对象带有包含加载内容的已解析键，如果失败则返回错误键。同时包含一些配置可以自定义配置。

如果需要使用变量时，就需要dotenv-expand的帮助。

我们已经了解了 dotenv 的使用方式，我们通过读源码的方式来揭秘一下它的实现原理。

1
# 直接克隆川哥的项目
2
git clone https://github.com/lxchuan12/dotenv-analysis.git
3
cd dotenv-analysis/dotenv && yarn i
4
# VSCode 直接打开当前项目
5
code .
6
# 我写的例子都在 examples 这个文件夹中，可以启动服务本地查看调试
7
# 在 dotenv-analysis 目录下
8
node examples/index.js