码迷,mamicode.com
首页 > Web开发 > 详细

CommonJS规范(转)

时间:2014-05-30 11:10:16      阅读:337      评论:0      收藏:0      [点我收藏+]

标签:c   style   class   blog   code   java   

 

概述

CommonJS是服务器端模块的规范,Node.js采用了这个规范。

根据CommonJS规范,一个单独的文件就是一个模块。加载模块使用require方法,该方法读取一个文件并执行,最后返回文件内部的exports对象。下面就是一个简单的模块文件example.js。

bubuko.com,布布扣
console.log("evaluating example.js");
var invisible = function () {
  console.log("invisible");
}
exports.message = "hi";
exports.say = function () {
  console.log(message);
}
bubuko.com,布布扣

使用require方法,加载example.js。

bubuko.com,布布扣
var example = require(‘./example.js‘);
bubuko.com,布布扣

这时,变量example就对应模块中的exports对象,于是就可以通过这个变量,使用模块提供的各个方法。

bubuko.com,布布扣
{
  message: "hi",
  say: [Function]
}
bubuko.com,布布扣

require方法默认读取js文件,所以可以省略js后缀名。

var example = require(‘./example‘);

js文件名前面需要加上路径,可以是相对路径(相对于使用require方法的文件),也可以是绝对路径。如果省略路径,node.js会认为,你 要加载一个核心模块,或者已经安装在本地 node_modules 目录中的模块。如果加载的是一个目录,node.js会首先寻找该目录中的 package.json 文件,加载该文件 main 属性提到的模块,否则就寻找该目录下的 index.js 文件。看一个复杂一点的例子。

bubuko.com,布布扣
// foobar.js
function foobar(){
        this.foo = function(){
                console.log(‘Hello foo‘);
        }

        this.bar = function(){
                console.log(‘Hello bar‘);
        }
} 
exports.foobar = foobar;
bubuko.com,布布扣

调用该模块的方法如下:

bubuko.com,布布扣
var foobar = require(‘./foobar‘).foobar, test = new foobar(); 
test.bar(); // ‘Hello bar‘
bubuko.com,布布扣

有时,不需要exports返回一个对象,只需要它返回一个函数。这时,就要写成module.exports。

bubuko.com,布布扣
module.exports = function () {
  console.log("hello world")
}
bubuko.com,布布扣

AMD规范与CommonJS规范的兼容性

CommonJS规范加载模块是同步的,也就是说,只有加载完成,才能执行后面的操作。AMD规范则是非同步加载模块,允许指定回调函数。由于 Node.js主要用于服务器编程,模块文件一般都已经存在于本地硬盘,所以加载起来比较快,不用考虑非同步加载的方式,所以CommonJS规范比较适 用。但是,如果是浏览器环境,要从服务器端加载模块,这时就必须采用非同步模式,因此浏览器端一般采用AMD规范。

AMD规范使用define方法定义模块,下面就是一个例子:

bubuko.com,布布扣
define([‘package/lib‘], function(lib){ 
    function foo(){
        lib.log(‘hello world!‘);
    }  
    return {
        foo: foo
    };
});
bubuko.com,布布扣

AMD规范允许输出的模块兼容CommonJS规范,这时define方法需要写成下面这样:

bubuko.com,布布扣
define(function (require, exports, module){
    var someModule = require("someModule");
    var anotherModule = require("anotherModule");    

    someModule.doTehAwesome();
    anotherModule.doMoarAwesome();

    exports.asplode = function (){
        someModule.doTehAwesome();
        anotherModule.doMoarAwesome();
    };
});
bubuko.com,布布扣

参考链接

Addy Osmani, Writing Modular JavaScript With AMD, CommonJS & ES Harmony

转载自:http://javascript.ruanyifeng.com/nodejs/commonjs.html#toc0

 

CommonJS规范(转),布布扣,bubuko.com

CommonJS规范(转)

标签:c   style   class   blog   code   java   

原文地址:http://www.cnblogs.com/JoannaQ/p/3756295.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!