Node.js中的模块接口module.exports浅析

在写node.js代码时,我们经常需要自己写模块(module)。同时还需要在模块最后写好模块接口,声明这个模块对外暴露什么内容。实际上,node.js的模块接口有多种不同写法。这里作者对此做了个简单的总结。

    1. 返回一个JSON Object

      如下代码是一个简单的示例。

      1 var exp = {
      2   "version": "1.0.0",
      3   "function1": null,
      4   "module1": null,
      5 };
      6 module.exports = exp;

      这种方式可以用于返回一些全局共享的常量或者变量,例如

      1 // MATH.js
      2 var MATH = {
      3   "pi": 3.14,
      4   "e": 2.72,
      5 };
      6
      7 module.exports = MATH;

      调用方式为

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

      这种方式还可以用于返回几个require的其他模块,可以实现一次require多个模块

      1 // module_collection.js
      2 var module_collection = {
      3   "module1": require("./module1"),
      4   "module2": require("./module2"),
      5 };
      6
      7 module.exports = module_collection;

      调用方式为

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

      其实这种方式还有个变种,如下,通常可以返回几个函数

       1 // functions.js
       2 var func1 = function() {
       3   console.log("func1");
       4 };
       5
       6 var func2 = function() {
       7   console.log("func2");
       8 };
       9
      10 exports.function1 = func1;
      11 exports.function2 = func2;

      调用方式为

      1 var functions = require("./functions");
      2 functions.function1();
      3 functions.function2();
    2. 返回一个构造函数,也就是一个类

      如下是一个简单的示例。

       1 // CLASS.js
       2 var CLASS = function(args) {
       3   this.args = args;
       4 }
       5
       6 CLASS.prototype.func = function() {
       7   console.log("CLASS.func");
       8   console.log(this.args);
       9 };
      10
      11 module.exports = CLASS;

      调用方法为

      1 var CLASS = require("./CLASS")
      2 var c = new CLASS("arguments");
    3. 返回一个普通函数

      如下是一个简单的示例

      1 // func.js
      2 var func = function() {
      3   console.log("this is a testing function");
      4 };
      5
      6 module.exports = func;

      调用方法为

      1 var func = require("./func");
      2 func();
    4. 返回一个对象object

      如下是一个简单的示例

       1 // CLASS.js
       2 var CLASS = function() {
       3   this.say_hello = "hello";
       4 };
       5
       6 CLASS.prototype.func = function() {
       7   console.log("I say " + this.say_hello);
       8 };
       9
      10 module.exports = new CLASS();

      调用方法为

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

单例模式

有时候我们需要模块返回一个单例 singleton. 可以利用上面的方式1和方式4来实现。也就是如下两种形式

1 // MATH.js
2 var MATH = {
3   "pi": 3.14,
4   "e": 2.72,
5 };
6
7 module.exports = MATH;

以及

 1 // CLASS.js
 2 var CLASS = function() {
 3   this.say_hello = "hello";
 4 };
 5
 6 CLASS.prototype.func = function() {
 7   console.log("I say " + this.say_hello);
 8 };
 9
10 module.exports = new CLASS();

最后,真的很喜欢JavaScript这个语言,很方便。而且node.js的出现极大的增强了这门语言的能力。看好它!

时间: 2024-10-19 20:22:59

Node.js中的模块接口module.exports浅析的相关文章

Node.js学习笔记(一)module.exports与exports

在node.js中模块与文件是一一对应的,也就是说一个node.js文件就是一个模块.如将函数作为模块的方法导出: var printName=function(name){ console.log(name); }; exports.printName=printName; 然后在index.js文件中请求这个模块,使用该模块的方法: var name=require('./name'); name.printName(xiaomu); //xiaomu 其实module.exports才是模

Node.js中的模块机制

本文为读书笔记. 一.CommonJS的模块规范 Node与浏览器以及 W3C组织.CommonJS组织.ECMAScript之间的关系 Node借鉴CommonJS的Modules规范实现了一套模块系统,所以先来看看CommonJS的模块规范. CommonJS对模块的定义十分简单,主要分为模块引用.模块定义和模块标识3个部分. 1. 模块引用 模块引用的示例代码如下: var math = require('math'); 在CommonJS规范中,存在require()方法,这个方法接受模

node.js中使用net模块创建服务器和客户端

1.node.js中net模块创建服务器(net.createServer) // 将net模块 引入进来 var net = require("net"); // 创建一个net.Server用来监听,当连接进来的时候,就会调用我们的函数 // client_sock,就是我们的与客户端通讯建立连接配对的socket // client_sock 就是与客户端通讯的net.Socket var server = net.createServer(function(client_soc

node.js中通过dgram数据报模块创建UDP服务器和客户端

node.js中 dgram 模块提供了udp数据包的socket实现,可以方便的创建udp服务器和客户端. 一.创建UDP服务器和客户端 服务端: const dgram = require('dgram'); //创建upd套接字 //参数一表示套接字类型,'udp4' 或 'udp6' //参数二表示事件监听函数,'message' 事件监听器 let server = dgram.createSocket('udp4'); //绑定端口和主机地址 server.bind(8888, '1

node.js中net网络模块TCP服务端与客户端的使用

node.js中net模块为我们提供了TCP服务器和客户端通信的各种接口. 一.创建服务器并监听端口 const net = require('net'); //创建一个tcp服务 //参数一表示创建服务的一些配置 //参数二表示 事件 'connection' 监听回调函数 let server = net.createServer({ //表示是否允许一个半开的TCP连接,默认为false allowHalfOpen: false, //一旦来了连接,是否暂停套接字,默认为false pau

使用Node.js 和ws 模块构建WebSocket服务器

Node.js 中的ws 模块是最新的一个易用的.速度超快的web socket 实现,可以用来快速构建web socket 应用.其中还包含了wscat 命令行工具,可以用来模拟客户端或者服务器端. 在本实例中,我们将研究能够找到的最快的WebSocket 服务器.Node.js 中ws 模块不仅执行超快,而且使用也很简单.它实施方便,是本实例介绍Websocket 的理想选择. ws 模块很新,符合当前HyBi 协议草案,可以发送和接收数组类型数据(ArrayBuffer.Float32Ar

node.js中的exports和module.exports

不同的编程语言都有各自的代码组织和复用的方式,如.net.php中的命名空间,python中的import,ruby中的module等,来避免命名空间污染.一直都没搞清楚node中的exports和module.exports的区别,借此搞清楚node的代码模块复用方式. 首先怎么创建node中的modules. 可以直接创建一个文件作为module,如下module.js function writeLine(){ console.log("module.js"); } export

Node.js中exports,module.exports以及require方法

在Node.js中,使用module.exports.f = ...与使用exports.f = ...是一样的,此时exports就是module.exports的一种简写方式.但是,需要注意的是,如果直接给exports赋值的话,exports就与module.exports没有任何关联了,比如: exports = { hello: false }; // Not exported, only available in the module 此时,exports是没有导出任何变量的. 要弄

Node.js中module文件定义的top-level变量为何是私有的

在Node.js中,module文件里面使用var,const或者let定义的top-level变量为何是私有的,只能在这个模块文件中使用呢? 原因就是,在模块文件中的内容执行之前,node.js会降模块文件包含在一个函数当中,像下面这样: (function(exports, require, module, __filename, __dirname) { // Module code actually lives in here }); 这样处理之后,module文件里面定义的top-le