分类

Javascript模块化编程(三):require.js的用法

作者: 阮一峰

日期: 2012年11月 7日

这个系列的第一部分第二部分,介绍了Javascript模块原型和理论概念,今天介绍如何将它们用于实战。

我采用的是一个非常流行的库require.js

一、为什么要用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也写上。

加载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({

    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请求数。

五、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'

    }

  }

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

(完)

珠峰培训

简寻

留言(88条)

Backbone并不依赖于jQuery啊,为什么还要写成deps: ['underscore', 'jquery']?

写成exports: 'Backbone'的话,应该怎么使用呢?

是这样?
require(['jquery', 'underscore', 'backbone'], function ($, _, Backbone){
   // some code here
});
还是
require(['jquery', 'underscore', 'Backbone'], function ($, _, Backbone){
   // some code here
});

看你博客介绍的这三篇Javascript的文章,我也打算尝试下了!

@子不语

官網上面寫著:

Backbone's only hard dependency is Underscore.js ( > 1.3.1). For RESTful persistence, history support via Backbone.Router and DOM manipulation with Backbone.View, include json2.js, and either jQuery ( > 1.4.2) or Zepto.

@子不语:

前一种写法正确。

下次介绍seajs和cmd吧

用了这个调试起来就不方便了,没法解决调试的问题

听说Google今天解封了,试了一下,的确是快了点,好久都没用google了。

我写过 SeaJS 的介绍 http://cyj.me/why-seajs/zh/,也翻译过 RequireJS 网站上讲技术思想的两篇文章 http://cyj.me/why-seajs/requirejs/

习惯seajs

引用abian的发言:

听说Google今天解封了,试了一下,的确是快了点,好久都没用google了。

可以使用Chrome浏览器+Prefer HTTPS插件,打开Google以及打开Google的搜索结果时,都是使用HTTPS协议,顺利破封!

阮老师的这三篇文章写的非常好!把我关于这方面的疑惑一扫而光!顶!!
另外,我把这三篇文章转走了。哈哈


  require.config({

    paths: {

      "jquery": "jquery.min.js",
      "underscore": "underscore.min.js",
      "backbone": "backbone.min.js"

    }

  });

应该不用加 .js,不然例子不能通过。

引用Arthur的发言:

应该不用加 .js,不然例子不能通过。

谢谢指出。这段代码是徒手写的,当时没有上机验证,确实写错了,已经更正了。

Seems like

require.config({...})

should be:

requirejs.config({...}) ?

阮老师有时间写一个backbone.js的文章吧。这个最近很流利,可是官网的文档真的是很差,看不太懂。

看文档的时候看到的:
There may be times when you do want to reference a script directly and not conform to the "baseUrl + paths" rules for finding it. If a module ID has one of the following characterstics, the ID will not be passed through the "baseUrl + paths" configuration, and just be treated like a regular URL that is relative to the document:
*Ends in ".js".
*Starts with a "/".
*Contains an URL protocol, like "http:" or "https:".

表示不太明白,main文件里面把要用到的模块都写上?
那比如有一个页面A,只需要math模块,另外一个页面B,只需要add模块,都写到main文件里面的话,那A,B页面同时都载入了两个模块了吧。

谢谢分享,期待更多 backbone 相关的文章,可以做友情链接吗?

引用Andy的发言:

表示不太明白,main文件里面把要用到的模块都写上?
那比如有一个页面A,只需要math模块,另外一个页面B,只需要add模块,都写到main文件里面的话,那A,B页面同时都载入了两个模块了吧。

A页面和B页面都可以写各自的main模块啊

