require.js 的使用

时间:2024-01-17 09:24:08

一、为什么要用require.js

  在同一个页面要加载多个js文件时,浏览器会停止网页渲染,加载文件越多,网页失去响应的时间就会越长;

其次,由于js文件之间存在依赖关系,因此必须严格保证加载顺序(比如上例的1.js要在2.js的前面),依赖性最大的模块一定要放到最后加载,

当依赖关系很复杂的时候,代码的编写和维护都会变得困难。

例如:

      <script src="1.js"></script>
       <script src="2.js"></script>
       <script src="3.js"></script>
       <script src="4.js"></script>
       <script src="5.js"></script>
       <script src="6.js"></script>

require.js的诞生,就是为了解决这两个问题:     

      (1)实现js文件的异步加载,避免网页失去响应;

      (2)管理模块之间的依赖性,便于代码的编写和维护。

二、require.js的用法

  1、加载这个文件,也可能造成网页失去响应。解决办法有两个,一个是把它放在网页底部加载,另一个是写成下面这样:

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

    IE不支持这个属性,只支持defer,所以把defer也写上。

  2、加载自己的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。

三、主模块的写法

  1、我把main.js称为"主模块"  如果主模块依赖其他模块  这时就要使用AMD规范定义的的require()函数。

      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,然后再运行回调函数。主模块的代码就写在回调函数中。

四、模块的加载

如果各个模块不在同一目录下  使用 使用require.config()方法

例如: 如果这些模块在其他目录,比如js/lib目录

     1. require.config({

          paths: {

            "jquery": "lib/jquery.min",
            "underscore": "lib/underscore.min",
            "backbone": "lib/backbone.min"

          }

        });

2.另一种则是直接改变基目录(baseUrl)

    require.config({

        baseUrl: "js/lib",

        paths: {

          "jquery": "jquery.min",
          "underscore": "underscore.min",
          "backbone": "backbone.min"

        }

      });

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

    require.config({

        paths: {

          "jquery": "https://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min"

        }

      );

main.js 的完整写法

require.config({
    baseUrl: "js/lib",
    paths: {
      "jquery": "jquery.min",
      "underscore": "underscore.min",
      "backbone": "backbone.min"
    }
  }); require(['jquery', 'underscore', 'backbone'], function (jquery, underscore, backbone){
//main.js 自己的代码
});

注意: require.js要求,每个模块是一个单独的js文件。这样的话,如果加载多个模块,就会发出多次HTTP请求,会影响网页的加载速度。

因此,require.js提供了一个优化工具,当模块部署完毕以后,可以用这个工具将多个模块合并在一个文件中,减少HTTP请求数。 采用AMD规范

五、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加载方法如下:

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

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

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

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