浅析js的模块化编写 require.js


Posted in Javascript onDecember 07, 2016

requirejs是一个JavaScript文件和模块加载器。requireJS允许你把你的javascript代码独立成文件和模块,同时管理每个模块间的依赖关系。

RequireJS的目标是鼓励代码的模块化,它使用了不同于传统"script"标签的脚本加载步骤。使用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文件。

这样的写法有很大的缺点。

  1. 首先,加载的时候,浏览器会停止网页渲染,加载文件越多,网页失去响应的时间就会越长
  2. 由于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({
 baseUrl: "js/lib",
 paths: {"jquery": "jquery.min", "underscore": "underscore.min", "backbone": "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文件。

有兴趣的朋友可以看下:https://3water.com/article/33346.htm

以上就是本文的全部内容,希望本文的内容对大家的学习或者工作能带来一定的帮助,如果有疑问大家可以留言交流,同时也希望多多支持三水点靠木!

Javascript 相关文章推荐
JavaScript中的Screen屏幕对象
Jan 16 Javascript
javascript 打开页面window.location和window.open的区别
Mar 17 Javascript
jquery offset函数应用实例
Nov 14 Javascript
纯javascript模仿微信打飞机小游戏
Aug 20 Javascript
微信小程序 详解页面跳转与返回并回传数据
Feb 13 Javascript
d3.js入门教程之数据绑定详解
Apr 28 Javascript
Angular2中如何使用ngx-translate进行国际化
May 21 Javascript
angular.js和vue.js中实现函数去抖示例(debounce)
Jan 18 Javascript
Angular使用cli生成自定义文件、组件的方法
Sep 04 Javascript
Node.js从字符串生成文件流的实现方法
Aug 18 Javascript
JS实现简易留言板增删功能
Feb 08 Javascript
JQuery插件tablesorter表格排序实现过程解析
May 28 jQuery
JavaScript中捕获/阻止捕获、冒泡/阻止冒泡方法
Dec 07 #Javascript
纯JS焦点图特效实例(可一个页面多用)
Dec 07 #Javascript
探究JavaScript中的五种事件处理程序方式
Dec 07 #Javascript
jquery 删除节点 添加节点 找兄弟节点的简单实现
Dec 07 #Javascript
jquery插入兄弟节点的操作方法
Dec 07 #Javascript
Bootstrap基本样式学习笔记之表格(2)
Dec 07 #Javascript
jquery的父、子、兄弟节点查找,节点的子节点循环方法
Dec 07 #Javascript
You might like
php 购物车实例(申精)
2009/05/11 PHP
php分页思路以及在ZF中的使用
2012/05/30 PHP
PHP基础陷阱题(变量赋值)
2012/09/12 PHP
ThinkPHP模板IF标签用法详解
2014/07/01 PHP
老生常谈ThinkPHP中的行为扩展和插件(推荐)
2017/05/05 PHP
Laravel模型间关系设置分表的方法示例
2018/04/21 PHP
PHP获取远程http或ftp文件的md5值的方法
2019/04/15 PHP
tp5 实现列表数据根据状态排序
2019/10/18 PHP
ExtJS 工具栏 分页事件参数
2010/03/05 Javascript
表单验证的完整应用案例探讨
2013/03/29 Javascript
js给网页加上背景音乐及选择音效的方法
2015/03/03 Javascript
把普通对象转换成json格式的对象的简单实例
2016/07/04 Javascript
微信小程序判断用户是否需要再次授权获取个人信息
2019/07/18 Javascript
js实现3D旋转效果
2020/08/18 Javascript
H5 js点击按钮复制文本到粘贴板
2020/11/19 Javascript
JavaScript 防抖和节流遇见的奇怪问题及解决
2020/11/20 Javascript
vue使用echarts图表自适应的几种解决方案
2020/12/04 Vue.js
[09:34]2018DOTA2国际邀请赛寻真——永不放弃的iG
2018/08/14 DOTA
Python深入学习之上下文管理器
2014/08/31 Python
Python基础语法(Python基础知识点)
2016/02/28 Python
python实现员工管理系统
2018/01/11 Python
Python学习笔记之读取文件、OS模块、异常处理、with as语法示例
2019/06/04 Python
在Django中实现添加user到group并查看
2019/11/18 Python
pyqt5数据库使用详细教程(打包解决方案)
2020/03/25 Python
python+requests接口压力测试500次,查看响应时间的实例
2020/04/30 Python
Python 实现3种回归模型(Linear Regression,Lasso,Ridge)的示例
2020/10/15 Python
Cecil Mode法国在线商店:女性时尚
2021/01/08 全球购物
大学新生军训个人的自我评价
2013/10/03 职场文书
考试作弊被抓检讨书
2014/01/10 职场文书
暑期社会实践感言
2014/02/25 职场文书
酒店管理求职信
2014/06/09 职场文书
民族团结演讲稿范文
2014/08/27 职场文书
中学生检讨书范文
2014/11/03 职场文书
2014年化验员工作总结
2014/11/18 职场文书
使用SQL实现车流量的计算的示例代码
2022/02/28 SQL Server
AJAX引擎原理以及XmlHttpRequest对象的axios、fetch区别详解
2022/04/09 Javascript