Node.jsプログラミング：ファイル間で変数を共有するための包括的なガイド

2024-06-18

Node.jsでファイル間で変数を共有する方法

グローバル変数

最も簡単な方法は、グローバル変数を使用することです。グローバル変数は、アプリケーション全体でどこからでもアクセスできる変数です。

// ファイル1 (app.js)
global.sharedVariable = 10;

// ファイル2 (utils.js)
console.log(global.sharedVariable); // 10 を出力

利点:

シンプルで理解しやすい

コードがわかりにくくなり、メンテナンスが困難になる可能性がある
意図せぬ名前の衝突が発生する可能性がある
テストが困難になる

モジュールを使用すると、コードを複数のファイルに分割し、変数をファイル間で共有することができます。モジュールは、require() 関数を使用してインポートできます。

// ファイル1 (app.js)
const utils = require('./utils');
console.log(utils.sharedVariable); // 10 を出力

// ファイル2 (utils.js)
module.exports.sharedVariable = 10;

コードをモジュール化することで、コードをより整理し、保守しやすくなります。
名前空間の衝突を回避できます。
テストが容易になります。

グローバル変数よりも若干複雑

クラスを使用すると、変数をオブジェクトのプロパティとして格納することができます。クラスのインスタンスは、ファイル間で共有できます。

// ファイル1 (app.js)
const utils = require('./utils');
const sharedObject = new utils.SharedObject();
console.log(sharedObject.sharedVariable); // 10 を出力

// ファイル2 (utils.js)
class SharedObject {
  constructor() {
    this.sharedVariable = 10;
  }
}
module.exports = SharedObject;

オブジェクト指向プログラミングの原則に従った、より構造化された方法で変数を共有できます。
データをカプセル化し、隠蔽することができます。

モジュールよりも複雑

データベース

ファイルを共有できない場合は、データベースを使用して変数を共有することができます。データベースは、複数のノードサーバー間で変数を共有する場合に役立ちます。

複数のノードサーバー間で変数を共有できます。
データの永続化

設定と管理が複雑になる
パフォーマンスのオーバーヘッドが発生する可能性がある

Node.jsでファイル間で変数を共有するには、状況に応じて適切な方法を選択することが重要です。

シンプルで理解しやすい方法が必要な場合は、グローバル変数を使用します。
コードをモジュール化し、保守性を向上させる場合は、モジュールを使用します。
オブジェクト指向プログラミングの原則に従って変数を共有したい場合は、クラスを使用します。
複数のノードサーバー間で変数を共有する必要がある場合は、データベースを使用します。

グローバル変数

// ファイル1 (app.js)
global.sharedVariable = 10;

// ファイル2 (utils.js)
console.log(global.sharedVariable); // 10 を出力

モジュール

// ファイル1 (app.js)
const utils = require('./utils');
console.log(utils.sharedVariable); // 10 を出力

// ファイル2 (utils.js)
module.exports.sharedVariable = 10;

クラス

// ファイル1 (app.js)
const utils = require('./utils');
const sharedObject = new utils.SharedObject();
console.log(sharedObject.sharedVariable); // 10 を出力

// ファイル2 (utils.js)
class SharedObject {
  constructor() {
    this.sharedVariable = 10;
  }
}
module.exports = SharedObject;

データベース

この例では、MongoDB を使用してデータベースに接続する方法を示します。

// ファイル1 (app.js)
const MongoClient = require('mongodb').MongoClient;

const url = 'mongodb://localhost:27017';
const dbName = 'myDatabase';

MongoClient.connect(url, function(err, client) {
  if (err) {
    console.error(err);
    return;
  }

  const db = client.db(dbName);
  const collection = db.collection('sharedVariables');

  collection.findOne({}, function(err, doc) {
    if (err) {
      console.error(err);
      return;
    }

    if (doc) {
      console.log(doc.sharedVariable); // 10 を出力
    } else {
      collection.insertOne({ sharedVariable: 10 }, function(err) {
        if (err) {
          console.error(err);
          return;
        }

        console.log('Shared variable added to database.');
      });
    }
  });
});

// ファイル2 (utils.js)
const MongoClient = require('mongodb').MongoClient;

const url = 'mongodb://localhost:27017';
const dbName = 'myDatabase';

async function getSharedVariable() {
  const client = await MongoClient.connect(url);
  const db = client.db(dbName);
  const collection = db.collection('sharedVariables');

  const doc = await collection.findOne({});
  if (doc) {
    return doc.sharedVariable;
  } else {
    return null;
  }
}

module.exports.getSharedVariable = getSharedVariable;