Node.js中的模塊接口module.exports淺析

在寫node.js代碼時，我們經常需要自己寫模塊(module)。同時還需要在模塊最后寫好模塊接口，聲明這個模塊對外暴露什么內容。實際上，node.js的模塊接口有多種不同寫法。這里作者對此做了個簡單的總結。

 

1. 返回一個JSON Object

   如下代碼是一個簡單的示例。

   var exp = { 
     "version": "1.0.0", 
     "function1": null, 
     "module1": null,
   };
   module.exports = exp;

    

   這種方式可以用於返回一些全局共享的常量或者變量，例如
   
   

   // MATH.js
   var MATH = {
     "pi": 3.14,
     "e": 2.72,
   };
   
   module.exports = MATH;

    

   調用方式為
   
   

   var MATH = require("./MATH")
   console.log(MATH.pi);

    

   這種方式還可以用於返回幾個require的其他模塊，可以實現一次require多個模塊

   // module_collection.js
   var module_collection = {
     "module1": require("./module1"),
     "module2": require("./module2"),
   };
   
   module.exports = module_collection;

   調用方式為

   var module_collection = require("./module_collection");
   var module1 = module_collection.module1;
   var module2 = module_collection.module2;
   // Do something with module1 and module2

    

   其實這種方式還有個變種，如下，通常可以返回幾個函數

   // functions.js
   var func1 = function() {
     console.log("func1");
   };
   
   var func2 = function() {
     console.log("func2");
   };
   
   exports.function1 = func1;
   exports.function2 = func2;

   調用方式為

   var functions = require("./functions");
   functions.function1();
   functions.function2();

    

2. 返回一個構造函數，也就是一個類

   如下是一個簡單的示例。

   // CLASS.js
   var CLASS = function(args) {
     this.args = args;
   }
   
   CLASS.prototype.func = function() {
     console.log("CLASS.func");
     console.log(this.args);
   };
   
   module.exports = CLASS;

    

   調用方法為

   var CLASS = require("./CLASS")
   var c = new CLASS("arguments");

    

3. 返回一個普通函數

   如下是一個簡單的示例

   // func.js
   var func = function() {
     console.log("this is a testing function");
   };
   
   module.exports = func;

    

   調用方法為

   var func = require("./func");
   func();

    

4. 返回一個對象object

   如下是一個簡單的示例

   // CLASS.js
   var CLASS = function() {
     this.say_hello = "hello";
   };
   
   CLASS.prototype.func = function() {
     console.log("I say " + this.say_hello);
   };
   
   module.exports = new CLASS();

    

   調用方法為

   var obj = require("./CLASS");
   obj.func();

    

單例模式

有時候我們需要模塊返回一個單例 singleton. 可以利用上面的方式1和方式4來實現。也就是如下兩種形式

// MATH.js
var MATH = {
  "pi": 3.14,
  "e": 2.72,
};

module.exports = MATH;

以及

// CLASS.js
var CLASS = function() {
  this.say_hello = "hello";
};

CLASS.prototype.func = function() {
  console.log("I say " + this.say_hello);
};

module.exports = new CLASS();

 

最后，真的很喜歡JavaScript這個語言，很方便。而且node.js的出現極大的增強了這門語言的能力。看好它！