Require.js学习笔记

本文核心转载自阮一峰Require.js

感觉前端的路越来越“规范”，一套套的“章程”也越来越被大大小小的公司遵循，犹如“东施效颦”一般。我想，这些应该是“被需要的”吧！但是，不管如何，时间的车轮滚滚向前，原地踏步终究是会被淹没的。还是那句话，学无止境。加油吧！

随着网页中JavaScript代码越来越复杂，一个庞大的网站需要加载的js文件数量越来越多，前端开发团队越来越大，这种协同开发的模式下，JS代码的管理就变得尤为重要了，Common.js的诞生让我们看到了方向，进而Require.js的诞生就成了必然。Common.js囊括了服务端和浏览器端，而Require.js则是专注于浏览器端，对于前端开发人员来说，Require.js无疑是更好的选择。

Require.js遵循AMD规范（Asynchronous Module Definition：异步模块定义），它采用异步方式加载模块，模块的加载不影响它后面语句的运行。所有依赖这个模块的语句，都定义在一个回调函数中，等到加载完成之后，这个回调函数才会运行。

AMD规范的内容：

1. 用全局函数define来定义模块，用法为：define(id?, dependencies?, factory);
2. id为模块标识，遵从CommonJS Module Identifiers规范
3. dependencies为依赖的模块数组，在factory中需传入形参与之一一对应
4. 如果dependencies的值中有”require”、”exports”或”module”，则与commonjs中的实现保持一致
5. 如果dependencies省略不写，则默认为[“require”, “exports”, “module”]，factory中也会默认传入require,exports,module
6. 如果factory为函数，模块对外暴漏API的方法有三种：return任意类型的数据、exports.xxx=xxx、module.exports=xxx
7. 如果factory为对象，则该对象即为模块的返回值

Require.js作用：

（1）实现 JS 文件的异步加载，避免网页失去响应；
（2）管理模块之间的依赖性，便于代码的编写和维护。

如何使用Require.js：

第一步当然是 下载 Require.js 源文件引入进HTML文档中：

下载之后，假设将它放在js 的子目录文件夹中：

<script src="js/require.js"></script>

有人可能会想到，加载这个文件，也可能造成网页失去响应。解决办法有两个，一个是把它放在网页底部加载，另一个是写成下面这样：

<script src="js/require.js" defer async="true" ></script>

async属性表明这个文件需要异步加载，避免网页失去响应。IE不支持这个属性，只支持defer，所以把defer也写上。
加载require.js以后，下一步就要加载我们自己的代码了。假定我们自己的代码文件是main.js，也放在js目录下面。那么，只需要写成下面这样就行了：

<script src="js/require.js" data-main="js/main"></script>

data-main属性的作用是，指定网页程序的主模块。在上例中，就是js目录下面的main.js，这个文件会第一个被require.js加载。由于require.js默认的文件后缀名是js，所以可以把main.js简写成main。

主模块的写法

上面的main.js，我把它称为”主模块”，意思是整个网页的入口代码。它有点像C语言的main()函数，所有代码都从这儿开始运行。
下面就来看，怎么写main.js。
如果我们的代码不依赖任何其他模块，那么可以直接写入javascript代码。

main.js：

　// main.js　　alert("加载成功！");

但这样的话，就没必要使用require.js了。真正常见的情况是，主模块依赖于其他模块，这时就要使用AMD规范定义的的require()函数。

　// main.js　　require(['moduleA', 'moduleB', 'moduleC'], function (moduleA, moduleB, moduleC){　　　　// some code here　　});

require()函数接受两个参数。第一个参数是一个数组，表示所依赖的模块，上例就是[‘moduleA’, ‘moduleB’, ‘moduleC’]，即主模块依赖这三个模块；第二个参数是一个回调函数，当前面指定的模块都加载成功后，它将被调用。加载的模块会以参数形式传入该函数，从而在回调函数内部就可以使用这些模块。
require()异步加载moduleA，moduleB和moduleC，浏览器不会失去响应；它指定的回调函数，只有前面的模块都加载成功后，才会运行，解决了依赖性的问题。
下面，我们看一个实际的例子。
假定主模块依赖jquery、underscore和backbone这三个模块，main.js就可以这样写：

