前端js模块化编写require.js

requirejs是一个JavaScript文件和模块加载器。requireJS容许你把你的javascript代码独立成文件和模块,同时管理每一个模块间的依赖关系。javascript

RequireJS的目标是鼓励代码的模块化,它使用了不一样于传统"script"标签的脚本加载步骤。使用RequireJS加载模块化脚本将提升代码的加载速度和质量。前端

1、为何要用require.js?

最先的时候,全部Javascript代码都写在一个文件里面,只要加载这一个文件就够了。后来,代码愈来愈多,一个文件不够了,必须分红多个文件,依次加载。下面的网页代码,相信不少人都见过:java

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

 

  • 这段代码依次加载多个js文件。jquery

  • 这样的写法有很大的缺点。json

    1. 首先,加载的时候,浏览器会中止网页渲染,加载文件越多,网页失去响应的时间就会越长
    2. 因为js文件之间存在依赖关系,所以必须严格保证加载顺序(好比上例的1.js要在2.js的前面),依赖性最大的模块必定要放到最后加载,当依赖关系很复杂的时候,代码的编写和维护都会变得困难。
  • require.js的诞生,就是为了解决这两个问题:数组

    1. 实现js文件的异步加载,避免网页失去响应;
    2. 管理模块之间的依赖性,便于代码的编写和维护。

2、require.js的加载

  1. 使用require.js的第一步,是先去官方网站下载最新版本。浏览器

  2. 下载后,假定把它放在js子目录下面,就能够加载了。
     
    <script src="js/require.js"></script>markdown

  3. 有人可能会想到,加载这个文件,也可能形成网页失去响应。解决办法有两个:app

    • 一个是把它放在网页底部加载,另外一个是写成下面这样:
        
      <script src="js/require.js" defer async="true" ></script>

    async属性代表这个文件须要异步加载,避免网页失去响应。IE不支持这个属性,只支持defer,因此把defer也写上。dom

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

3、主模块的写法

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

4、模块的加载

上一节最后的示例中,主模块的依赖模块是['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({
      baseUrl: "js/lib",
      paths: {"jquery": "jquery.min", "underscore": "underscore.min", "backbone": "backbone.min"}
      });

    • 另外一种则是直接改变基目录(baseUrl)。

      require.config({
          baseUrl: "js/lib",
          paths: {
              "jquery": "jquery.min",
              "underscore": "underscore.min",
              "backbone": "backbone.min"
          }
      });
  • 若是某个模块在另外一台主机上,也能够直接指定它的网址,好比:
     
    require.config({
       paths: {
         "jquery": "
    });

  • require.js要求:

    每一个模块是一个单独的js文件。这样的话,若是加载多个模块,就会发出屡次HTTP请求,会影响网页的加载速度。所以,require.js提供了一个优化工具,当模块部署完毕之后,能够用这个工具将多个模块合并在一个文件中,减小HTTP请求数。

5、AMD模块的写法

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

  2. 具体来讲,就是模块必须采用特定的define()函数来定义。若是一个模块不依赖其余模块,那么能够直接定义在define()函数之中。

  3. 假定如今有一个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));
     });

  4. 若是这个模块还依赖其余模块,那么define()函数的第一个参数,必须是一个数组,指明该模块的依赖性。
      
    define(['myLib'], function(myLib){
        function foo(){
          myLib.doSomething();
        }
        return {
          foo : foo
        };
      });

  5. 当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'
          }
        }

7、require.js插件

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

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

    require(['domready!'], function (doc) {
         // called once the DOM is ready
     });
  2. text和image插件,则是容许require.js加载文本和图片文件。
      
    define([
    'text!review.txt',
    'image!cat.jpg'
    ],

    function (review, cat) {
                 console.log(review);
                 document.body.appendChild(cat);
             }
     );
  3. 相似的插件还有json和mdown,用于加载json文件和markdown文件。

 

 

想学前端的小伙伴,能够关注+私信回复《资料》免费获取哦~

 

感谢您的阅读!喜欢的能够收藏转发哦~

相关文章
相关标签/搜索