Node.js 環境変数設定方法

package.json 内から環境変数を設定する方法 (Node.js, npm)

Node.js と npm では、package.json ファイルを使用して、プロジェクトのメタデータやスクリプトを定義することができます。その中で、環境変数を設定する方法があります。

scripts プロパティの使用

最も一般的な方法は、scripts プロパティを使用して、スクリプトを定義し、その中で環境変数を設定することです。

{
  "name": "my-project",
  "version": "1.0.0",
  "scripts": {
    "start": "node --inspect-brk index.js"
  }
}

この例では、start スクリプトを定義し、node --inspect-brk index.js を実行します。--inspect-brk オプションは、デバッグモードを有効にします。

dotenv パッケージの使用

より柔軟な環境変数の管理には、dotenv パッケージを使用することができます。このパッケージは、.env ファイルから環境変数をロードし、プロセス環境変数に設定します。

{
  "name": "my-project",
  "version": "1.0.0",
  "scripts": {
    "start": "dotenv && node index.js"
  },
  "dependencies": {
    "dotenv": "^16.0.3"
  }
}

この例では、dotenv パッケージをインストールし、start スクリプトで dotenv コマンドを実行しています。これにより、.env ファイルから環境変数が読み込まれます。

.env ファイルの作成

dotenv パッケージを使用する場合、プロジェクトのルートディレクトリに .env ファイルを作成します。このファイルに環境変数をキーと値のペアで記述します。

MY_VAR=my_value

注意
.env ファイルは、バージョン管理システムにコミットしないようにしてください。機密情報を含む環境変数を公開することはセキュリティリスクとなります。

• .env ファイルは、機密情報を公開しないように注意してください。
• dotenv パッケージを使用することで、.env ファイルから環境変数をロードし、プロセス環境変数に設定することができます。
• scripts プロパティを使用して、スクリプト内に環境変数を設定することができます。

{
  "name": "my-project",
  "version": "1.0.0",
  "scripts": {
    "start": "node --inspect-brk index.js"
  }
}

{
  "name": "my-project",
  "version": "1.0.0",
  "scripts": {
    "start": "dotenv && node index.js"
  },
  "dependencies": {
    "dotenv": "^16.0.3"
  }
}

MY_VAR=my_value

• 説明
  .env ファイルに環境変数をキーと値のペアで記述します。

Node.js 環境変数設定方法

process.env オブジェクトを使用する

const myVar = process.env.MY_VAR;
console.log(myVar); // 出力: my_value

• 説明
  process.env オブジェクトを使用して、環境変数の値を取得します。

require('dotenv').config();

const myVar = process.env.MY_VAR;
console.log(myVar); // 出力: my_value

• 説明
  dotenv パッケージをインストールし、dotenv.config() を呼び出すことで、.env ファイルから環境変数をロードします。その後、process.env オブジェクトを使用して環境変数の値を取得します。

• 使用方法
  

  {
    "scripts": {
      "start": "cross-env NODE_ENV=production node index.js"
    },
    "dependencies": {
      "cross-env": "^7.0.3"
    }
  }
  

• 説明
  cross-env パッケージは、プラットフォームに依存しない環境変数を設定するためのツールです。

npx コマンドの使用

• 使用方法
  

  {
    "scripts": {
      "start": "npx --env NODE_ENV=production node index.js"
    }
  }
  

• 説明
  npx コマンドは、プロジェクトにインストールされていないパッケージを実行するためのツールです。

シェルスクリプトの使用

• 使用方法
  

  {
    "scripts": {
      "start": "sh start.sh"
    }
  }
  

  start.sh ファイル:

  #!/bin/bash
  export NODE_ENV=production
  node index.js
  

• 説明
  シェルスクリプトを使用して、環境変数を設定し、Node.js スクリプトを実行することができます。

• 使用方法
  

  process.env.MY_VAR = 'my_value';
  

• 説明
  process.env オブジェクトに直接環境変数を設定することができます。

yargs パッケージの使用

• 使用方法
  

  const yargs = require('yargs');
  const argv = yargs.options({
    env: {
      alias: 'e',
      describe: 'Set the environment',
      type: 'string'
    }
  }).argv;
  
  process.env.NODE_ENV = argv.env || 'development';
  

• 説明
  yargs パッケージは、コマンドライン引数を解析するためのツールです。環境変数を設定することもできます。