程序员

require.js组件异步加载学习

参考来源

1.阮一峰 javascript模块化编程
2.require.js中文网

require.js介绍
  • 为什么要用require.js?

    最早的时候,所有Javascript代码都写在一个文件里面,只要加载这一个文件就够了。后来,代码越来越多,一个文件不够了,必须分成多个文件,依次加载。

详细就不说了,网上一大把的教程,这里主要记录下一些简单的demo必备知识点和原理

步骤
  1. 官网下载js/require.js,并放到目录中
  2. 担心加载此文件时,网页失去响应,两种方法
    • 第一个是把它放在网页底部加载
    • 第二个是把此文件改成异步加载
      
      //async属性表明这个文件需要异步加载,避免网页失去响应。IE不支持这个属性,只支持defer,所以把defer也写上。
  3. 加载require.js以后,下一步就要加载我们自己的代码了。假定我们自己的代码文件是main.js,也放在js目录下面。那么,只需要写成下面这样就行了:

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

我的文件目录

Paste_Image.png
  • requre 练习的demo文件夹
    • require_study.html 是页面
      • js文件夹
        • main.js 主程序
        • module1.js 模块1
        • module2.js 模块2
        • module3.js 模块3
        • require.js require框架
下面介绍模块的写法和加载步骤

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

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

demo实践

首先创建require的项目目录,并引入require.js

  • html文件引入
    
    
    
      
      require.js
    
    
    
    
    
  • main.js 主程序入口 调用三个模块返回对象的a的值,输入相乘的积
    require(['module1','module2','module3'],function(a,b,c){
      console.log(a.a * b.a * c.a);
    });
  • module1 模块1 依赖模块2,打印this is module1 返回对象 模块2返回对象a的值乘以2
    define(['module2'],function(e){
      console.log('this is module1');
      var a = e.a *2;
      return {
          a:a
      }
    });
  • module2 模块2 打印this is module2,返回对象
    define(function(){
      console.log('this is module2');
      return {
          a:2
      }
    });
  • module3 模块3 打印this is module3 返回对象
    define(function(){
      console.log('this is module3');
      return {
          a:3
      }
    });

    打开控制台,可以看到依次加载的模块

    Paste_Image.png

    和输出的值

    Paste_Image.png
模块的加载

上面的示例中,主模块的依赖模块是[‘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请求数。

模块加载demo实践:

  1. 在JS文件夹中创建lib文件夹,把module的几个模块转移过去.

    Paste_Image.png


    这样,就无法访问,module
    的几个模块了,浏览器虽然加载,但是报错,文件没有被找到ERR_FILE_NOT_FOUND

Paste_Image.png

然后我们在main.js主程序中最上部,加入路径设置:

require.config({
    paths:{
        "module1":"lib/module1",
        "module2":"lib/module2",
        "module3":"lib/module3",
    }
});

Paste_Image.png

浏览器就可以正常加载文件了!

Paste_Image.png

如果lib文件夹不在js文件夹下面呢?

像这样,和JS平行

Paste_Image.png

我们可以修改路径../ 就好了

require.config({
    paths:{
        "module1":"../lib/module1",
        "module2":"../lib/module2",
        "module3":"../lib/module3",
    }
});
require(['module1','module2','module3'],function(a,b,c){
    console.log(a.a * b.a * c.a);
});

最后,引入外部文件,如jquery:
tip:文件网址,记得去掉最后的.js

require.config({
    paths:{
        "module1":"../lib/module1",
        "module2":"../lib/module2",
        "module3":"../lib/module3",
        "jquery":"http://cdn.bootcss.com/jquery/3.1.0/jquery.min",
    }
});
require(['module1','module2','module3','jquery'],function(a,b,c){
    console.log(a.a * b.a * c.a);
});

jquery 就会被引入进来了

Paste_Image.png
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'
    }
  }
require.js插件

require.js还提供一系列插件,实现一些特定的功能。

domready插件,可以让回调函数在页面DOM结构加载完成后再运行。

  require(['domready!'], function (doc){
    // called once the DOM is ready
  });

text和image插件,则是允许require.js加载文本和图片文件。

 define([
    'text!review.txt',
    'image!cat.jpg'
    ],
    function(review,cat){
      console.log(review);
      document.body.appendChild(cat);
    }
  );

类似的插件还有json和mdown,用于加载json文件和markdown文件。