CommonJSモジュールのエクスポートの違い
2024-10-20
JavaScriptにおけるCommonJSモジュールシステムでのmodule.exportsとexportsの違い
CommonJSモジュールシステムは、Node.jsやブラウザ環境でJavaScriptのコードをモジュール化するための規格です。このシステムでは、モジュールは独立したファイルとして存在し、他のモジュールからrequire関数を使用してインポートされます。
exportsオブジェクト
- このオブジェクトのプロパティやメソッドを他のモジュールからインポートすることができます。
exportsオブジェクトは、モジュールがデフォルトで公開するオブジェクトです。
// module.js
exports.name = "John Doe";
exports.age = 30;
// main.js
const module = require('./module');
console.log(module.name); // Output: John Doe
console.log(module.age); // Output: 30
module.exportsオブジェクト
module.exportsを直接変更することで、モジュールが公開するオブジェクトをカスタマイズすることができます。exportsオブジェクトは、module.exportsオブジェクトのエイリアスとして扱われます。module.exportsオブジェクトは、モジュールが実際に公開されるオブジェクトです。
// module.js
module.exports = {
name: "John Doe",
age: 30
};
// main.js
const module = require('./module');
console.log(module.name); // Output: John Doe
console.log(module.age); // Output: 30
いつどちらを使うべきか
- カスタムオブジェクトを公開する場合
module.exportsを直接変更して、任意のオブジェクトを公開することができます。 - 通常の場合
exportsオブジェクトを使用するのが一般的です。
exportsは、module.exportsのエイリアスであり、通常はexportsを使用します。
CommonJSモジュールシステムにおけるmodule.exportsとexportsの違い：具体的なコード例と解説
exportsオブジェクトを使った例
// module.js
exports.name = 'Taro Yamada';
exports.age = 30;
// main.js
const module = require('./module');
console.log(module.name); // 出力: Taro Yamada
console.log(module.age); // 出力: 30
- 解説
module.jsでexports.nameとexports.ageのようにプロパティを直接追加することで、moduleオブジェクトのnameとageプロパティとして外部からアクセスできるようにしています。main.jsでrequireを使ってmodule.jsをインポートし、module.nameやmodule.ageで値を取得しています。
// module.js
module.exports = {
name: 'Hanako Suzuki',
age: 25,
greet: function() {
console.log('こんにちは！');
}
};
// main.js
const module = require('./module');
console.log(module.name); // 出力: Hanako Suzuki
module.greet(); // 出力: こんにちは！
- 解説
module.exportsに直接オブジェクトを代入することで、そのオブジェクト全体をモジュールとして公開しています。- この例では、
name、ageというプロパティに加えて、greetという関数も公開しています。 main.jsでmodule.greet()のように関数を実行することも可能です。
exportsとmodule.exportsを混在させた例 (推奨されない)
// module.js
exports.name = 'John Doe';
module.exports = {
age: 30
};
// main.js
const module = require('./module');
console.log(module.name); // undefinedとなる可能性がある
console.log(module.age); // 30が出力される
- 解説
exportsとmodule.exportsを両方使用した場合、module.exportsに最後に代入された値がモジュールとして公開されます。- この例では、
module.exportsにオブジェクトが代入されたため、exports.nameは無視され、module.nameはundefinedになる可能性があります。 - このような書き方は混乱を招きやすく、推奨されません。
exportsとmodule.exportsを混在させることは避けるべきです。- 通常は
exportsを使用してプロパティを追加していくことで、モジュールを公開します。
- シンプルなモジュールであれば、
exportsを使用するのが一般的です。
- CommonJSはNode.jsで広く利用されているモジュールシステムですが、最近のJavaScriptではES Modulesが主流になりつつあります。ES Modulesでは
exportとimportキーワードを使用し、より簡潔な記述が可能になります。
より詳しく知りたい方へ
exportsとmodule.exportsの違いについて、より詳細な解説や他の例を見たい場合は、以下のキーワードで検索してみてください。- CommonJS モジュールシステム exports module.exports 違い
- Node.js モジュール exports module.exports
- JavaScript モジュールシステム
直接module.exportsに値を代入
最も一般的な方法です。module.exportsに任意の値（オブジェクト、関数、プリミティブ型など）を直接代入することで、その値がモジュールのエクスポートとなります。
// module.js
module.exports = 42; // 数値をエクスポート
exportsオブジェクトのプロパティを直接変更
exportsオブジェクトは、module.exportsのエイリアスとして扱われます。そのため、exportsオブジェクトのプロパティを直接変更することで、module.exportsの内容も変更できます。
// module.js
exports.message = 'Hello, world!';
関数式
モジュールを関数として定義し、その関数の戻り値をmodule.exportsに代入することで、より複雑なエクスポートを実現できます。
// module.js
module.exports = function() {
return {
name: 'John Doe',
age: 30
};
};
クラス
ES6以降ではクラスが導入されました。module.exportsにクラスを代入することで、クラスをモジュールとしてエクスポートできます。
// module.js
class Person {
constructor(name) {
this.name = name;
}
}
module.exports = Person;
複数の値をエクスポート
// module.js
module.exports = {
name: 'Alice',
age: 25,
greet: function() {
console.log('Hello!');
}
};
どの方法を選ぶべきか
- 複雑なロジック
関数やクラスを定義し、module.exportsに代入する。 - シンプルな値
数値、文字列などの場合は、直接module.exportsに代入する。
注意点
module.exportsに一度値を代入すると、その後exportsオブジェクトのプロパティを追加しても、module.exportsには反映されません。
CommonJSモジュールシステムでは、module.exportsとexports以外にも、さまざまな方法でモジュールをエクスポートできます。どの方法を選ぶかは、モジュールの構造やエクスポートしたい値の種類によって異なります。
- 命名規則
モジュール名を分かりやすくするために、PascalCase（大文字で始まる単語を連結）で命名することが一般的です。 - ES Modules
より新しいモジュールシステムであるES Modulesでは、exportキーワードを使用してモジュールをエクスポートします。CommonJSと比較して、より簡潔な記述が可能になります。
javascript node.js commonjs
