【转】requirejs的用法

红色加粗为个人的理解部分,有误的地方望留言指出,谢谢

来源:http://www.haorooms.com/post/js_require_zz

之前我的一片文章介绍过requirejs,具体地址是:http://www.haorooms.com/post/RequireJS_mkh_jz ,今天看到阮一峰博客上面对于requirejs的介绍比较通俗易懂,今天转载一下!

一、为什么要用require.js?

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

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

这样的写法有很大的缺点。首先,加载的时候,浏览器会停止网页渲染,加载文件越多,网页失去响应的时间就会越长;其次,由于js文件之间存在依赖关系,因此必须严格保证加载顺序(比如上例的1.js要在2.js的前面),依赖性最大的模块一定要放到最后加载,当依赖关系很复杂的时候,代码的编写和维护都会变得困难。

require.js的诞生,就是为了解决这两个问题:   

(1)实现js文件的异步加载,避免网页失去响应;

(2)管理模块之间的依赖性,便于代码的编写和维护。

二、require.js的加载

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

下载后,假定把它放在js子目录下面,就可以加载了。

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

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

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

async属性表明这个文件需要异步加载,避免网页失去响应。IE不支持这个属性,只支持defer,所以把defer也写上。我之前的一篇文章,关于前端性能优化的,提及过defer ,有兴趣的可以去看看!http://www.haorooms.com/post/web_xnyh_jscss加载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。

三、主模块的写法

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

四、模块的加载

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

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

require.config({
    baseUrl: "js/lib",  //从项目根目录开始,即./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提供了OPTIMIZER这样一个优化工具,当模块部署完毕以后,可以用这个工具将多个模块合并在一个文件中,减少HTTP请求数。工具地址:http://requirejs.org/docs/optimization.html 此工具要基于node,还需要https://github.com/jrburke/r.js 这个js。

五、baseUrl基目录对require引入文件指定路径的影响


require.config({
    //baseUrl: "assets", //因为main.js在assets目录下,所以此行注不注释掉,基目录都是assets
    paths: {
        jquery: 'lib/jquery-1.12.1',
        backbone: 'lib/backbone-min',
        underscore: 'lib/underscore-min',
        text : 'lib/text.min.js',
       controllerBase: '../controller' //自定义一个path,返回上一目录的controller目录
}
});
//require文件路径都是基于baseUrl(此例中assets目录为基目录)
require(['jquery', 'underscore', 'backbone'], function ($, _ , Backbone) {
    require(['../view/app'], function (app) {  //所以../view/app路径才能找到app.js
        require(['controllerBase/contact', 'controllerBase/home', 'controllerBase/search', 'controllerBase/shell'], function () { //因为paths中设置了controllerBase为../controller
       
    })
});

五、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()函数的第一个参数,必须是一个数组,指明该模块的依赖性。

只有先加载mylib模块后,新模块才能正常运行

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: { //shim可以理解成“垫片”,用来帮助require.js加载非AMD规范的库。
      'underscore':{
        exports: '_'
      },
      'backbone': { //shim指定依赖关系(依赖于underscore、jquery),以及输出符号为“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!templates.html',
    'image!cat.jpg'
    ],
       //第一个加载模块则是一个文本,用’text!’表示。该文本作为字符串,存放在回调函数的template变量中。
    function(template, cat){
      // ...
    }
 );

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

八、require方法:调用模块

1、require方法用于调用模块。它的参数与define方法类似。

require(['foo', 'bar'], function ( foo, bar ) {
        foo.doSomething();
});
2、require方法也可以用在define方法内部。

define(function (require) {
   var otherModule = require('otherModule');
});
下面的例子显示了如何动态加载模块。

define(function ( require ) {
    var isReady = false, foobar;
 
    require(['foo', 'bar'], function (foo, bar) {
        isReady = true;
        foobar = foo() + bar();
    });
 
    return {
        isReady: isReady,
        foobar: foobar
    };
});
       上面代码所定义的模块,内部加载了foo和bar两个模块,在没有加载完成前,isReady属性值为false,加载完成后就变成了true。因此,可以根据isReady属性的值,决定下一步的动作。

3、require方法允许添加第三个参数,即错误处理的回调函数。

require([ "backbone" ], function ( Backbone ) {
        return Backbone.View.extend({ /* ... */ });
    }, 
    function (err) {
		// ...
    }
);
require方法的第三个参数,即处理错误的回调函数,接受一个error对象作为参数。

4、require对象还允许指定一个全局性的Error事件的监听函数。所有没有被上面的方法捕获的错误,都会被触发这个监听函数。

requirejs.onError = function (err) {
    // ...
};

九、优化器r.js

1、RequireJS提供一个基于node.js的命令行工具r.js,用来压缩多个js文件。它的主要作用是将多个模块文件压缩合并成一个脚本文件,以减少网页的HTTP请求数。
第一步是安装r.js(假设已经安装了node.js)。

npm install -g requirejs
然后,使用的时候,直接在命令行键入以下格式的命令。

node r.js -o <arguments>
<argument>表示命令运行时,所需要的一系列参数,比如像下面这样:

node r.js -o baseUrl=. name=main out=main-built.js
除了直接在命令行提供参数设置,也可以将参数写入一个文件,假定文件名为build.js。

({
    baseUrl: ".",
    name: "main",
    out: "main-built.js"
})
然后,在命令行下用r.js运行这个参数文件,就OK了,不需要其他步骤了。

node r.js -o build.js

下面是一个参数文件的范例,假定位置就在根目录下,文件名为build.js。

({
    appDir: './',
    baseUrl: './js',
    dir: './dist',
    modules: [
        {
            name: 'main'
        }
    ],
    fileExclusionRegExp: /^(r|build)\.js$/,
    optimizeCss: 'standard',
    removeCombined: true,
    paths: {
        jquery: 'lib/jquery',
        underscore: 'lib/underscore',
        backbone: 'lib/backbone/backbone',
        backboneLocalstorage: 'lib/backbone/backbone.localStorage',
        text: 'lib/require/text'
    },
    shim: {
        underscore: {
            exports: '_'
        },
        backbone: {
            deps: [
                'underscore',
                'jquery'
            ],
            exports: 'Backbone'
        },
        backboneLocalstorage: {
            deps: ['backbone'],
            exports: 'Store'
        }
    }
})
上面代码将多个模块压缩合并成一个main.js。

参数文件的主要成员解释如下:

appDir:项目目录,相对于参数文件的位置。

baseUrl:js文件的位置。

dir:输出目录。

modules:一个包含对象的数组,每个对象就是一个要被优化的模块。

fileExclusionRegExp:凡是匹配这个正则表达式的文件名,都不会被拷贝到输出目录。

optimizeCss: 自动压缩CSS文件,可取的值包括“none”, “standard”, “standard.keepLines”, “standard.keepComments”, “standard.keepComments.keepLines”。

removeCombined:如果为true,合并后的原文件将不保留在输出目录中。

paths:各个模块的相对路径,可以省略js后缀名。

shim:配置依赖性关系。如果某一个模块不是AMD模式定义的,就可以用shim属性指定模块的依赖性关系和输出值。

generateSourceMaps:是否要生成source map文件。


声明:

本篇文章大部分内容来自阮一峰博客,http://www.ruanyifeng.com/blog/2012/11/require_js.html

参考链接:《RequireJS和AMD规范》http://javascript.ruanyifeng.com/tool/requirejs.html

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值