まくまくNode.jsノート
Node.js 用モジュールの作り方（require でロード可能な Node モジュールを作成する）
Node.js では、.js ファイルをモジュールとして扱うことができます（配布用に package.json が用意されたものは、特に「パッケージ」と呼ばれます）。
作成したモジュール（.js ファイル）は、下記のように require() を使用して読み込むことができます。
var mod = require('./mymodule.js'); // .js は省略可能
mod.foo(1, 2);
Node モジュールで公開するプロパティや関数は、以下のいずれかの方法で設定します。
exports の各プロパティに設定する方法module.exports 自体に任意のオブジェクトを代入する方法exportsオブジェクト（実際は module.exports のエイリアス）のプロパティとして設定したものが require したクライアント側からアクセスできるようになります。
逆に、exports のプロパティに設定されていない変数や関数は、ファイル内にスコープが限定されます。
下記の例では、exports のプロパティ経由で、name 変数、add 関数を公開しています。
// 公開される変数や関数
exports.name = 'magu';
exports.add = function(a, b) { return privFunc(a, b); }
// 非公開の変数や関数
var secret = 100;
function privFunc(a, b) { return a + b + secret; }
この Node モジュールは、以下のように require() 関数でロードして使用します。
同じディレクトリに置いたモジュールは、プレフィックスに ./ を付けた相対パスで指定します（拡張子の .js は省略可能です）。
var mymodule = require('./mymodule'); // mymodule.js のロード
console.log(mymodule.name); //=> 'magu'
console.log(mymodule.add(1, 2)); //=> 103
module.exports にオブジェクトを代入すると、require 時にそのオブジェクト自体が返されるようになります。
module.exports = {
name: 'magu',
add: function(a, b) { return a + b; }
};
var mymodule = require('./mymodule'); // mymodule.js のロード
console.log(mymodule.name); //=> 'magu'
console.log(mymodule.add(1, 2)); //=> 3
exports が module.exports のエイリアスなのであれば、exports = myObj; としても myObj を公開できそうですが、この方法は上手くいきません。exports は module.exports を参照する単なる変数であり、module.exports 自体に値を代入するには、あくまで module.exports = myObj; とする必要があります。
JavaScript では関数もオブジェクト（関数オブジェクト）なので、module.exports に関数を代入することができます。
この場合、require 時に関数オブジェクト自体が返されることになります。
module.exports = function(name) {
console.log('Hello ' + name);
}
var greet = require('./greet'); // greet.js のロード
greet('Joe'); //=> 'Hello Joe'
クラスのコンストラクタ（関数オブジェクト）を、module.exports に代入してやれば、require 時にコンストラクタが返されるようになるので、クラスライブラリとして使用できる Node モジュールとして使用できるようになります。
下記は、Counter クラスを提供するモジュール (counter.js) の実装例です。
function Counter() {
this.val = 0;
}
Counter.prototype.increment = function () {
this.val += 1;
};
Counter.prototype.getCount = function () {
return this.val;
};
// Counter コンストラクタを公開
module.exports = Counter;
var Counter = require('./counter.js'); // コンストラクタが返される
var c = new Counter();
c.increment();
console.log(c.getCount()); //=> 1
c.increment();
console.log(c.getCount()); //=> 2
c.increment();
console.log(c.getCount()); //=> 3
一連のクラスを同時に扱う必要があるフレームワークのような機能を提供したい場合は、下記のように一度の require() 呼び出しで複数のクラスを参照できるようにしておくと便利です。
var animal = require('./animal');
var cat = new animal.Cat();
var dog = new animal.Dog();
cat.greet();
dog.greet();
下記のような書き方もよく見ますね。
var Cat = require('./animal').Cat;
var Dog = require('./animal').Dog;
var cat = new Cat();
var dog = new Dog();
これを実現する簡単な方法は、下記のように animal.js の中で複数のコンストラクタを定義する方法です。
module.exports = {
Cat: function () { /* Cat コンストラクタ実装 */ },
Dog: function () { /* Dog コンストラクタ実装 */ },
};
ただ、1 ファイル (animal.js) だけでプログラムを記述していくと、ファイルが肥大化してメンテナンス性が悪くなってしまいます。
ここでは、クラスごとにファイルを分割し、それらのファイルを animal ディレクトリ内で管理する方法を説明します。
ディレクトリ構成は下記のようにします。
- main.js （エントリポイント）
- animal/
+-- index.js （ここから下記のファイルをすべて読み込む）
+-- cat.js （Cat クラス）
+-- dog.js （Dog クラス）
Node.js の require() 関数は柔軟なファイル検索を行ってくれるため、
var animal = require('./animal');
のように拡張子を省略してモジュール名を指定すると、./animal/index.js を検索してくれます（ただし、./animal.js というファイルが存在していれば、そちらが優先的に使用されます）。
この animal/index.js ファイルの中で、関連するクラスファイルをさらに require() で読み込むようにすれば、各クラスごとに別ファイルで管理できるようになります。
module.exports = {
Cat: require('./cat.js'),
Dog: require('./dog.js'),
};
function Cat() {
this.value = 'Meow!';
}
Cat.prototype.greet = function() {
console.log(this.value);
};
module.exports = Cat; // コンストラクタを公開
function Dog() {
this.value = 'Bow wow!';
}
Dog.prototype.greet = function() {
console.log(this.value);
};
module.exports = Dog; // コンストラクタを公開
このように cat.js と dog.js をファイルに分割したことにより、副次的な作用として、下記のように単一のクラスだけを読み込むこともできるようになります。
// Cat クラスだけをロード
var Cat = require('./animal/cat');