require(['jquery', 'underscore', 'backbone'], function ($, _, Backbone){　　　　// some code here　　});

require.js会先加载jQuery、underscore和backbone，然后再运行回调函数。主模块的代码就写在回调函数中。

模块的加载

上面的示例中，主模块的依赖模块是[‘jquery’, ‘underscore’, ‘backbone’]。默认情况下，require.js假定这三个模块与main.js在同一个目录，文件名分别为jquery.js，underscore.js和backbone.js，然后自动加载。
使用require.config()方法，我们可以对模块的加载行为进行自定义。require.config()就写在主模块（main.js）的头部。参数就是一个对象，这个对象的paths属性指定各个模块的加载路径。

require.config({　　　　paths: {　　　　　　"jquery": "jquery.min",　　　　　　"underscore": "underscore.min",　　　　　　"backbone": "backbone.min"　　　　}　　});

上面的代码给出了三个模块的文件名，路径默认与main.js在同一个目录（js子目录）。如果这些模块在其他目录，比如js/lib目录，则有两种写法。一种是逐一指定路径。

require.config({　　　　paths: {　　　　　　"jquery": "lib/jquery.min",　　　　　　"underscore": "lib/underscore.min",　　　　　　"backbone": "lib/backbone.min"　　　　}　　});

另一种则是直接改变基目录（baseUrl）。

require.config({　　　　baseUrl: "js/lib",　　　　paths: {　　　　　　"jquery": "jquery.min",　　　　　　"underscore": "underscore.min",　　　　　　"backbone": "backbone.min"　　　　}　　});

如果某个模块在另一台主机上，也可以直接指定它的网址，比如：

require.config({　　　　paths: {　　　　　　"jquery": "https://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min"　　　　}　　});

require.js要求，每个模块是一个单独的js文件。这样的话，如果加载多个模块，就会发出多次HTTP请求，会影响网页的加载速度。因此，require.js提供了一个优化工具，当模块部署完毕以后，可以用这个工具将多个模块合并在一个文件中，减少HTTP请求数。

AMD模块的写法

require.js加载的模块，采用AMD规范。也就是说，模块必须按照AMD的规定来写。
具体来说，就是模块必须采用特定的define()函数来定义。如果一个模块不依赖其他模块，那么可以直接定义在define()函数之中。
假定现在有一个math.js文件，它定义了一个math模块。那么，math.js就要这样写：

// math.js　　define(function (){　　　　var add = function (x,y){　　　　　　return x+y;　　　　};　　　　return {　　　　　　add: add　　　　};　　});

加载方法如下：

// main.js　　require(['math'], function (math){　　　　alert(math.add(1,1));　　});

如果这个模块还依赖其他模块，那么define()函数的第一个参数，必须是一个数组，指明该模块的依赖性。

define(['myLib'], function(myLib){　　　　function foo(){　　　　　　myLib.doSomething();　　　　}　　　　return {　　　　　　foo : foo　　　　};　　});

当require()函数加载上面这个模块的时候，就会先加载myLib.js文件。

加载非规范的模块

理论上，require.js加载的模块，必须是按照AMD规范、用define()函数定义的模块。但是实际上，虽然已经有一部分流行的函数库（比如jQuery）符合AMD规范，更多的库并不符合。那么，require.js是否能够加载非规范的模块呢？
回答是可以的。
这样的模块在用require()加载之前，要先用require.config()方法，定义它们的一些特征。
举例来说，underscore和backbone这两个库，都没有采用AMD规范编写。如果要加载它们的话，必须先定义它们的特征。

require.config({　　　　shim: {　　　　　　'underscore':{　　　　　　　　exports: '_'　　　　　　},　　　　　　'backbone': {　　　　　　　　deps: ['underscore', 'jquery'],　　　　　　　　exports: 'Backbone'　　　　　　}　　　　}　　});

require.config()接受一个配置对象，这个对象除了有前面说过的paths属性之外，还有一个shim属性，专门用来配置不兼容的模块。具体来说，每个模块要定义（1）exports值（输出的变量名），表明这个模块外部调用时的名称；（2）deps数组，表明该模块的依赖性。
比如，jQuery的插件可以这样定义：

shim: {　　　　'jquery.scroll': {　　　　　　deps: ['jquery'],　　　　　　exports: 'jQuery.fn.scroll'　　　　}　　}

——————————-本文仅为自己学习笔记所用，无任何其他用途。