AMD(Asynchronous Module Definition)

前端之家收集整理的这篇文章主要介绍了AMD(Asynchronous Module Definition)前端之家小编觉得挺不错的,现在分享给大家,也给大家做个参考。

异步模块定义规范(AMD)制定了定义模块的规则,这样模块和模块的依赖可以被异步加载。这和浏览器的异步加载模块的环境刚好适应(浏览器同步加载模块会导致性能、可用性、调试和跨域访问等问题)。

API说明

define()函数

本规范只定义了一个函数“define”,它是全局变量函数的描述为:

define(id?,dependencies?,factory);

ID

名字

第一个参数,ID,是个字符串。它指定的是定义中模块的名字,这个参数是可选的。如果没有提供该参数,模块的名字应该是默认为模块加载器请求的指定脚本的名字。如果提供了该参数,模块名必须是“顶级”的和“绝对”的(不允许相对名字)。

模块名的格式

模块名用来唯一标识定义中的模块,它们同样在依赖数据中使用。AMD的模块名规范是CommonJs模块名规范的超集。引用如下:

  • 模块名是由一个或多个单词以正斜杠为分隔符拼接成的字符串
  • 单词必须为驼峰形式,或者“.”,“..”
  • 模块名不允许文件扩展名的形式,如".js”
  • 模块名可以为“相对的”或“顶级的”。如果首字符为“.”或“..”则为“相对的”模块名
  • 顶级的模块名从根命名空间的概念模块解析
  • 相对的模块名从“require”书写和调用的模块解析

上文引用的CommonJs模块ID属性常被用于JavaScript模块。

相对模块名解析示例:

  • 如果模块“a/b/c”请求“../d”,则解析为“a/d”
  • 如果模块“a/b/c”请求“./e”,则解析为“a/b/e”

依赖

第二个参数,dependencies,是个定义中模块所依赖模块的数组。依赖模块必须根据模块的工厂方法优先级执行,并且执行的结果应该按照依赖数据中的位置顺序以参数的形式传入(定义中模块的)工厂方法中。

依赖的模块名如果是相对的,应该解析为相对定义中的模块。换句话来说,相对名解析为相对于模块的名字,并非相对于寻找该模块的名字的路径。

本规范定义了三个特殊的关键字。如果“require”,“exports”,或是“module”出现在依赖列表中,参数应该按照commonJs模块规范自由变量去解析。

依赖参数是可选的。如果忽略此参数,它应该默认为["require","exports",""module"],然而,如果工厂方法的参数个数小于3,加载器会选择以函数指定的参数个数调用工厂方法


工厂方法

第三个参数,factory,为模块初始化要执行的函数或是对象。如果为函数,它应该只被执行一次。如果是对象,此对象应该为模块的输出值。

如果工厂方法返回一个值(对象,函数或是任意强制类型转换为true的值),应该为设置为模块的输出值。

简单的commonJs转换

如果依赖性参数被忽略,模块加载器可以选择扫描工厂方法中的require语句以获得依赖性(字面量形为require("module-id"))。第一个参数必须字面量为require从而使此机制正常工作。

在某些情况下,因为脚本大小的限制或函数不支持toString方法(Opera Mobile是已知的不支持函数的toString方法),模块加载器可以选择扫描不扫描依赖性。

如果有依赖参数,模块加载器不应该在工厂方法中扫描依赖性。

define.amd 属性

为了清晰的标识全局函数(为浏览器加载script必须的)遵从AMD编程接口,任何全局函数应该有一个"amd"的属性,它的值为一个对象。这样可以防止与现有的定义了define函数但不遵从AMD编程接口的代码相冲突。

当前,define.amd对象的属性没有包含在本规范中。实现本规范的作者,可以用它通知超出本规范编程接口基本实现的额外能力。

define.amd的存在表明函数遵循本规范。如果有另外一个版本的编程接口,那么应该定义另外一个属性,如define.amd2,表明实现只遵循该版本的编程接口。

一个如何定义同一个环境中允许多次加载同一个版本的模块的实现:

define.amd = {
multiversion: true
};

最短的定义:

define.amd = {};

一次输出多个模块

在一个脚本中可以使用多次define调用。这些define调用的顺序不应该是重要的。早一些的模块定义中所指定的依赖,可以在同一脚本中晚一些定义。模块加载器负责延迟加载未解决的依赖,直到全部脚本加载完毕,防止没必要的请求。

例子

使用require和exports

创建一个名为“alpha”的模块,使用率require,exports,和名为“beta”的模块:

define("alpha",["require","beta"],function (require,exports,beta) {
exports.verb = function() {
return beta.verb();
//Or:
return require("beta").verb();
}
});

一个返回对象的匿名模块:

define(["alpha"],function (alpha) {
return {
verb: function(){
return alpha.verb() + 2;
}
};
});

一个没有依赖性的模块可以直接定义对象:

define({
add: function(x,y){
return x + y;
}
});

一个使用了简单CommonJS转换的模块定义:

define(function (require,module) { var a = require('a'),b = require('b'); exports.action = function () {}; });

原文链接:https://www.f2er.com/dojo/291045.html

猜你在找的Dojo相关文章