AMD（中文版）

• 原文地址: github.com/amdjs/amdjs…)
• 原文做者: James Burke

前言

本文是源仓库里的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, 代表实现只遵循该版本的编程接口。

一个若是定义同一个环境中容许屡次加载同一个版本的模块的实现:

define.amd = {
        multiversion: true
    }复制代码

最简单的定义:

define.amd = {}复制代码

一次输出多个模块

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

例子

使用require和exports

建立一个名为"alpha"的模块，使用了require, exports和名为"beta"的模块:

define("alpha", ["require", "exports", "module"], function (require, exports, beta) {
        exports.verb = function () {
            return beta.verb()
            // Or:
            return requre("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, exports, module) {
    var a = require("a")
        b = require("b")

    exports.action = function () {}    
})复制代码

全局变量

本规范保留全局变量"define"以用来实现本规范。包额外信息异步定义编程接口是未未来的CommonJS API保留的。模块加载器不该在此函数添加额外的方法或属性。

本规范保留全局变量"require"被模块加载器使用。模块加载器能够在合适的状况下自由地使用该全局变量。它可使用这个变量或添加任何属性以完成模块加载器的特定功能。它一样也能够选择彻底不使用"require"。

使用注意

为了使静态分析工具(若是build工具)能够正常工做，推荐使用字面上形如的"define(...)"。

与CommonJS的关系

一个关于本API的wiki开始在CommonJS wiki中建立了，做为中转的格式，模块中转。可是为了包含模块定义接口，随着时间而不断改变。在CommonJS列表中关于推荐本API做为模块定义API还没有达成一致。本API被转移到它本身的wiki和讨论组中。

AMD能够做为CommonJS模块一个中转的版本只要CommonJS没有被用来同步的require调用。使用同步require调用的CommonJS代码能够被转换为使用回调风格的AMD模块加载器。

感言

本人只是一个搬运工, 若有不符之处请指出，写博客的做用只是为了复习基础(好记性不如烂笔头)。这是写的第一篇博文，后续会有各类基础的博文，若是有需求的能够关注。

(不符之处请发邮箱: unknown_xxx@163.com, 会进行修改，谢谢。)