require.js的用法详解


Posted in Javascript onOctober 20, 2015

一、为什么要用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的诞生,就是为了解决这两个问题:

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结构加载完成后再运行。

 shim: {

'jquery.scroll': {



deps: ['jquery'],



exports: 'jQuery.fn.scroll'


}

}

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

以上就是本文的全部所述,希望本文分享对大家有所帮助。

Javascript 相关文章推荐
javascript网页关闭时提醒效果脚本
Oct 22 Javascript
JavaScript 异步调用框架 (Part 2 - 用例设计)
Aug 03 Javascript
javascript 弹出层组件(升级版)
May 12 Javascript
jquery移除button的inline onclick事件(已测试及兼容浏览器)
Jan 25 Javascript
让js弹出窗口居前显示的实现方法
Jul 10 Javascript
通过JQuery实现win8一样酷炫的动态磁贴效果(示例代码)
Jul 13 Javascript
把jquery 的dialog和ztree结合实现步骤
Aug 02 Javascript
JavaScript数组各种常见用法实例分析
Aug 04 Javascript
jQuery实现的省市县三级联动菜单效果完整实例
Aug 01 Javascript
js的函数的按值传递参数(实例讲解)
Nov 16 Javascript
React中的refs的使用教程
Feb 13 Javascript
使用Vue自定义指令实现Select组件
May 24 Javascript
JS实现鼠标滑过链接改变网页背景颜色的方法
Oct 20 #Javascript
JS实现带有3D立体感的银灰色竖排折叠菜单代码
Oct 20 #Javascript
jquery如何获取元素的滚动条高度等实现代码
Oct 19 #Javascript
js验证身份证号有效性并提示对应信息
Oct 19 #Javascript
详解JavaScript数组的操作大全
Oct 19 #Javascript
全系IE支持Bootstrap的解决方法
Oct 19 #Javascript
JS+CSS实现分类动态选择及移动功能效果代码
Oct 19 #Javascript
You might like
使用YII2框架实现微信公众号中表单提交功能
2017/09/04 PHP
ThinkPHP3.2.3框架实现的空模块、空控制器、空操作,跳转到错误404页面图文详解
2019/04/03 PHP
(仅IE下有效)关于checkbox 三态
2007/05/12 Javascript
js 点击按钮弹出另一页,选择值后,返回到当前页
2010/05/26 Javascript
JavaScript Math.ceil() 函数使用介绍
2013/12/11 Javascript
JS实现判断滚动条滚到页面底部并执行事件的方法
2014/12/18 Javascript
jquery通过load获取文件的内容并跳到锚点的方法
2015/01/29 Javascript
返回函数的JavaScript函数
2016/06/14 Javascript
JavaScript与JQUERY获取元素的宽、高和位置
2017/02/26 Javascript
JavaScript实现简单精致的图片左右无缝滚动效果
2017/03/16 Javascript
浅谈vue项目优化之页面的按需加载(vue+webpack)
2017/12/11 Javascript
基于vue-ssr服务端渲染入门详解
2018/01/08 Javascript
nuxt框架中对vuex进行模块化设置的实现方法
2019/09/06 Javascript
vue.js购物车添加商品组件的方法
2019/09/17 Javascript
javascript中的with语句学习笔记及用法
2020/02/17 Javascript
Vue动态加载图片在跨域时无法显示的问题及解决方法
2020/03/10 Javascript
js实现缓动动画
2020/11/25 Javascript
Python sys.path详细介绍
2013/10/17 Python
浅谈Python的垃圾回收机制
2016/12/17 Python
Python下载网络文本数据到本地内存的四种实现方法示例
2018/02/05 Python
python时间日期函数与利用pandas进行时间序列处理详解
2018/03/13 Python
python实现电脑自动关机
2018/06/20 Python
python 实现A*算法的示例代码
2018/08/13 Python
canvas实现漂亮的下雨效果的示例
2018/04/18 HTML / CSS
优质的学校老师推荐信
2013/10/28 职场文书
医院办公室主任职责
2013/12/29 职场文书
更夫岗位责任制
2014/02/11 职场文书
《鸟的天堂》教学反思
2014/02/27 职场文书
《乞巧》教学反思
2014/02/27 职场文书
廉洁自律演讲稿
2014/05/22 职场文书
酒店保洁员岗位职责
2015/02/26 职场文书
门球健将观后感
2015/06/16 职场文书
大学生暑期实践报告
2015/07/13 职场文书
java设计模式--原型模式详解
2021/07/21 Java/Android
redis 存储对象的方法对比分析
2021/08/02 Redis
Java实现HTML转为Word的示例代码
2022/06/28 Java/Android