設定ファイルを便利に!Node.jsでのconfigの使い方【初心者向け】

初心者向けにNode.jsのconfigの使い方について解説しています。設定ファイルを便利に利用するためのモジュールでNode.jsでのインストール手順やファイルの作成方法をまとめています。実際にコマンドを書いて説明しています。

TechAcademyマガジンはオンラインのプログラミングスクールTechAcademy [テックアカデミー]が運営する教育×テクノロジーのWebメディアです。初心者でもすぐ勉強できる記事が2,000以上あります。

今回は、Node.jsで使うconfigについて解説します。

設定ファイルを扱う際に便利に利用できるようになるので、ぜひチェックしておきましょう。

 

なお本記事は、TechAcademyのNode.jsオンライン講座の内容をもとに作成しています。

 

田島悠介

今回はnode-configモジュールを使ってみよう。

大石ゆかり

田島メンター!node-configはどういったことを行うんですか〜?

田島悠介

node-configは設定ファイルの取り扱いに使われるんだ。さっそくインストールして使ってみよう。

大石ゆかり

分かりました!

node configとは

node configとは、node-configモジュールの事です。

モジュールとはNode.jsを使用する上での拡張機能の事です。

node-configモジュールとは、Node.jsを使用する際の設定ファイルを便利に利用するためのモジュールです。

実務上もnode-configモジュールを使用して設定ファイルの取扱を行います。

 

node-configの特徴

設定ファイルはJsonやJavaScriptやYAML等の形式を利用可能です。

デフォルトでは、./config/default.yaml等の形式のファイルを読み込みます。

$NODE_ENV環境変数を設定することで、指定したファイルの設定を反映させることが可能です。

複数の設定ファイルを統合して反映させることが可能です。

runtime.jsonというファイルを変更した場合、プログラム実行中であってもリアルタイムに設定を反映することが可能です。

 

[PR] Node.jsで挫折しない学習方法を動画で公開中

node-configモジュールを実際に使ってみよう

Node.jsのインストール

node-configモジュールを使用するためにはNode.jsのインストールが必要です。

Node.jsのインストール方法についての記事も必要であれば、参考にしてみて下さい。

 

npmのインストール

また、node-configモジュールを使用するにはnpmのインストールも必要です。

npmのインストール方法についての記事も必要であれば、参考にしてみて下さい。

 

node requireのインストール

そして、node requireモジュールを使用するにはnpmのインストールも必要です。

node requireについての記事も参考にしてみてください。

 

node configのインストール

インストールコマンド

npm install --save-dev config

コマンドプロンプト上の表示

解説

npm install –save-dev configでは、node-configモジュールのインストールを行っています。

–save-devを使用することで、package.jsonの中身に自動的にconfigファイルの設定値が追加されます。

default.jsonの表示

今回はdefault.jsonに次の部分が追加されました。

"devDependencies": {
  "config": "^1.29.0"
}

 

田島悠介

まずはそれぞれのモジュールをインストールしよう。

大石ゆかり

package.jsonの中身を見ると、configに関する情報が追加されたのが確認できますね。

田島悠介

次に’default.json’というファイルと‘app.js’というファイルを作成し、以下の内容を入力してみるよ。

default.jsonという設定ファイルの作成

作成内容

メモ帳等を利用してdefault.jsonという名前のファイルを作成し、次の内容を入力して保存します

{
  "foo":{
    "bar":"techacademy"
  }
}

メモ帳上での表示

 

app.jsという実行ファイルの作成

コマンドプロンプトから作成

コマンドプロンプトからファイルを作成することも可能です。

今回は、touchコマンドを使用してコマンドプロンプトからapp.jsというJavaScriptの実行ファイルを作成します。

 

app.jsの編集と実行

入力コード

メモ帳でapp.jsを開いて次の内容を入力します

var conf = require('config');

console.log(conf.foo.bar);
console.log(conf.env);

表示結果

解説

1行目でconfigファイルを呼び出して(require)、変数confに代入しています。

変数とは値を入れる箱のようなものです。

2行目のconsole.log(conf.foo.bar);では、設定内容(conf)のfooという設定値のbarという設定値を表示させる(console.log)という処理です。

今回は、techacademyと表示されます。

3行目のconsole.log(conf.env);では、設定内容(conf)のenvという設定値を表示させる(console.log)という処理です。

今回はenvという設定自体がないのでUndefined(未定義)と表示されます。

 

以上、node configの使い方を解説しました。

Node.jsの学習サイトもまとめているので、合わせて参考にしてみてください。

 

田島悠介

この状態でapp.jsを実行してみよう。

大石ゆかり

指定した内容の文字列と、envの方はUndefinedという結果が出力されました。

田島悠介

Undefinedは変数が未定義の場合に表示されるんだ。envについてはまた別のところで解説しよう。

大石ゆかり

覚えておきます!ありがとうございました!

また、オンラインのプログラミングスクールTechAcademyでは、Node.jsオンライン講座を開催しています。

Node.jsを使ってWebアプリケーションを開発することができます。

現役エンジニアがパーソナルメンターとして受講生に1人ずつつき、マンツーマンのメンタリングで学習をサポートし、最短4週間で習得することが可能です。