CommonJS

本页使用了标题或全文手工转换,现处于中国大陆简体模式
求闻百科,共笔求闻

CommonJS是一个项目,其目标是为JavaScript网页浏览器之外创建模块约定。创建这个项目的主要原因是当时缺乏普遍可接受形式的JavaScript脚本模块单元,模块在与运行JavaScript脚本的常规网页浏览器所提供的不同的环境下可以重复使用。

历史

这个项目由Mozilla工程师Kevin Dangoor于2009年1月发起,最初名为ServerJS[1]。在2009年8月,这个项目被改名为“CommonJS”来展示其API的广泛的应用性[2]。有关规定在一个开放进程中被创建和认可,一个规定只有在已经被多个实现完成之后才被认为是最终的[3]。 CommonJS不隶属于致力于ECMAScriptEcma国际的工作组 TC39,但是TC39的一些成员参与了这个项目[4]

在2013年5月,Node.js包管理器npm的作者Isaac Z. Schlueter,宣布Node.js已经废弃了CommonJS,Node.js核心开发者应避免使用它[5]

规定

规定列表包括[6]

当前

  • Modules/1.0 (被Modules/1.1取代)
  • Modules/1.1
  • Modules/1.1.1
  • Packages/1.0
  • Promises/B
  • Promises/C
  • System/1.0

提议

  • Binary/B
  • Binary/F
  • Console
  • Encodings/A
  • Filesystem/A
  • Filesystem/A/0
  • Modules/Async/A
  • Modules/Transport/B
  • Packages/1.1
  • Packages/Mappings
  • Unit Testing/1.0

模块

require是一个函数,require函数接受一个模块标识符,require返回外部模块的导出的API。如果要求的模块不能被返回则require必须throw一个错误。在模块内,有一个自由变量require,它满足上述定义。在模块内,有一个自由变量叫做exports,它是一个对象,模块在执行时可以向其增加模块的API。模块必须使用exports对象作为唯一的导出方式。[7]

在模块中,必须有一个自由变量module,它是一个对象。module对象必须有一个id属性,它是这个模块的顶层id。id属性必须是这样的,require(module.id)会从源出module.id的那个模块返回exports对象。(就是说module.id可以被传递到另一个模块,而且在要求它时必须返回最初的模块)。[8]

样例代码

math.js
exports.add = function() {
    var sum = 0, i = 0, args = arguments, l = args.length;
    while (i < l) {
        sum += args[i++];
    }
    return sum;
};
increment.js
var add = require('math').add;
exports.increment = function(val) {
    return add(val, 1);
};
program.js
var inc = require('increment').increment;
var a = 1;
inc(a); // 2

module.id == "program";

实现

参见

引用

  1. What Server Side JavaScript needs - Blue Sky On Mars. [2019-05-17]. 
  2. CommonJS: JavaScript Standard Library. [2019-05-17]. 
  3. ProposalProcess - CommonJS Spec Wiki. [2019-05-17]. 
  4. CommonJS: the First Year - Blue Sky On Mars. [2019-05-17]. 
  5. Schlueter, Isaac Z. Forget CommonJS. It's dead. **We are server side JavaScript.**. GitHub. 25 Mar 2013 [2019-05-17]. 
  6. CommonJS Spec Wiki. [2019-05-17]. 
  7. Modules/1.0 .
  8. Modules/1.1.1 .
  9. Server-side JavaScript development and hosting - Akshell. [2020-09-25]. 
  10. olegp/common-node @ GitHub. [2019-05-17]. 
  11. - GitHub. [2019-05-17]. 
  12. DrBenton/CommonJSForPHP - GitHub. [2019-05-17]. 
  13. Implementations/CouchDB - CommonJS Spec Wiki. [2019-05-17]. 
  14. Flusspferd - CommonJS平台 | Javascript的C绑定. [2019-05-17]. 
  15. Implementations/GPSEE - CommonJS规范Wiki. [2019-05-17]. 
  16. Implementations/Smart - CommonJS Spec Wiki. [2019-05-17]. 
  17. Homepage - JSBuild. [2019-05-17]. 
  18. MongoDB. [2019-05-17]. 
  19. Implementations/Narwhal - CommonJS Spec Wiki. [2019-05-17]. 
  20. Implementations/node.js - CommonJS Spec Wiki. [2019-05-17]. 
  21. Implementations/Persevere - CommonJS Spec Wiki. [2019-05-17]. 
  22. pinf/loader-js - GitHub. [2019-05-17]. 
  23. Implementations/RingoJS - CommonJS Spec Wiki. [2019-05-17]. 
  24. SilkJS WWW Site. [2019-05-17]. 
  25. Implementations/SproutCore - CommonJS Spec Wiki. [2019-05-17]. 
  26. Implementations/TeaJS - CommonJS Spec Wiki. [2019-05-17]. 
  27. Wakanda. [2019-05-17]. 
  28. xuljet - XUL JavaScript Enhanced Toolkit - Google Project Hosting. 

外部链接