node.jsでdotenvを読みだせない場合の対処法

背景

---

Node.jsのアプリを起動する際、「.env」ファイルが読み込めない場合があったため、対処法を含めdotenvについて調査した。

記事の目的

---

Node.jsでアプリ起動時に.envの環境変数を読み込む

.env

---

ここでは、.envの環境変数を読み込む方法について記載する。

process.env

Node.jsで環境変数を扱いたいときは、process.envオブジェクトを参照する。process モジュールはデフォルトで使用可能になっているので、requireする必要はない。

$ node
> process.env
{
  ...
  OS: 'Ubuntu'
  Path: '...',
  ...
}

dotenv

dotenvモジュールを使用すると、カレントディレクトリに置かれた.env ファイルを読み込み、そこに記述されたkeyとvalueのペアをprocess.env経由で参照できる。

1. dotenvモジュールのインストール

$ npm install dotenv
$ npm install dotenv --save

2. .envファイルの作成

# コメント
KEY1=VALUE1
KEY2=VALUE2
KEY3=VALUE3

3. dotenvの呼び出し
• js内でのdotenvの呼び出し
下記をjsファイル内に記述(非推奨)

require('dotenv').config();

• 起動時にdotenvの呼び出し
起動時に、-r dotenv/config オプションをつける

$ node -r dotenv/config app.js

備考

---

• .envファイルの読み込みは推奨されていないため、js内でのdotenvの呼び出しは行わない方が良い
理由: 環境変数がアプリの設定ファイルのように扱われることを防ぐため

まとめ

---

• Node.jsでアプリ起動時に.envの環境変数を読み込む方法について調査、記載した

参考文献

---

• プログラム内でdotenvを読み込むのをやめた話

変更履歴

---

1. 2020/06/05: 新規作成