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


Posted in Javascript onApril 17, 2016

前一篇:JS模块化工具我们以非常简单的方式引入了requirejs:https://3water.com/article/82527.htm,这一篇将讲述一下requirejs中的一些基本知识,包括API使用方式等

基本API

require会定义三个变量:define,require,requirejs,其中require === requirejs,一般使用require更简短

define 从名字就可以看出这个api是用来定义一个模块
require 加载依赖模块,并执行加载完后的回调函数
前一篇中的a.js:

define(function(){
  function fun1(){
   alert("it works");
  }
  fun1();
})

 通过define函数定义了一个模块,然后再页面中使用:

require(["js/a"]);
来加载该模块(注意require中的依赖是一个数组,即使只有一个依赖,你也必须使用数组来定义),requir API的第二个参数是callback,一个function,是用来处理加载完毕后的逻辑,如:

require(["js/a"],function(){
  alert("load finished");
})

加载文件

之前的例子中加载模块都是本地js,但是大部分情况下网页需要加载的JS可能来自本地服务器、其他网站或CDN,这样就不能通过这种方式来加载了,我们以加载一个jquery库为例:

require.config({
  paths : {
    "jquery" : ["http://libs.baidu.com/jquery/2.0.3/jquery"] 
  }
})
require(["jquery","js/a"],function($){
  $(function(){
    alert("load finished"); 
  })
})

这边涉及了require.config,require.config是用来配置模块加载位置,简单点说就是给模块起一个更短更好记的名字,比如将百度的jquery库地址标记为jquery,这样在require时只需要写["jquery"]就可以加载该js,本地的js我们也可以这样配置:

require.config({
  paths : {
    "jquery" : ["http://libs.baidu.com/jquery/2.0.3/jquery"],
    "a" : "js/a" 
  }
})
require(["jquery","a"],function($){
  $(function(){
    alert("load finished"); 
  })
})

通过paths的配置会使我们的模块名字更精炼,paths还有一个重要的功能,就是可以配置多个路径,如果远程cdn库没有加载成功,可以加载本地的库,如:

require.config({
  paths : {
    "jquery" : ["http://libs.baidu.com/jquery/2.0.3/jquery", "js/jquery"],
    "a" : "js/a" 
  }
})
require(["jquery","a"],function($){
  $(function(){
    alert("load finished"); 
  })
})

这样配置后,当百度的jquery没有加载成功后,会加载本地js目录下的jquery

在使用requirejs时,加载模块时不用写.js后缀的,当然也是不能写后缀
上面例子中的callback函数中发现有$参数,这个就是依赖的jquery模块的输出变量,如果你依赖多个模块,可以依次写入多个参数来使用:

require(["jquery","underscore"],function($, _){
  $(function(){
    _.each([1,2,3],alert);
  })
})

如果某个模块不输出变量值,则没有,所以尽量将输出的模块写在前面,防止位置错乱引发误解

全局配置

上面的例子中重复出现了require.config配置,如果每个页面中都加入配置,必然显得十分不雅,requirejs提供了一种叫"主数据"的功能,我们首先创建一个main.js:

require.config({
  paths : {
    "jquery" : ["http://libs.baidu.com/jquery/2.0.3/jquery", "js/jquery"],
    "a" : "js/a" 
  }
})

然后再页面中使用下面的方式来使用requirejs:

<script data-main="js/main" src="js/require.js"></script>
解释一下,加载requirejs脚本的script标签加入了data-main属性,这个属性指定的js将在加载完reuqire.js后处理,我们把require.config的配置加入到data-main后,就可以使每一个页面都使用这个配置,然后页面中就可以直接使用require来加载所有的短模块名

data-main还有一个重要的功能,当script标签指定data-main属性时,require会默认的将data-main指定的js为根路径,是什么意思呢?如上面的data-main="js/main"设定后,我们在使用require(['jquery'])后(不配置jquery的paths),require会自动加载js/jquery.js这个文件,而不是jquery.js,相当于默认配置了:

require.config({
  baseUrl : "js"
})

第三方模块

通过require加载的模块一般都需要符合AMD规范即使用define来申明模块,但是部分时候需要加载非AMD规范的js,这时候就需要用到另一个功能:shim,shim解释起来也比较难理解,shim直接翻译为"垫",其实也是有这层意思的,目前我主要用在两个地方

1. 非AMD模块输出,将非标准的AMD模块"垫"成可用的模块,例如:在老版本的jquery中,是没有继承AMD规范的,所以不能直接require["jquery"],这时候就需要shim,比如我要是用underscore类库,但是他并没有实现AMD规范,那我们可以这样配置

require.config({
  shim: {
    "underscore" : {
      exports : "_";
    }
  }
})

这样配置后,我们就可以在其他模块中引用underscore模块:

require(["underscore"], function(_){
  _.each([1,2,3], alert);
})

插件形式的非AMD模块,我们经常会用到jquery插件,而且这些插件基本都不符合AMD规范,比如jquery.form插件,这时候就需要将form插件"垫"到jquery中:

