模块化工具require 学习笔记

拟墨画扇 提交于 2020-02-13 12:13:17
一:早就听说过模块化工具require.js的大名,之前也是由于自己的网页上引用了诸多的js,而且一堆的js引用放在那里,一个依赖另一个,导致我不敢随意改动各个js的位置,而且有时页面内容一多起来,js加载也使得本来的html内容出现响应延迟。因此,在网上查过后,便得知解决方法是使用AMD异步模块-require.js。
 
 
二:了解过require.js后,我们一般都知道它具有如下优点:
    1,防止js加载阻塞页面渲染,实现js文件的异步加载,避免网页失去响应;
    2,使用程序调用的方式加载js,防止出现如下丑陋不堪的一串引用,同时管理模块之间的依赖性,便于编写与维护;
         
        <script type="text/javascript" src="a.js"></script>
        <script type="text/javascript" src="b.js"></script>
        <script type="text/javascript" src="c.js"></script>
        <script type="text/javascript" src="d.js"></script>
        <script type="text/javascript" src="e.js"></script>
        <script type="text/javascript" src="f.js"></script>
        <script type="text/javascript" src="g.js"></script>
        <script type="text/javascript" src="h.js"></script>
        <script type="text/javascript" src="i.js"></script>
        <script type="text/javascript" src="j.js"></script>
 
三:先新建一个目录吧
hl-require/
│  filelist.txt
│  index.html
│  
└─js
    │  app.js
    │  jquery.js
    │  main.js
    │  require.js
    │  
    ├─app
    │      sub.js
    │      
    └─lib
            backbone.js
            canvas.js
            jquery.js
 
1,先去官网下载最新版require.js引入 
 
<script src="js/require.js"></script>

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

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

async属性表明这个文件需要异步加载,避免网页失去响应。IE不支持这个属性,只支持defer,所以把defer也写上。

2,加载完require.js后,下一步就是加载我们自己的代码了。假定我们自己的代码文件是main.js,也在js目录下。
<script src="js/require.js" data-main="js/main" defer async="true"></script>

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

 
3,主模块:上面的main.js,可以称之为“主模块”意思是整个网页的入口代码,所有代码从这里开始执行。
      那么,我们如何写main.js。(注意,这里将会有AMD的规范了。)
      
      如果,我们的main不依赖任何其他模块,那么可以直接写入js代码。
     
 //main.js
 console.log('hello require!');

  

     但是,如果仅仅这样来使用,我们就没必要使用require.js了。真正常见的情况是,主模块依赖于其他模块,这时就要使用AMD规范定义的的require()函数。
     
     格式为:
    
  
 // main.js
require(['moduleA', 'moduleB', 'moduleC'], function (moduleA, moduleB, moduleC){
    // some code here
});
 
   实际的例子:
   假定主模块依赖jquery、underscore和backbone这三个模块,main.js就可以这样写:
require(['jquery', 'underscore', 'backbone'], function ($, _, Backbone){
  // some code here
});

 

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

 

*****但是要注意的是,第一个参数以数组的写法,是默认情况下,里面的各个模块要和main模块在同一个目录,如果不是在同一个目录,可以用paths设置一下*****

4,模块的加载:

上一节最后的示例中,主模块的依赖模块是['jquery', 'underscore', 'backbone']。默认情况下,require.js假定这三个模块与main.js在同一个目录,文件名分别为 jquery.js,underscore.js和backbone.js,然后自动加载。

使用require.config()方法,我们可以对模块的加载行为进行自定义。require.config()就写在主模块(main.js)的头部。参数就是一个对象,这个对象的paths属性指定各个模块的加载路径。

这个对象的paths属性指定各个模块的加载路径。

 

上面的代码给出了三个模块的文件名,路径默认与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请求数。

上面尤其要注意添加baseUrl后的写法,baseUrl直接更改的是基目录,从根目录开始。js/lib

而如果没有使用baseUrl,则各个模块的地址是相对与主模块的地址的。

然后就开始加载调用

 

其中依赖的一个backbone模块是

 

最后我们在浏览器中看下index.html的效果

alert()的同时网页内容能显示,说明是异步加载。

 

 

 

 

5,AMD模块的写法:

   说完主模块  'main.js',接着我们来说说依赖的其他模块。

 

   require.js加载的模块,采用AMD规范。也就是说,模块必须按照AMD的规定来写。

   具体来说,就是模块必须采用特定的define()函数来定义。如果一个模块不依赖其他模块,那么可以直接定义在define()函数之中。

   假定现在有一个math.js文件,它定义了一个math模块。那么,math.js就要这样写:

假定现在有一个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文件。

 

6,加载非规范的模块

  

理论上,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'
   }
 }

 

 

 

 

 

易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!