requirejs初体验

1.初识

因为工作的需要,现在开始使用requirejs来做前端模块的管理开发。在这之前都没有使用过这类工具的我,看到这个很懵逼啊有木有。但是没办法,还是要啃下来。
在真的开发之前,先看requirejs官网。竟然是英文的,没办法,勉强看。
我们首先来看下,什么是requirejs。这个很重要,要弄懂自己使用的工具到底是什么,有什么作用。

1.1 什么事requirejs

RequireJS is a JavaScript file and module loader. It is optimized for
in-browser use, but it can be used in other JavaScript environments,
like Rhino and Node. Using a modular script loader like RequireJS will
improve the speed and quality of your code.

这段是官网的原话。翻译后就是:

RequireJS是一个JavaScript文件和模块加载器。
它针对浏览器内的使用进行了优化,但可用于其他JavaScript环境,如Rhino和Node。
使用像RequireJS这样的模块化脚本加载器可以提高代码的速度和质量。

我的个人理解是,requirejs是一个把你的文件整理加载的工具,可以提高代码的利用率和不重复。减少http请求。

1.2 requirejs下载和安装

在简单的了解了requirejs后,已经迫不及待的想要使用这个先进的方式来重新编码我的页面了。那我们先做的就是下载requirejs

2.使用

现在完成后,将requirejs放在我们的js文件下。
创建一个html,在页面中使用:

<script type="text/javascript"  src="js/require.js"></script>

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

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

async属性表明这个文件需要异步加载,避免网页失去响应。IE不支持这个属性,只支持defer,所以把defer也写上。
加载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、jquery-ui和jquery-slide这三个模块,main.js就可以这样写:

require(['jquery', 'jquery-ui', 'jquery-slide'], function ($){
    // some code here
  });

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

4. 模块的加载

上一节最后的示例中,主模块的依赖模块是[‘jquery’, ‘jquery-ui”, ‘jquery-slide’]。默认情况下,require.js假定这三个模块与main.js在同一个目录,文件名分别为jquery.js,jquery-slide.js和jquery-ui.js,然后自动加载。
使用require.config()方法,我们可以对模块的加载行为进行自定义。require.config()就写在主模块(main.js)的头部。参数就是一个对象,这个对象的paths属性指定各个模块的加载路径。

require.config({
    paths: {
      "jquery": "jquery.min",
      "jquery-ui": "jquery-ui.min",
      "jquery-slide": "jquery-slide.min"
    }
  });

上面的代码给出了三个模块的文件名,路径默认与main.js在同一个目录(js子目录)。如果这些模块在其他目录,比如js/lib目录,则有两种写法。一种是逐一指定路径。

require.config({
    paths: {
      "jquery": "lib/jquery.min",
      "jquery-ui": "lib/jquery-ui.min",
      "jquery-slide": "lib/jquery-slide.min"
    }
  });

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

require.config({
    baseUrl: "js/lib",
    paths: {
      "jquery": "jquery.min",
      "jquery-ui": "jquery-ui.min",
      "jquery-slide": "jquery-slide.min"
    }
  });

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

require.config({
    paths: {
      "jquery": "https://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min"
    }
  });

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

5. 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(['my'], function(my){
    function foo(){
      my.doSomething();
    }
    return {
      foo : foo
    };
  });

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

6. 加载非规范的模块

理论上,require.js加载的模块,必须是按照AMD规范、用define()函数定义的模块。但是实际上,虽然已经有一部分流行的函数库(比如jQuery)符合AMD规范,更多的库并不符合。那么,require.js是否能够加载非规范的模块呢?
回答是可以的。
这样的模块在用require()加载之前,要先用require.config()方法,定义它们的一些特征。
举例来说,jquery-ui和jquery-slide这两个库,都没有采用AMD规范编写。如果要加载它们的话,必须先定义它们的特征。

shim: {
    'jquery.scroll': {
      deps: ['jquery']
    }
  }

7. 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文件。

猜你喜欢

转载自blog.csdn.net/wangdan_2013/article/details/78465966
今日推荐