本文共 12655 字，大约阅读时间需要 42 分钟。
一言以蔽：CommonJS是服务器端模块的规范，Node.js采用了这个规范。http://jafeney.com/2016/01/10/2016-01-10-common/
commonJS简介
根据CommonJS规范，一个单独的文件就是一个模块。加载模块使用
require方法，该方法读取一个文件并执行，最后返回文件内部的exports对象。
举个例子 example.js
1 2 3 4 5 6 7 8 | console.log("evaluating example.js"); var invisible = function () { console.log("invisible"); } exports.message = "hi"; exports.say = function () { console.log(message); } |
我们可以通过 require 加载这个模块
1 | var example = require('./example.js'); |
这时，变量example就对应模块中的exports对象，于是就可以通过这个变量，使用模块提供的各个方法。
1 2 3 4 | { message: "hi", say: [Function] } |
require方法默认读取js文件，所以可以省略js后缀名。
1 | var example = require('./example'); |
注意 js文件名前面需要加上路径，可以是相对路径（相对于使用
require方法的文件），也可以是绝对路径。如果省略路径，node.js会认为，你要加载一个核心模块，或者已经安装在本地 node_modules 目录中的模块。如果加载的是一个目录，node.js会首先寻找该目录中的 package.json 文件，加载该文件 main 属性提到的模块，否则就寻找该目录下的 index.js 文件。
模块 addition.js
1 | exports.do = function(a, b){ return a + b }; |
上面的语句定义了一个加法模块，做法就是在exports对象上定义一个do方法，那就是供外部调用的方法。使用的时候，只要用require函数调用即可。
1 2 | var add = require('./addition'); add.do(1,2); // 输出3 |
模块 foobar.js
1 2 3 4 5 6 7 8 9 | function foobar(){ this.foo = function(){ console.log('Hello foo'); } this.bar = function(){ console.log('Hello bar'); } } exports.foobar = foobar; |
调用该模块的方法如下：
1 2 3 | var foobar = require('./foobar').foobar, test = new foobar(); test.bar(); // 输出 'Hello bar' |
有时，不需要exports返回一个对象，只需要它返回一个函数。这时，就要写成module.exports
1 2 3 | module.exports = function () { console.log("hello world") } |
CommonJS规范加载模块是同步的，也就是说，只有加载完成，才能执行后面的操作。AMD规范则是非同步加载模块，允许指定回调函数。由于Node.js主要用于服务器编程，模块文件一般都已经存在于本地硬盘，所以加载起来比较快，不用考虑非同步加载的方式，所以CommonJS规范比较适用。但是，如果是浏览器环境，要从服务器端加载模块，这时就必须采用非同步模式，因此浏览器端一般采用AMD规范。
AMD规范使用define方法定义模块（最典型的就是requireJS了）
1 2 3 4 5 6 7 8 | define(['package/lib'], function(lib){ function foo(){ lib.log('hello world!'); } return { foo: foo }; }); |
当然，AMD规范允许输出的模块兼容CommonJS规范，这时define方法需要写成下面这样：
1 2 3 4 5 6 7 8 9 10 11 12 | define(function( require, exports, module ) var someModule = require( "someModule" ); var anotherModule = require( "anotherModule" ); someModule.doTehAwesome(); anotherModule.doMoarAwesome(); exports.asplode = function() { someModule.doTehAwesome(); anotherModule.doMoarAwesome(); }; }); |
根据commonJS规范，每个nodeJS模块都必须有个package.json文件，也方便分享到npm社区。
必须字段，在package.json中最重要的就是name和version字段。他们都是必须的，如果没有就无法install。name和version一起组成的标识在假设中是唯一的。改变包应该同时改变version。
name是这个东西的名字。注意：
1、不要把node或者js放在名字中。因为你写了package.json它就被假定成为了js，不过你可以用”engine”字段指定一个引擎（见后文）。
2、这个名字会作为在URL的一部分、命令行的参数或者文件夹的名字。任何non-url-safe的字符都是不能用的。
3、这个名字可能会作为参数被传入require()，所以它应该比较短，但也要意义清晰。
4、在取名字之前，你最好去 查看一下这个名字是否已经被使用了。
必须字段，在package.json中最重要的就是name和version字段。他们都是必须的，如果没有就无法install。name和version一起组成的标识在假设中是唯一的。改变包应该同时改变version。
version必须能被 node-semver解析，它被包在npm的依赖中。（要自己用可以执行npm install semver）
可选字段，模块描述，必须是字符串。npm search的时候会用到。
可选字段，放简介，字符串。方便屌丝们在 npm search中搜索。
可选字段，项目官网的url。
注意 这和“url”不一样。如果你放一个“url”字段，registry会以为是一个跳转到你发布在其他地方的地址，然后喊你滚粗。 嗯，滚粗，没开玩笑。
可选字段，你项目的提交问题的url和（或）邮件地址。这对遇到问题的屌丝很有帮助。
差不多长这样：
1 2 3 4 | { "url" : "http://github.com/owner/project/issues", "email" : "project@hostname.com" } |
你可以指定一个或者指定两个。如果你只想提供一个url，那就不用对象了，字符串就行。如果提供了url，它会被npm bugs命令使用。
可选字段，你应该要指定一个许可证，让人知道使用的权利和限制的。
最简单的方法是，假如你用一个像BSD或者MIT这样通用的许可证，就只需要指定一个许可证的名字，像这样：
1 | { "license" : "BSD" } |
如果你有更复杂的许可条件，或者想要提供给更多地细节，可以这样:
1 2 3 4 5 | "licenses" : [ { "type" : "MyLicense" , "url" : "http://github.com/owner/project/path/to/license" } ] |
在根目录中提供一个许可证文件也蛮好的。
都是可选字段。author是一个人。contributors是一堆人的数组。person是一个有name字段，可选的有url、email字段的对象，像这样：
1 2 3 4 5 | { "name" : "Barney Rubble", "email" : "b@rubble.com", "url" : "http://barnyrubble.tumblr.com/" } |
或者可以把所有的东西都放到一个字符串里，npm会给你解析：