想问一下,如果还要加载backbone.localStorage.js怎么写?require(['jquery','underscore','backbone','?'],function($,_,Backbone,?){}

很好,写的巴适!

我在dojo对js进行打包,生成的文件
require({cache:{"custom/MyModule":function () {
define(["dojo/_base/lang"], function (lang) {
......
})
}
},
......
这个require()里面好像是个map,请问我加载了模块怎么调用模块里面的方法呢

看完很有收获!谢谢。

获益良多,赞!在项目中使用extjs这样的框架,又该如何合理组织代码呢

已经用了很久的RequireJS和Backbone, 但因为是半路上手, 一直没有系统研究. 今天头一次明白了AMD和CommonJS的区别, 然后理解了RquireJS的原理. 谢谢

赞一个,欣赏大神的互联网思维。

看了您很多关于javascript的文章,受益匪浅,我觉得requirejs还有一个好处是对全局变量和命名空间的管理,虽然很多框架都可以实现,或者自己也可以把前端框架包起来,但是用requirejs总是方便很多。

看来半天的API云里雾里的,还是中文文档来得真切。

老师,刚了解了下Ozjs一头雾水,都没找到太多关于ozjs的资料!是不是requirejs和ozjs目的都是一样的啊

有个关于requirejs的问题想请教一下:现在有A,B,C三个页面,这三个页面有一个通用模块common.js。common.js依赖suggestion.js,taset.js,localStorage.js。然后在A页面,需要一个a.js,依赖localStorage.js。因为common的内容改动比较频繁,所以是单独作为一个js放入页面里面。现在问题出现了,怎样才能同时在页面里面加载两个requirejs的主模块,这两个模块都使用到了localStorage.js,怎样才能避免重复加载(指的是在线下的时候,预先进行代码的压缩合并)

页面上怎么用模块里的方法,比如说 怎么直接在这添加onclick 不用bind的情况下

真的很感激博主,最近的项目中恰好用到require.js,自己正在头大眼花的时候,看完这一、二、三部感觉获益匪浅。

请问下楼主,requirejs 版本管理怎么控制呢?版本号

碰到一个问题,假如一个main.js里依赖aa,bb,cc........n多个小模块,当执行其中的第n个模块时,会出现方法未定义,
比如:调用的cc.add()方法,提示没有add的方法

引用oneway的发言:

Seems like

require.config({...})

should be:

requirejs.config({...}) ?

是的,应该是requirejs.config({...})

Usually, we use bootjs + headjs + requerjs to load our models. :)

非常感谢,您写的博文浅显易懂,深入浅出,能把一个问题说透,真的非常好,谢谢!

hola, 请教个问题啊,使用require的时候,怎么写整个网站的统一入口比较合适啊? 我现在是这样的情况,我没有用data-main来写入口,而是在每个页面里分别写自己的require(如下), 但是最后发现貌似不用data-main这样的写法,grunt-requirejs不能把加载的模块打包到一起, 但是由于每个页面所需的模块不一样,所以不知道怎么写统一的入口,请指教一下哈

<!-- build:js scripts/require.js -->
<script src="bower_components/requirejs/require.js"></script>
<!-- endbuild -->
<script>
require(['scripts/config'], function() {
require(['scripts/album/create']);
});
</script>

我觉得挺无聊的,我就算加载5个js文件,1,2,3,4,5 也同样可以自己写一个异步加载的方法呀,这个所以的requirejs本身就搞的好大,加上jquery文件,再加上自己的js,那得多大

引用Jeremy的发言:

我觉得挺无聊的,我就算加载5个js文件,1,2,3,4,5 也同样可以自己写一个异步加载的方法呀,这个所以的requirejs本身就搞的好大,加上jquery文件,再加上自己的js,那得多大

确实是,所以最后都是打成一个文件

小项目用这些,华而不实,有装逼感。大项目还是很有用的。

shim不是设置依赖的么?官网也有不写exports的例子啊
requirejs.config({
shim: {
'jquery.colorize': ['jquery'],
'jquery.scroll': ['jquery'],
'backbone.layoutmanager': ['backbone']
}
});

看了阮老师的文章,受益匪浅,谢谢。

引用子不语的发言:

Backbone并不依赖于jQuery啊,为什么还要写成deps: ['underscore', 'jquery']?

写成exports: 'Backbone'的话,应该怎么使用呢?

是这样?
require(['jquery', 'underscore', 'backbone'], function ($, _, Backbone){
   // some code here
});
还是
require(['jquery', 'underscore', 'Backbone'], function ($, _, Backbone){
   // some code here
});

我自己的测试结果是没有什么作用,本来其他的库就是在全局变量中添加一个,比如jQuery会添加window.$,如果require.js已经加载完成了jQurey,那么全局变量的$应该就是jQuery,直接使用$就是了

最简单粗暴的requirejs介绍。
棒棒的。

如果只是控制加载顺序的话,在jsp页面按顺序写不就行了,为啥还要require.js呢???

引用波的发言:

如果只是控制加载顺序的话,在jsp页面按顺序写不就行了,为啥还要require.js呢???

因为写在jsp里不能控制依赖关系。

引用波的发言:

如果只是控制加载顺序的话,在jsp页面按顺序写不就行了,为啥还要require.js呢???

你肯定没写过js

假如我在全局的公共文件配置了
require.config({
baseUrl: 'js',
paths: {
a: 'a',
b: 'b',
c: 'c'
}
});
有个单独的文件 需要在单独加入个配置
require.config({
baseUrl: 'js',
paths: {
d: 'd'
}
});
是这样覆写吗,还是有什么add到config.pathss的方法?

通熟易懂!!!

讲的太好了!

写JS重复代码写累了想试试模块化开发,然后被各种新技术新名词搞得晕头转向。来你这里连续看了好多篇文章,真是受益匪浅,把原来挺起了很高深的东西解释得非常简单易懂,对于初步了解非常有帮助,也消除了原有的一些恐惧,真是太感谢了!!!

很好,绝对受益了

比官方文档写的好多了

引用igody的发言:

是的,应该是requirejs.config({...})

测试requier.config({
//doing something
})通过

以前我看文章几乎都不评论,但是这次一定要顶一下,老师写的真的很好。

请教个问题:
我在main.js里配置了jquery,如下:
require.config({
baseUrl: '/js/',
paths: {
'jquery': 'lib/jquery/jquery-1.7.1.min'
}
});

我的本意是想把一些公共的js(jquery、cookie等等)都定义下路径,然后在其他js里直接调用别名,而不是再写全路径.如下:


require(['jquery'], function($){
$('body').html('test');
});a

但这样是实现不了的,只能是在main.js里这样调用。 我想问下是否有办法实现这样的调用?谢谢!

引用Jeremy的发言:

我觉得挺无聊的,我就算加载5个js文件,1,2,3,4,5 也同样可以自己写一个异步加载的方法呀,这个所以的requirejs本身就搞的好大,加上jquery文件,再加上自己的js,那得多大

不单是为了异步,关键还有模块化编程思想啊.......比如 A.js B.js,其中B.js里面需要用到A.js里面传递过来的参数.....

在读到最后时,
「text和image插件,则是允许require.js加载文本和图片文件。」下面的代码是否有误?

`define` 可能应该为 `require`

```javascript
  define([
    'text!review.txt',
    'image!cat.jpg'
    ],

    function(review,cat){
      console.log(review);
      document.body.appendChild(cat);
    }
  );
```

和 android 上的 Gradle 一个作用

引用zcz的发言:

假如我在全局的公共文件配置了
require.config({
baseUrl: 'js',
paths: {
a: 'a',
b: 'b',
c: 'c'
}
});
有个单独的文件 需要在单独加入个配置
require.config({
baseUrl: 'js',
paths: {
d: 'd'
}
});
是这样覆写吗,还是有什么add到config.pathss的方法?

直接都写在全局也没什么影响吧。只有在用的时候写了define(['d'],function(){})才会加载d。 全局定义这个只是为了在用的时候少些一些路径。如果没定义jquery的paths,那么每个引用jquery的地方都得这么写: define(['lib/jquery.min'],function($){})

如果定义了paths:
require.config({
paths: {
jquery: 'lib/jquery.min'
}
});

那么每个引用jquery的地方就可以这么写了:
define(['jquery'],function($){})

引用Jeremy的发言:

我觉得挺无聊的,我就算加载5个js文件,1,2,3,4,5 也同样可以自己写一个异步加载的方法呀,这个所以的requirejs本身就搞的好大,加上jquery文件,再加上自己的js,那得多大

我们现在的项目index.html包含了300多个js文件,急需requirejs解依赖关系之急。

多谢你的文章很好

过了这么多年了,你也不更新下,还对得起苦涩的青春嘛~~ >

博主你的About Me,最后一行应该把watching movie 改成 watching movies。要不是学习了你的requirejs我会告诉你?!

一直在用requirejs,但不是我搭建的,是大牛搭建的,看了这篇文章很有帮助,我也会了,赞一个

老师,我们开发用得就是这个,但是最近遇到了重复加载的问题,一个js文件中调用了highcharts.js这个框架,登录前和登录后的页面都要引用这个js文件,这样用户从登录前的页面进入到登录后的页面,就会出现页面重复加载的问题,这种情况怎么解决呢,希望老师解答,谢谢

Javascript 的文章写的真的特别好, 学习了

引用hhq的发言:

测试requier.config({
//doing something
})通过

实际上,requier === requierjs

引用forevermnj的发言:

老师,我们开发用得就是这个,但是最近遇到了重复加载的问题,一个js文件中调用了highcharts.js这个框架,登录前和登录后的页面都要引用这个js文件,这样用户从登录前的页面进入到登录后的页面,就会出现页面重复加载的问题,这种情况怎么解决呢,希望老师解答,谢谢

虽然是重复require了,如果页面不发生跳转,浏览器应该直接用的是缓存(from cache)的吧,如果有跳转,那不同的页面就不叫重复加载啦

讲解的很好呢,学习了,谢谢

峰哥:我想请教一个问题,如果严格按照AMD规范来写的话,模块里面的define(["m1","m2"],callback),这里的m1和m2有事有依赖关系,该怎么管理?经我测试,两个顺序可以随意调换都可以?难道随意写?它自行管理依赖关系??

引用波的发言:

如果只是控制加载顺序的话,在jsp页面按顺序写不就行了,为啥还要require.js呢???

require,js是异步加载。

IE10是支持async属性的

可以在页面中去调用模块中定义的方法吗?

阮老师已经是我的启蒙老师了,一有要学的新知识,就到这里淘

如果我是多个页面,调用有不同的功能,也全部都写在主文件入口上么,例如一个首页,一个列表页,一个详情页,还是全部加载主文件么!

我找这个文件很久了, 谢谢阮大神.

阮老师的文章确实通俗易懂,但是遇到一个问题,就是在IE7下会报错,我检查了是data-main属性的问题,但是我直接在首页通过require.config(['config.js路径'],function(){ alert('回调') }),仍然报错。公司项目必须兼容IE7,这个不知道怎么回事,查了很多资料,没发现谁说不兼容IE7的

引用ericyin的发言:

阮老师的文章确实通俗易懂,但是遇到一个问题,就是在IE7下会报错,我检查了是data-main属性的问题,但是我直接在首页通过require.config(['config.js路径'],function(){ alert('回调') }),仍然报错。公司项目必须兼容IE7,这个不知道怎么回事,查了很多资料,没发现谁说不兼容IE7的

我做了个小demo,发现ie8下报错:对象不支持此属性或方法

学习啦!又来温习了一遍!阮老师的文章都是干货!大赞!~

不错的 受益匪浅

引用Jooos的发言:

如果我是多个页面,调用有不同的功能,也全部都写在主文件入口上么,例如一个首页,一个列表页,一个详情页,还是全部加载主文件么!

哥们解决了吗? 我也有这个疑问。

如果有一个模块A依赖模块C,另一个模块B也依赖模块C,那么使用requirejs进行模块化加载后,C模块会被重复加载两次吗?

引用xiaowei的发言:

哥们解决了吗? 我也有这个疑问。

你可以每个页面有单独的入口main文件 比如 index.js content.js lis.js

感谢阮老师的讲解!深入浅出,写的真好!

看阮老师的文章已经好几年了, 有个小建议就是能把浏览给分页下么?

如果一个页面中,除了main.js模块,还需要其他的js文件呢?这个js就是单独起作用的,这样还是要把这个js单独加载吧?

我要发表看法

«-必填

«-必填,不公开

«-我信任你,不会填写广告链接