AMD有你还不知道的吗?

前言

本文是源仓库里的AMD文档的一份拷贝,放在这里是用来维护历史链接。文中任何与源仓库里的文档不一致之处,以源仓库里的文档为准。

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

此AMD与科技公司AMD及其制造的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"

如果AMD的实现加载器插件(Loader-Plugins), 则"!"符号用于分隔加载器插件模块名和插件资源名。由于插件资源名可以非常*地命名,大多数字符都允许在插件资源名使用。

(译注: 关于Loader-Plugins)

依赖

  • 第二个参数, dependdencies是个定义中模块所依赖模块的数组。依赖模块必须根据模块的工厂方法优先级执行,并且执行的结果应该按照依赖数组中的位置顺序以参数的形式传入(定义中模块的)工厂方法中。
    依赖的模块名如果是相对的,应该解析为相对定义中的模块。换句话来说,相对名解析为相对于模块的名字,并非相对于寻找该模块的名字的路径。

  • 本规范定义了三种特殊的依赖关键字。如果"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, 表明实现只遵循该版本的编程接口。

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


  1. define.amd = {

  2. multiversion: true

  3. }复制代码

最简单的定义:

    define.amd = {}复制代码

一次输出多个模块

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

上一篇:AMD电脑只显示部分内存解决方法


下一篇:高性能计算助力减碳 AMD以创新践行绿色