JS 模块化编程 require.js 的用法

什么是RequireJS?

RequireJS 是一个JavaScript模块加载器。它很是适合在浏览器中使用, 但它也能够用在其余脚本环境, 就像 Rhino and Node. 使用RequireJS加载模块化脚本将提升代码的加载速度和质量。html

为何用RequireJS?

  1. 异步“加载”。咱们知道,一般网站都会把script脚本的放在html的最后,这样就能够避免浏览器执行js带来的页面阻塞。使用RequireJS,会在相关的js加载后执行回调函数,这个过程是异步的,因此它不会阻塞页面。jquery

  2. 按需加载。经过RequireJS,你能够在须要加载js逻辑的时候再加载对应 的js模块,这样避免了在初始化网页的时候发生大量的请求和数据传输,或许对于一些人来讲,某些模块可能他根本就不须要,那就显得没有必要。数组

  3. 更加方便的模块依赖管理。相信你曾经必定遇到过由于script标签顺序问题而致使依赖关系发生错误,这个函数未定义,那个变量undefine之类的。经过RequireJS的机制,你能确保在全部的依赖模块都加载之后再执行相关的文件,因此能够起到依赖管理的做用。浏览器

  4. 更加高效的版本管理。想想,若是你仍是用的script脚本引入的方式来引入一个jQuery2.x的文件,而后你有100个页面都是这么引用的,那当你想换成jQuery3.x,那你就不得不去改这100个页面。可是若是你的requireJS有在config中作jQuery的path映射,那你只须要改一处地方便可。异步

  5. 固然还有一些诸如cdn加载不到js文件,能够请求本地文件等其它的优势,这里就不一一列举了。模块化

require.js的加载

使用require.js的第一步,是先去官方网站下载最新版本。
下载后,假定把它放在js子目录下面,就能够加载了。函数

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

加载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。ui

主模块的写法

上一节的main.js,我把它称为"主模块",意思是整个网页的入口代码。它有点像C语言的main()函数,全部代码都从这儿开始运行。
下面就来看,怎么写main.js。插件

// 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
});

模块的加载

上一节最后的示例中,主模块的依赖模块是['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"
    }
  });

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'
    }
  }

做者:wuqke
连接:http://www.jianshu.com/p/b8a6...來源:简书著做权归做者全部。商业转载请联系做者得到受权,非商业转载请注明出处。

相关文章
相关标签/搜索