本記事では、Node.jsで使用される.envファイルの使い方・書き方について解説しています。
.envファイルは、第三者に見られたくない情報(値)を別ファイルとして切り出す際によく使用されます。例えば、Node.jsとMongoDBを接続する際にパスワードを含むURLを指定する必要がありますが、そのままソースコードに記載してしまうとGitHubなどにファイルをアップした時に第三者に見られてしまいます。
このような時に、パスワードを含むURLを.envファイルに切り出し.gitignoreファイルで.envを追記し監視対象から外すことで第三者に見られることを防ぐことが出来ます。
Node.js / Expressの学習におすすめ参考書
Node.js超入門 第3版
綺麗なコードが書けるようになる!
リーダブルコード-より良いコードを書くためのシンプルで実践的なテクニック
手順① dotenvのインストール
まず始めに.envファイルを使用するためには、dotenvをインストールする必要があります。下記のコマンドをターミナルで実行することでdotenvをインストールすることが出来ます。
npm i dotenv
手順② .envファイルにkeyと値をセット
続いて、.envファイルを作成しkeyと値をセットします。
このkeyと値はプログラミングの変数と同じように使えます。少し異なる点としては、文字列をセットする時にダブルクォーテーションまたはシングルクォーテーションが不要です。
GOOGLE_URL=https://www.google.com/
手順③ .envファイルにセットした値を参照
最後に、.envファイルにセットした値を参照します。
インストールしたdotenvをimportし、env.config();を記述します。もし、CJSで記述する人はimportではなくrequire()でdotenvを読み込んでください。
これで.envファイルにセットした値を参照することが出来るので、process.env.の後に参照したい値がセットされているkeyを指定します。
下記のコードは手順②でセットしたGoogleのURLを参照しています。
import env from "dotenv";
env.config();
console.log(process.env.GOOGLE_URL); // => https://www.google.com/