require.config({
  shim: {
    "underscore" : {
      exports : "_";
    },
    "jquery.form" : {
      deps : ["jquery"]
    }
  }
})

也可以简写为:

require.config({
  shim: {
    "underscore" : {
      exports : "_";
    },
    "jquery.form" : ["jquery"]
  }
})

这样配置之后我们就可以使用加载插件后的jquery了

require.config(["jquery", "jquery.form"], function($){
  $(function(){
    $("#form").ajaxSubmit({...});
  })
})

好了,requirejs的基本配置大致就是这么多,还有一些扩展的功能会在之后的篇幅中提到,大家不要错过呀!

Javascript 相关文章推荐
可以把编码转换成 gb2312编码lib.UTF8toGB2312.js
Aug 21 Javascript
setAttribute 与 class冲突解决
Feb 17 Javascript
细品javascript 寻址,闭包,对象模型和相关问题
Apr 27 Javascript
实例讲解JS中数组Array的操作方法
May 09 Javascript
详解JavaScript UTC时间转换方法
Jan 07 Javascript
jQuery Easyui datagrid/treegrid 清空数据
Jul 09 Javascript
JQuery EasyUI学习教程之datagrid 添加、修改、删除操作
Jul 09 Javascript
详解JS获取HTML DOM元素的8种方法
Jun 17 Javascript
element-ui中的select下拉列表设置默认值方法
Aug 24 Javascript
AngularJS 多指令Scope问题的解决
Oct 25 Javascript
JS实现继承的几种常用方式示例
Jun 22 Javascript
微信小程序实现打开并下载服务器上面的pdf文件到手机
Sep 20 Javascript
第一次接触JS require.js模块化工具
Apr 17 #Javascript
jqGrid 学习笔记整理——进阶篇(一 )
Apr 17 #Javascript
JS组件Bootstrap dropdown组件扩展hover事件
Apr 17 #Javascript
理解javascript对象继承
Apr 17 #Javascript
node.js连接mongoDB数据库 快速搭建自己的web服务
Apr 17 #Javascript
js如何准确获取当前页面url网址信息
Sep 13 #Javascript
基于javascript实现图片切换效果
Apr 17 #Javascript
You might like
php中$_SERVER[PHP_SELF] 和 $_SERVER[SCRIPT_NAME]之间的区别
2009/09/05 PHP
在PHP中养成7个面向对象的好习惯
2010/07/17 PHP
服务器变量 $_SERVER 的深入解析
2013/07/02 PHP
yii2.0之GridView自定义按钮和链接用法
2014/12/15 PHP
php7新特性的理解和比较总结
2019/04/14 PHP
Yii框架多语言站点配置方法分析【中文/英文切换站点】
2020/04/07 PHP
node.js中的buffer.Buffer.byteLength方法使用说明
2014/12/10 Javascript
jQuery实现视频作为全屏幕背景
2014/12/18 Javascript
input输入框鼠标焦点提示信息
2015/03/17 Javascript
JQUERY简单按钮轮换选中效果实现方法
2015/05/07 Javascript
比例尺、缩略图、平移缩放之百度地图添加控件方法
2015/08/03 Javascript
jQuery深拷贝Json对象简单示例
2016/07/06 Javascript
微信小程序 聊天室简单实现
2017/04/19 Javascript
Vue组件模板形式实现对象数组数据循环为树形结构(实例代码)
2017/07/31 Javascript
JavaScript输入分钟、秒倒计时技巧总结(附代码)
2017/08/17 Javascript
利用Node.js检测端口是否被占用的方法
2017/12/07 Javascript
基于Three.js实现360度全景图片
2018/12/30 Javascript
Vue el-autocomplete远程搜索下拉框并实现自动填充功能(推荐)
2019/10/25 Javascript
VueX模块的具体使用(小白教程)
2020/06/05 Javascript
[05:06]2017亚洲邀请赛DAC回顾片
2017/04/19 DOTA
Python生成数字图片代码分享
2017/10/31 Python
75条笑死人的知乎神回复,用60行代码就爬完了
2019/05/06 Python
django url到views参数传递的实例
2019/07/19 Python
Python解析命令行读取参数之argparse模块
2019/07/26 Python
Python3 文章标题关键字提取的例子
2019/08/26 Python
Pycharm 跳转回之前所在页面的操作
2021/02/05 Python
介绍一下Java中标识符的命名规则
2014/02/03 面试题
歌唱比赛主持词
2014/03/18 职场文书
学校安全工作汇报材料
2014/08/16 职场文书
工作总结与自我评价
2014/09/18 职场文书
教师求职信怎么写
2015/03/20 职场文书
污水处理保证书
2015/05/09 职场文书
主持人开场白台词
2015/05/29 职场文书
同学聚会致辞集锦
2015/07/28 职场文书
市场营销计划书
2019/04/24 职场文书
JavaScript canvas实现流星特效
2021/05/20 Javascript