`

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

 
阅读更多

一、为什么要用require.js?

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

  1. <script src="1.js"></script>
  2. <script src="2.js"></script>
  3. <script src="3.js"></script>
  4. <script src="4.js"></script>
  5. <script src="5.js"></script>
  6. <script src="6.js"></script>

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

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

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

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

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

二、require.js的加载

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

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

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

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

  1. &lt;script src="js/require.js" <strong>defer async="true"</strong> &gt;&lt;/script&gt;

async属性表明这个文件需要异步加载,避免网页失去响应。IE不支持这个属性,只支持defer,所以把defer也写上。

加载require.js以后,下一步就要加载我们自己的代码了。假定我们自己的代码文件是main.js,也放在js目录下面。那么,只需要写成下面这样就行了:

  1. &lt;script src="js/require.js" <strong>data-main="js/main"</strong>&gt;&lt;/script&gt;

data-main属性的作用是,指定网页程序的主模块。在上例中,就是js目录下面的main.js,这个文件会第一个被require.js加载。由于require.js默认的文件后缀名是js,所以可以把main.js简写成main。

三、主模块的写法

上一节的main.js,我把它称为"主模块",意思是整个网页的入口代码。它有点像C语言的main()函数,所有代码都从这儿开始运行。

下面就来看,怎么写main.js。

如果我们的代码不依赖任何其他模块,那么可以直接写入javascript代码。

  1. // main.js
  2. alert("加载成功!");

但这样的话,就没必要使用require.js了。真正常见的情况是,主模块依赖于其他模块,这时就要使用AMD规范定义的的require()函数。

  1. // main.js
  2. require(['moduleA', 'moduleB', 'moduleC'], function (moduleA, moduleB, moduleC){
  3. // some code here
  4. });

require()函数接受两个参数。第一个参数是一个数组,表示所依赖的模块,上例就是['moduleA', 'moduleB', 'moduleC'],即主模块依赖这三个模块;第二个参数是一个回调函数,当前面指定的模块都加载成功后,它将被调用。加载的模块会以参数形式传入该函数,从而在回调函数内部就可以使用这些模块。

require()异步加载moduleA,moduleB和moduleC,浏览器不会失去响应;它指定的回调函数,只有前面的模块都加载成功后,才会运行,解决了依赖性的问题。

下面,我们看一个实际的例子。

假定主模块依赖jquery、underscore和backbone这三个模块,main.js就可以这样写:

  1. require(['jquery', 'underscore', 'backbone'], function ($, _, Backbone){
  2. // some code here
  3. });

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属性指定各个模块的加载路径。

  1. require.config({
  2. paths: {
  3. "jquery": "jquery.min.js",
  4. "underscore": "underscore.min.js",
  5. "backbone": "backbone.min.js"
  6. }
  7. });

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

  1. require.config({
  2. paths: {
  3. "jquery": "<strong>lib/</strong>jquery.min.js",
  4. "underscore": "<strong>lib/</strong>underscore.min.js",
  5. "backbone": "<strong>lib/</strong>backbone.min.js"
  6. }
  7. });

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

  1. require.config({
  2. <strong>baseUrl: "js/lib",</strong>
  3. paths: {
  4. "jquery": "jquery.min.js",
  5. "underscore": "underscore.min.js",
  6. "backbone": "backbone.min.js"
  7. }
  8. });

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

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

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

五、AMD模块的写法

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

具体来说,就是模块必须采用特定的define()函数来定义。如果一个模块不依赖其他模块,那么可以直接定义在define()函数之中。

假定现在有一个math.js文件,它定义了一个math模块。那么,math.js就要这样写:

  1. // math.js
  2. define(function (){
  3. var add = function (x,y){
  4. return x+y;
  5. };
  6. return {
  7. add: add
  8. };
  9. });

加载方法如下:

  1. // main.js
  2. require(['math'], function (math){
  3. alert(math.add(1,1));
  4. });

如果这个模块还依赖其他模块,那么define()函数的第一个参数,必须是一个数组,指明该模块的依赖性。

  1. define(['myLib'], function(myLib){
  2. function foo(){
  3. myLib.doSomething();
  4. }
  5. return {
  6. foo : foo
  7. };
  8. });

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

六、加载非规范的模块

理论上,require.js加载的模块,必须是按照AMD规范、用define()函数定义的模块。但是实际上,虽然已经有一部分流行的函数库(比如jQuery)符合AMD规范,更多的库并不符合。那么,require.js是否能够加载非规范的模块呢?

回答是可以的。

这样的模块在用require()加载之前,要先用require.config()方法,定义它们的一些特征。

举例来说,underscore和backbone这两个库,都没有采用AMD规范编写。如果要加载它们的话,必须先定义它们的特征。

  1. require.config({
  2. shim: {
  3. 'underscore':{
  4. exports: '_'
  5. },
  6. 'backbone': {
  7. deps: ['underscore', 'jquery'],
  8. exports: 'Backbone'
  9. }
  10. }
  11. });

require.config()接受一个配置对象,这个对象除了有前面说过的paths属性之外,还有一个shim属性,专门用来配置不兼容的模块。具体来说,每个模块要定义(1)exports值(输出的变量名),表明这个模块外部调用时的名称;(2)deps数组,表明该模块的依赖性。

比如,jQuery的插件可以这样定义:

  1. shim: {
  2. 'jquery.scroll': {
  3. deps: ['jquery'],
  4. exports: 'jQuery.fn.scroll'
  5. }
  6. }

七、require.js插件

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

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

  1. require(['domready!'], function (doc){
  2. // called once the DOM is ready
  3. });

text和image插件,则是允许require.js加载文本和图片文件。

  1. define([
  2. 'text!review.txt',
  3. 'image!cat.jpg'
  4. ],
  5. function(review,cat){
  6. console.log(review);
  7. document.body.appendChild(cat);
  8. }
  9. );

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

 

原文链接:http://www.ruanyifeng.com/blog/2012/11/require_js.html

分享到:
评论

相关推荐

    Javascript模块化编程(Require.js)

    JavaScript模块化编程是一种组织代码的方式,它使得代码更易于维护、重用和协作。Require.js是JavaScript的一个模块加载器,它引入了AMD(Asynchronous Module Definition)规范,为JavaScript提供了异步加载模块的...

    javascript模块化编程库require的用法.docx

    ### JavaScript模块化编程库Require.js的使用方法 #### 引言 随着Web应用的日益复杂,传统的JavaScript开发方式已无法满足高效开发与维护的需求。在这样的背景下,Require.js作为一种先进的JavaScript模块加载器,...

    JavaScript模块化编程

    ### JavaScript模块化编程 #### 一、理解JavaScript模块化 ##### 1.1 模块化的概念 在软件工程中,模块化是一种重要的设计思想,指的是将复杂的系统分解成一系列独立的功能单元(即模块),每个模块负责实现系统...

    require.js build

    `require.js` 是一个流行的JavaScript模块化加载器,它使得在浏览器端管理JavaScript代码变得更加有序和高效。在HTML5 Boilerplate(一个前端开发基础模板)中整合`require.js`,可以提升项目的构建质量和性能,特别...

    Javascript模块化编程(三)require.js的用法及功能介绍

    通过在HTML文件中引入require.js库,可以正式开始项目的模块化编程。 通常的做法是将require.js的引用放置在HTML文件的底部,但有时为了保证页面加载的顺序,我们也可以采用异步加载的方式。具体操作如下: ```...

    Javascript模块化编程(三):模块化编程实战,试用SeaJS

    JavaScript模块化编程是现代Web开发中的重要组成部分,它有助于组织代码、提高可维护性和复用性。本篇文章将深入探讨JavaScript模块化编程的实战应用,特别是通过试用SeaJS这一工具来实现。SeaJS是一款专注于浏览器...

    论JavaScript模块化编程_.docx

    JavaScript模块化编程是解决代码组织和管理问题的关键技术,尤其对于大型项目而言,它能够确保代码的可维护性、可重用性和可扩展性。在JavaScript的传统开发模式中,全局变量的滥用、脚本依赖顺序的混乱以及大量脚本...

    require.js 加载过程与使用方法介绍

    require.js是javascript模块化编程中常用的一个JS库。 现在的网页功能较以前已经丰富了许多,同时网页上需要导入越来越多的JS文件来实现这些功能。使用原有的script标签一个个导入js文件会导致代码的复杂与臃肿。...

    Javascript模块化编程详解

    JavaScript模块化编程是一种组织代码的方式,它使得代码更容易理解和维护。模块化编程通过将相关的功能封装起来,避免了全局变量的滥用,提高了代码的复用性。本文将深入讲解JavaScript模块化编程的基础和一些进阶...

    AMD异步模块定义介绍和Require.js中使用jQuery及jQuery插件的方法

    AMD规范的引入,以及Require.js等模块加载器的推广使用,极大地推动了JavaScript模块化编程的实践,使得开发更加大型复杂的Web应用程序成为可能。开发者可以根据AMD规范来组织代码,利用Require.js提供的模块加载...

    第二次聊一聊JS require.js模块化工具的基础知识

    Require.js是一款流行的JavaScript模块加载器,它通过简单的配置和API帮助开发者实现模块化编程。本文旨在介绍Require.js的基础知识点,供对模块化工具感兴趣的同学参考。 首先,Require.js为JavaScript定义了三个...

    JavaScript模块化编程七日

    JavaScript模块化编程是现代Web开发中的关键组成部分,它允许开发者将复杂的代码结构组织成可重用、可维护的模块。在“JavaScript模块化编程七日”这个主题中,我们将深入探讨这一重要概念,涵盖从基本的模块化原理...

    require.js-demo

    《require.js:JavaScript模块化开发的关键》 在Web开发领域,JavaScript已经成为不可或缺的一部分,而随着项目的复杂性不断提升,代码组织和管理变得越来越重要。require.js的出现,为JavaScript的模块化开发提供...

    【JavaScript源代码】Node.js里面的内置模块和自定义模块的实现.docx

    CommonJS是一种在客户端JavaScript中实现模块化编程的标准,它允许开发者将代码组织成独立的模块,便于重用和管理。Node.js是CommonJS规范的一个重要实现,使得JavaScript能够应用于服务器端开发。 在Node.js中,...

    JavaScript模块化+JavaScript数据推送.docx

    JavaScript模块化是编程实践中将大型复杂项目分解为可管理的小块的重要方法。随着Node.js的出现,JavaScript模块化成为了一种普遍的实践,它允许开发者将代码组织成独立的模块,便于重用、测试和维护。CommonJS是最...

    理解javascript模块化_.docx

    JavaScript模块化是编程实践中一种重要的组织代码的方式,它使得代码可重用性增强,提高了开发效率,降低了维护难度。本文将深入探讨JavaScript模块化的概念、方法以及如何实现小而简洁的模块。 首先,模块化的基本...

    Node.js高级编程.pdf

    2. **模块系统**:Node.js拥有强大的模块化系统,通过`require`和`module.exports`可以方便地引入和导出模块。CommonJS规范是Node.js的默认模块系统,但随着ES6的普及,现在也支持使用`import`和`export`语法。 3. ...

Global site tag (gtag.js) - Google Analytics