RequireJS
参考文献: http://www.requirejs.org/docs/api.html
Stop, thinking is the essence of progress.
RequireJS由James Burke创建,他也是AMD规范的创始人。
RequireJS会让你以不同于往常的方式去写JavaScript。你将不再使用script标签在HTML中引入JS文件,以及不用通过script标签顺序去管理依赖关系。
当然也不会有阻塞(blocking)的情况发生。好,以一个简单示例开始。
新建一个目录,结构如下
目录r1下有index.html、jquery-1.7.2.js、main.js、require.js。require.js和jquery-1.7.2.js去各自官网下载即可。
index.html如下
1
2
3
4
5
6
7
8
9
10
11
|
<!doctype html> <html> <head> <title>requirejs入门(一)</title> <meta charset= "utf-8" > <script data-main= "main" src= "require.js" ></script> </head> <body> </body> </html> |
使用requirejs很简单,只需要在head中通过script标签引入它(实际上除了require.js,其它文件模块都不再使用script标签引入)。
细心的同学会发现script标签上了多了一个自定义属性:data-main="main",等号右边的main指的main.js。当然可以使用任意的名称。这个main指主模块或入口模块,好比c或java的主函数main。
main.js如下
1
2
3
4
5
6
7
8
9
|
require.config({ paths: { jquery: 'jquery-1.7.2' } }); require([ 'jquery' ], function ($) { alert($().jquery); }); |
main.js中就两个函数调用require.config和require。
require.config用来配置一些参数,它将影响到requirejs库的一些行为。
require.config的参数是一个JS对象,常用的配置有baseUrl,paths等。
这里配置了paths参数,使用模块名“jquery”,其实际文件路径jquery-1.7.2.js(后缀.js可以省略)。
我们知道jQuery从1.7后开始支持AMD规范,即如果jQuery作为一个AMD模块运行时,它的模块名是“jquery”。注意“jquery”是固定的,不能写“jQuery”或其它。
注:如果文件名“jquery-1.7.2.js”改为“jquery.js”就不必配置paths参数了。
jQuery中的支持AMD代码如下
1
2
3
|
if ( typeof define === "function" && define.amd && define.amd.jQuery ) { define( "jquery" , [], function () { return jQuery; } ); } |
我们知道jQuery最终向外暴露的是全局的jQuery和 $。如下
1
2
|
// Expose jQuery to the global object window.jQuery = window.$ = jQuery; |
如果将jQuery应用在模块化开发时,其实可以不使用全局的,即可以不暴露出来。需要用到jQuery时使用require函数即可,
这里require函数的第一个参数是数组,数组中存放的是模块名(字符串类型),数组中的模块与回调函数的参数一一对应。这里的例子则只有一个模块“jquery”。
把目录r1放到apache或其它web服务器上,访问index.html。
网络请求如下
我们看到除了require.js外main.js和jquery-1.7.2.js也请求下来了。而它们正是通过requirejs请求的。
页面上会弹出jQuery的版本
这是一个很简单的示例,使用requirejs动态加载jquery。使用到了以下知识点
1、data-main属性
2、require.config方法
3、require函数
写一个自己的模块:选择器。
为演示方便这里仅实现常用的三种选择器id,className,attribute。RequireJS使用define来定义模块。
新建目录结构如下
这次新建了一个子目录js,把main.js和selctor.js放入其中,require.js仍然和index.html在同一级目录。
HTML 如下
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
<!doctype html> <html> <head> <title>requirejs入门(二)</title> <meta charset= "utf-8" > <style type= "text/css" > .wrapper { width: 200px; height: 200px; background: gray; } </style> </head> <body> <div class = "wrapper" ></div> <script data-main= "js/main" src= "require.js" ></script> </body> </html> |
这次把script标签放到了div的后面,因为要用选择器去获取页面dom元素,而这要等到dom ready后。
因为把main.js放到js目录中,这里data-main的值须改为“js/main”。
selector.js 如下
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
|
define( function () { function query(selector,context) { var s = selector, doc = document, regId = /^ #[\w\-]+/, regCls = /^([\w\-]+)?\.([\w\-]+)/, regTag = /^([\w\*]+)$/, regNodeAttr = /^([\w\-]+)?\[([\w]+)(=(\w+))?\]/; var context = context == undefined ? document : typeof context == 'string' ? doc.getElementById(context.substr(1,context.length)) : context; if (regId.test(s)) { return doc.getElementById(s.substr(1,s.length)); } // 略... } return query; }); |
define的参数为一个匿名函数,该匿名函数执行后返回query,query为函数类型。query就是选择器的实现函数。
main.js 如下
1
2
3
4
5
6
7
8
|
require.config({ baseUrl: 'js' }); require([ 'selector' ], function (query) { var els = query( '.wrapper' ); console.log(els) }); |
require.config方法执行配置了baseUrl为“js”,baseUrl指的模块文件的根目录,可以是绝对路径或相对路径。这里用的是相对路径。相对路径指引入require.js的页面为参考点,这里是index.html。
把目录r2放到apache或其它web服务器上,访问index.html。
网络请求如下
main.js和selector.js都请求下来了。
selector.js下载后使用query获取页面class为“.wrapper”的元素,控制台输出了该元素。如下
总结:
1、使用baseUrl来配置模块根目录,baseUrl可以是绝对路径也可以是相对路径。
2、使用define定义一个函数类型模块,RequireJS的模块可以是JS对象,函数或其它任何类型(CommonJS/SeaJS则只能是JS对象)。