【保存版】Node.js環境変数の設定：.envファイル、dotenvモジュール、その他

2024-06-28

Node.jsで環境変数を設定する方法

コマンドラインから設定

export 変数名=値

上記のコマンドを実行することで、現在のシェル内で環境変数が設定されます。ただし、この方法は永続的な設定ではなく、シェルを閉じると環境変数は消去されます。

.envファイルとdotenvモジュールを使用

以下の手順で、.envファイルとdotenvモジュールを使用して、永続的に環境変数を設定することができます。

手順1：.envファイルを作成する

プロジェクトのルートディレクトリに.envという名前のファイルを作成し、設定したい環境変数とその値をキー-バリュー形式で記述します。

変数名=値

例

DB_HOST=localhost
DB_USER=username
DB_PASSWORD=password

手順2：dotenvモジュールをインストールする

以下のコマンドを実行して、dotenvモジュールをインストールします。

npm install dotenv

アプリケーションのJavaScriptファイルの先頭で、dotenvモジュールを読み込みます。

require('dotenv').config();

手順4：環境変数を使用する

process.envオブジェクトを使用して、設定した環境変数にアクセスすることができます。

const dbHost = process.env.DB_HOST;
const dbUser = process.env.DB_USER;
const dbPassword = process.env.DB_PASSWORD;

console.log(`DB_HOST: ${dbHost}`);
console.log(`DB_USER: ${dbUser}`);
console.log(`DB_PASSWORD: ${dbPassword}`);

補足

.envファイルは、通常Gitなどのバージョン管理システムで管理対象から除外します。
複数の環境（開発環境、本番環境など）で異なる環境変数を使用する場合は、それぞれの環境用の.envファイルを用意することができます。
dotenvモジュールは、以下の機能を提供します。
- .envファイルが存在しない場合や読み込みに失敗した場合にエラーを発生させる
- .envファイル内のコメント行を無視する

.envファイル

DB_HOST=localhost
DB_USER=username
DB_PASSWORD=password
PORT=3000

app.js

require('dotenv').config();

const dbHost = process.env.DB_HOST;
const dbUser = process.env.DB_USER;
const dbPassword = process.env.DB_PASSWORD;
const port = process.env.PORT;

const express = require('express');
const app = express();

app.get('/', (req, res) => {
  console.log(`DB_HOST: ${dbHost}`);
  console.log(`DB_USER: ${dbUser}`);
  console.log(`DB_PASSWORD: ${dbPassword}`);
  res.send('Hello, World!');
});

app.listen(port, () => {
  console.log(`Server listening on port ${port}`);
});