CommonJS入门

一只前端小菜鸟
596 阅读3分钟

CommonJS

在nodejs中，由于有且仅有一个入口文件（启动文件），而开发一个应用肯定会涉及到多个文件配合，因此，nodejs对模块化的需求比浏览器端要大的多

由于nodejs刚刚发布的时候，前端没有统一的、官方的模块化规范，因此，它选择使用社区提供的CommonJS作为模块化规范

在学习CommonJS之前，首先认识两个重要的概念：模块的导出和模块的导入

模块的导出

要理解模块的导出，首先要理解模块的含义

什么是模块？

模块就是一个JS文件，它实现了一部分功能，并隐藏自己的内部实现，同时提供了一些接口供其他模块使用

模块有两个核心要素：隐藏和暴露

隐藏的，是自己内部的实现

暴露的，是希望外部使用的接口

任何一个正常的模块化标准，都应该默认隐藏模块中的所有实现，而通过一些语法或api调用来暴露接口

暴露接口的过程即模块的导出

模块的导入

当需要使用一个模块时，使用的是该模块暴露的部分（ 导出的部分），隐藏的部分是永远无法使用的。

当通过某种语法或api去使用一个模块时，这个过程叫做模块的导入

CommonJS规范

CommonJS使用exports导出模块，require导入模块

具体规范如下：

  1. 如果一个JS文件中存在exports或require，该JS文件是一个模块
  2. 模块内的所有代码均为隐藏代码，包括全局变量、全局函数，这些全局的内容均不应该对全局变量造成任何污染
  1. 如果一个模块需要暴露一些API提供给外部使用，需要通过exports导出，exports是一个空的对象，你可以为该对象添加任何需要导出的内容
  2. 如果一个模块需要导入其他模块，通过require实现，require是一个函数，传入模块的路径即可返回该模块导出的整个内容

例子1

  • util.js
var count = 0; //需要隐藏的内部实现

// 要暴露给外部的接口
function getNumber () {
    count++;
    return count;
}

// exports = {}
exports.getNumber = getNumber
exports.abc = "abc"
  • index.js
var util = require("./util")
console.log(util)
console.log(util.abc)
console.log(util.getNumber())
console.log(util.getNumber())
console.log(util.getNumber())
console.log(util.count)

// node index.js 输出
{ getNumber: [Function: getNumber], abc: 'abc' }
abc
1
2
3
undefined

nodejs对CommonJS的实现

为了实现CommonJS规范，nodejs对模块做出了以下处理

  1. 为了保证高效的执行，仅加载必要的模块。nodejs只有执行到require函数时才会加载并执行模块
  2. 为了隐藏模块中的代码，nodejs执行模块时，会将模块中的所有代码放置到一个函数中执行，以保证不污染全局变量。
// 实际上不是立即执行函数
 (function(){
     //模块中的代码
 })()
  1. 为了保证顺利的导出模块内容，nodejs做了以下处理
    1. 在模块开始执行前，初始化一个值module.exports = {}
    2. module.exports即模块的导出值
    1. 为了方便开发者便捷的导出，nodejs在初始化完module.exports后，又声明了一个变量exports = module.exports
 (function(module){
     module.exports = {};
     var exports = module.exports;
     //模块中的代码
     return module.exports;
 })()

例子1：用module.exports取代之前的expors

utils.js

module.exports.getNumber = getNumber
module.exports.abc = "abc"

index.js

var util = require("./util")
console.log(util)
// 输出
{ abc: 'abc' }

例子2：module.exports重新赋值

util.js

console.log(module.exports === exports)
module.exports = {}
console.log(module.exports === exports)

inde.js

var util = require("./util")
// 输出
true
false

例子2.1： module.exports重新赋值， exports也添加属性

util.js

module.exports = {
    "帅": "哥"
}
exports["美"] = "女"

index.js

var util = require("./util")
console.log(util)
// 输出
{ '帅': '哥' }

例子3 module.exports功能更强大,把exports重新赋值不影响导出

util.js

module.exports = "前端真好玩"
exports = "前端真有趣"

index.js

var util = require("./util")
console.log(util)
// 输出
前端真好玩
  1. 为了避免反复加载同一个模块，nodejs默认开启了模块缓存，如果加载的模块已经被加载过了，则会自动使用之前的导出结果

例子：

util.js

console.log("util执行了")

b.js

require('./util.js')
console.log("b模块执行了")

index.js

require("./b")
var util1 = require("./util")
var util2 = require("./util")
// 输出
util执行了
b模块执行了
avatar
文章
阅读
粉丝