最近在看公司项目的时候,对requireJS的define的路径有一定的困惑,通过查阅资料做一下总结:
requirejs中无论是通过define来定义模块,还是通过require来加载模块,模块依赖声明都是很重要的一步。假设我们的目录结构如下:
demo.html js/main.js js/lib.js js/util.js js/common/lib.js js/common/jqury/lib.js common/lib.js
- baseUrl
在requirejs的模块路径解析里, baseUrl
是非常基础的概念,离开了它,基本就玩不转了,所以这里简单介绍一下。简单的说, baseUrl
指定了一个目录,然后requirejs基于这个目录来寻找依赖的模块。
在demo.html里加载requirejs,同时在requirejs所在的script上声明 data-main
属性,那么,requirejs加载下来后,它会做两件事件:
- 加载js/main.js
- 将baseUrl设置为data-main指定的文件所在的路径,这里是 js/
那么,下面依赖的lib模块的实际路径为 js/lib.js
main.js
require(['lib'], function(Lib){ // do sth});
除了 data-main
属性,你也可以手动配置 baseUrl
,比如下面例子。需要强调的是: 如果没有通过 data-main
属性指定 baseUrl
,也没有通过config的方式显示声明 baseUrl
,那么 baseUrl
默认为加载requirejs的那个页面所在的路径
demo.html
main.js
requirejs.config({ baseUrl: 'js'});require(['lib'], function(Lib){ // do sth});
- baseUrl+path:让依赖更加简洁、灵活
- 费力气:每个加载的模块前面都有长长的
common/fruits
- 难维护:说不定哪一天目录名就变了(在大型项目中并不算罕见),想象一下目录结构变更带来的工作量
如下:
requirejs.config({ baseUrl: 'js'});// 加载一堆水果require(['common/fruits/apple', 'common/fruits/orange', 'common/fruits/grape', 'common/fruits/pears'], function(Apple, Orange, Grape, Pears){ // do sth});
将其修改为如下内容:
requirejs.config({ baseUrl: 'js', paths: { fruits: 'common/fruits' }});// 加载一堆水果require(['fruits/apple', 'fruits/orange', 'fruits/grape', 'fruits/pears'], function(Apple, Orange, Grape, Pears){ // do sth});
当项目结构变更时,好处就体现了。假设 common/fruits
某一天突然变成了 common/third-party/fruits
,那很简单,改下 paths
就可以了。
- path:简单但是实用
apple
:没有在paths规则里定义,于是为 baseUrl + apple.js => js/apple.jscommon/fruits
:common已经在paths里定义,于是为baseUrl + common/fruits + apple.js => js/common/fruits/apple.js../common/apple
:common尽管已经在paths里定义,但是../common/apple
并不是以common开头,于是为 baseUrl + ../common/apple.js => common/apple.js
1 requirejs.config({ 2 baseUrl: 'js', 3 paths: { 4 common: 'common/fruits' 5 } 6 }); 7 8 // 从左到右,加载的路径依次为 js/lib.js、 js/common/jquery/lib.js、common/lib.js 9 require(['apple', 'common/apple', '../common/apple'], function(){10 // do something11 });
- ./medole:疑惑的相对路径
1、demo1
js/main.js
requirejs.config({ baseUrl: 'js/common'});// 实际加载的路径都是是 js/common/lib.jsrequire(['./lib', 'lib'], function(Lib){ Lib.say('hello');});
2、demo2
简单改下上面的例子,可以看到:通过 define
定义模块A时,模块A依赖的模块B,如果是 ./module
形式,则基于模块A所在目录解析模块B的路径。
js/main.js
requirejs.config({ baseUrl: 'js'});// 依赖lib.js,实际加载的路径是 js/common/lib.js,而lib模块又依赖于util模块('./util'),解析后的实际路径为 js/common/util.jsrequire(['common/lib'], function(Lib){ Lib.say('hello');});
js/lib.js
// 依赖util模块define(['./util'], function(Util){ return { say: function(msg){ Util.say(msg); } };});
3、demo 3
demo2实际上会有特例,比如下面,lib模块依赖的util模块,最终解析出来的路径是 js/util.js
main.js
requirejs.config({ baseUrl: 'js', paths: { lib: 'common/lib' }});// 实际加载的路径是 js/common/lib.jsrequire(['lib'], function(Lib){ Lib.say('hello');});
lib.js
// util模块解析后的路径为 js/util.jsdefine(['./util'], function(Lib){ return { say: function(msg){ Lib.say(msg); } };});
4、demo 4
./module
路径解析就会按照 baseUrl
+ moduleName
的方式,但稍微修改下main.js,发现结果就不一样了。此时,util模块对应的路径为 js/common/util.js
main.js
requirejs.config({ baseUrl: 'js', paths: { common: 'common' }});// 实际加载的路径是 js/common/lib.jsrequire(['common/lib'], function(Lib){ Lib.say('hello');});
lib.js
define(['./util'], function(Lib){ return { say: function(msg){ Lib.say(msg); } };});
requirejs中的路径解析整体上不复杂,但 ./module
这种形式的路径解析,总之,就是不要让requirejs感到困惑,让其寻找baseUrl。
另外,如果../module则表示在当前路径回退两个文件层。