RequireJS 学习心得（全面）

RequireJS是一个非常小巧的JavaScript模块载入框架，是AMD规范最好的实现者之一

一、为什么要使用RequireJS

1、防止js加载阻塞页面渲染；

2、使用程序调用的方式加载js模块，防止出现大量的<script type="text/javascript" src="xxx"></script>；

3、优化前端结构，缩减代码，减少代码之间的强耦合，便于后期维护；

4、requireJS定义模块可以保证其定义的变量处于某个范围内，从而避免了全局命名污染。

二、RequireJS（AMD）与SeaJS（CMD）的区别：「尽早执行」 「按需执行」

       1、RequireJS在加载js时，便会载入文件中的所有模块，在使用js中的函数方法是，就不需要再等待；

       2、SeaJS在加载js时，不会立即载入文件中的模块，但需要使用到js中的某个模块方法时，才会去加载，这样就会造成操作时等待

不过有利也有弊，尽早执行依赖通常可以带来更好的用户体验，但是也容易产生浪费，举一个不太恰当的例子：Chrome 和 Firefox 为了更好的体验，对于某些类型的文件，点击下载地址后会询问是否保存，这时候实际上已经开始了下载。有时候等了很久才点确认，会开心地发现文件已经下好；如果点取消，浏览器会取消下载，已下载的部分就浪费了。

三、RequireJS的使用

       1、基本API

require会定义三个变量：define,require,requirejs，其中require === requirejs，一般使用require更简短

define 从名字就可以看出这个api是用来定义一个模块

require 加载依赖模块，并执行加载完后的回调函数

例如：

define(function(){

    function fun1(){

      alert("it works");

    }

 

    fun1();

})

通过define函数定义了一个模块，然后再页面中使用： require(["js/a"]);（注意require中的依赖是一个数组，即使只有一个依赖，你也必须使用数组来定义） 来加载该模块，require API的第二个参数是callback，一个function，是用来处理加载完毕后的逻辑

例如：

require(["js/a"],function(){

alert("load finished");

})

2、加载文件

上面的例子中加载模块都是本地js，但是大部分情况下网页需要加载的JS可能来自本地服务器、其他网站或CDN，这样就不能通过这种方式来加载了，我们以加载一个jquery库为例：

require.config({

    paths : {

        "jquery" : ["http://www.api.workec.com/scripts/ jquery]  

    }

})

require(["jquery","js/a"],function($){

    $(function(){

        alert("load finished"); 

    })

})

这边涉及了require.config，require.config是用来配置模块加载位置，简单点说就是给模块起一个更短更好记的名字，比如将api域名下的jquery库地址标记为jquery，这样在require时只需要写["jquery"]就可以加载该js，本地的js我们也可以这样配置：

require.config({

    paths : {

        "jquery" : ["http://www.api.workec.com/scripts/ jquery "],

        "a" : "js/a"  

    }

})

require(["jquery","a"],function($){

    $(function(){

        alert("load finished"); 

    })

})

通过paths的配置会使我们的模块名字更精炼，paths还有一个重要的功能，就是可以配置多个路径，如果远程cdn库没有加载成功，可以加载本地的库，如：

require.config({

paths : {

        "jquery" : ["http://www.api.workec.com/scripts/ jquery ", "js/jquery"],

               "a" : "js/a"  

           }

})

require(["jquery","a"],function($){

    $(function(){

        alert("load finished"); 

    })

})

这样配置后，当api域名下的jquery没有加载成功后，会加载本地js目录下的jquery

上面例子中的callback函数中发现有$参数，这个就是依赖的jquery模块的输出变量，如果你依赖多个模块，可以依次写入多个参数来使用：

require(["jquery","underscore"],function($, _){

    $(function(){

        _.each([1,2,3],alert);

    })

})

如果某个模块不输出变量值，则没有，所以尽量将输出的模块写在前面，防止位置错乱引发误解

3、全局配置

上面的例子中重复出现了require.config配置，如果每个页面中都加入配置，必然显得十分不雅，requirejs提供了一种叫"主数据"的功能，我们首先创建一个main.js：

require.config({

       //默认情况下模块所在目录为../js/

baseUrl : "../js/"

/*paths参数，用来映射模块别名。可以配置为一个数组，顺序映射。当前面的路径没有成功载入时可接着使用后面的路径。如下*/

paths : {

        "jquery" : ["http://www.api.workec.com/scripts/ jquery ", "js/jquery"],

        "a" : "js/a"  

}

})

在页面中使用下面的方式来使用requirejs：

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

加载requirejs脚本的script标签加入了data-main属性，这个属性指定的js将在加载完reuqire.js后处理，我们把require.config的配置加入到data-main后，就可以使每一个页面都使用这个配置，然后页面中就可以直接使用require来加载所有的短模块名

data-main还有一个重要的功能，当script标签指定data-main属性时，require会默认的将data-main指定的js为根路径，是什么意思呢？如上面的data-main="js/main"设定后，我们在使用require(['jquery'])后(不配置jquery的paths)，require会自动加载js/jquery.js这个文件，而不是jquery.js，相当于默认配置了

以上是符合AMD规范的模块路径配置，如果是非AMD模块输出的js插件，我们又该怎样配置呢？

通过require加载的模块一般都需要符合AMD规范即使用define来申明模块，但是部分时候需要加载非AMD规范的js，这时候就需要用到另一个功能：shim，shim解释起来也比较难理解，shim直接翻译为"垫"，其实也是有这层意思的，将非标准的AMD模块"垫"成可用的模块。

（1）exports值（输出的变量名），表明这个模块外部调用时的名称；

（2）deps数组，表明该模块的依赖性。

例如：在老版本的jquery中，是没有继承AMD规范的，所以不能直接require["jquery"]，这时候就需要shim，比如我要是用underscore类库，但是他并没有实现AMD规范，那我们可以这样配置：

require.config({

shim: {

"underscore" : {

                   exports : "_";

}

}

})

这样配置后，我们就可以在其他模块中引用underscore模块：

require(["underscore"], function(_){

    _.each([1,2,3], alert);

})

我们经常用到的jquery插件，基本都不符合AMD规范，比如jquery.form插件，这时候就需要将form插件"垫"到jquery中：

require.config({

    shim: {

        "jquery.form" : {

            deps : ["jquery"]

        }

    }

})

也可以简写为：

require.config({

    shim: {

        "jquery.form" : ["jquery"]

 }

})

这样配置之后我们就可以使用加载插件后的jquery了

require.config(["jquery", "jquery.form"], function($){

    $(function(){

        $("#form").ajaxSubmit({...});

    })

})

4、模块编写

define(["../js/jquery"],function(){

    return {

        func1 : function(){

            alert($('a').eq(0).attr('href'));

        },

        func2 : function(){

            alert($('a').eq(1).attr('href'));

        },

              Value1: 'Hello world',

                     func3: function(){

                    alert($('a').eq(2).attr('href'));

               }

            }

});

如上示例，define([xxx],function(){})也是可以直接在模块中添加依赖的js文件，不需要.js后缀，添加依赖后，可以直接在模块中使用依赖里面的函数，方法或值，把return定义为一个对象，里面便可以放置多个键值对，当然，也可以rerurn单个function或value