js模块规范学习

作者: 小二子SAMA | 来源:发表于2018-06-14 14:25 被阅读0次

    3中规范:CommonJS、AMD、CMD

    1.CommonJS
    COmmonJS的模块定义分为三部分:
    {模块引用(require)}{模块定义(exports)}{模块标识(module)}
    require()用来引用外部模块
    exports()用来导出当前模块的方法或变量,唯一的导出口
    module对象就代表模块本身
    CommonJS主要用于Node,Node一个文件是一个模块,有自己的作用域,每个文件内定义的变量、方法、类都是私有变量。
    CommonJS规范规定,module变量代表当前模块,该变量是一个对象,他的exports属性(module.exports)是该模块对外的接口。
    加载某个模块的时候,加载的是该模块的module.exports属性。

    //example.js
    let x = 1;
    const addX = (value) => value + x;
    
    module.exports.x = x;
    module.exports.addX = addX;
    
    //main.js
    const example = require('./example.js');
    
    console.log(example.x);
    console.log(example.addX(10));
    

    CommonJS特点
    1.模块代码都运行在模块作用域,不会污染全局变量;
    2.模块可以多次加载,但是只在第一次加载的时候运行,产生缓存,以后再次加载都是读取第一次的运行缓存。如果想重新加载模块,需要清除缓存;
    所有的缓存存在于 require.cache中,如果想清除缓存,以如下操作
    //删除制定文件缓存
    delete require.cache[moduleName];
    //删除所有缓存
    Object.keys(require.cache).forEach(function(key) {
    delete require.cache[key];
    })
    3.模块加载顺序是按照其在代码中的出现的顺序。
    4.CommonJS加载模块是同步加载。

    详细说明:
    1.require:
    读入并执行一个js文件,并返回该模块的exports对象,如果没有该对象,会报错;如果要输出一个函数,则该函数要定义在moduel.exports上,而非exports上。
    理由见exports详细说明,如下。
    require常用函数说明
    2.exports:
    为了方便,每个模块都提供一个exports变量,相当于var exports = module.exports;
    可以直接向exports中添加属性,输出;但是不能将exports赋值,如 exports = x => { console.log(x); }
    这样切断了exports和module.exports之间的联系。使得exports无效。
    3.module:Node内部提供一个Module的构造函数,每个模块都是Module的实例。
    每个模块内部都有一个module对象,代表当前模块,拥有以下属性:

    module.id 模块的识别符,通常是带有绝对路径的模块文件名。
    module.filename 模块的文件名,带有绝对路径。
    module.loaded 返回一个布尔值,表示模块是否已经完成加载。
    module.parent 返回一个对象,表示调用该模块的模块。
    module.children 返回一个数组,表示该模块要用到的其他模块。
    module.exports 表示模块对外输出的值。
    

    2.AMD(asynchronous)异步模块定义 主要服务于前端js
    一般来讲,浏览器端需要从服务器加载模块,所以异步加载效率更好。AMD允许有回调函数。
    define()函数说明:

    define(id?, dependencies?, factory);
    

    参数解释:
    1.id:定义中模块的名字,可以是绝对路径也可以是相对路径;
    2.dependencies:定义中模块依赖模块的数组。默认是['require', 'exports', 'module'];
    3.factory:工厂方法,为模块初始化要执行的函数或对象。如果是函数,这个函数只执行一次;如果是对象,这个对象应该设置为模块的输出值。

    define(['package/lib'], function(lib){
      function foo(){
        lib.log('hello world!');
      }
    
      return {
        foo: foo
      };
    });
    
    define(function('require', 'exports', 'module'){
        var a = require('./a');
        var b = require('./b');
    
        exports.value = function () {
            a.doSomething();
            b.doSomething();
        }
    })
    

    3.CMD 通用模块定义
    AMD和CMD的区别:RequireJS 遵循 AMD(异步模块定义)规范,Sea.js 遵循 CMD (通用模块定义)规范。
    RequireJS 想成为浏览器端的模块加载器,同时也想成为 Rhino / Node 等环境的模块加载器。Sea.js 则专注于 Web 浏览器端,同时通过 Node 扩展的方式可以很方便跑在 Node 环境中。
    define()函数说明:

    define(id?, dependencies?, factory);
    

    函数说明与AMD相同。
    factory可以是一个对象、字符串或者是一个函数:
    1)当factory为一个对象或字符串的时候,说明接口就是这个对象或字符串
    2)当factory为一个函数的时候,默认有3个参数require、exports 和 module。

    备注:
    1.加载路径顺序
    requrie加载的文件后缀名默认是.js
    var a = require('./a');
    //等价于
    var a = require('./a.js');
    1)路径名以'/'开始,是绝对路径
    2)路径名以'./' 或'../'等开始,是相对路径
    如果模块 "a/b/c" 请求 "../d", 则解析为"a/d"
    如果模块 "a/b/c" 请求 "./e", 则解析为"a/b/e"
    3)路径名不以'/'、'./'、'../'开头,表示加载的是一个默认提供的核心模块(位于node的安装目录中)或者位于node_modules目录中已经安装的模块。
    eg:
    脚本/home/user/projects/foo.js执行了require('bar.js')命令,Node会依次搜索以下文件:

        /usr/local/lib/node/bar.js
        /home/user/projects/node_modules/bar.js
        /home/user/node_modules/bar.js
        /home/node_modules/bar.js
        /node_modules/bar.js
    
    1. 路径名不以“./“或”/“开头,而且是一个路径,比如require('example-module/path/to/file'),则将先找到example-module的位置,然后再以它为参数,找到后续路径。
      5)如果指定的模块文件没有发现,Node会尝试为文件名添加.js、.json、.node后,再去搜索。.js件会以文本格式的JavaScript脚本文件解析,.json文件会以JSON格式的文本文件解析,.node文件会以编译后的二进制文件解析。
      6)如果想得到require命令加载的确切文件名,使用require.resolve()方法。

    参考:
    1.CommonJS规范
    2.浅析JS终端模块规范
    3.AMD (中文版)
    4.CMD 模块定义规范

    相关文章

      网友评论

        本文标题:js模块规范学习

        本文链接:https://www.haomeiwen.com/subject/grlyeftx.html