seajs中模块的解析规则详解和模块使用总结


Posted in Javascript onMarch 12, 2014

seajs github 模块标识已经说的相对清楚了。但并没有面面俱到,特别是当你需要手写 【模块ID】和【模块依赖】的时候,或者自己写自动化工具来做 transport 的时候(ps:spm貌似适应性不是很强也不易用,毕竟每个项目的目录结构可能相差很大,且不易改变。当然如果他的定位是包管理工具就别指望它来做你的项目的自动化构建工具了),ID的解析规则就需要了解透彻了。
注意事项:
1. 顶级标识始终相对 base 基础路径解析。
2. 绝对路径和根路径始终相对当前页面解析。
3. require 和 require.async 中的相对路径相对当前模块路径来解析。
4. seajs.use 中的相对路径始终相对当前页面来解析。

seajs中,模块的ID大致可分为三种:【相对标识】、【顶级标识】、【普通路径】,
普通路径包括 “绝对路径”、“根路径”,等。

这里重点说明 【相对标识】 和 【顶级标识】。
相对标识 是指 "./","../" 开头的,如:"./OtherModule", "../lib/Base"。
顶级标识 是指 以文件或目录(可以包含:字母、-、_)开头的,如:"app/widget/Select"

需要写模块ID的地方有三处:

define("id (1)",["../id2 (2)"], function(require, exports, module){
    var moduleA = require('./moduleA (3)');
})

注意:无论是define第一个参数【模块ID】还是第二个参数【依赖模块的ID】还是【require模块ID】,最终的比对标准是【解析后的文件URI】。
因此,这三处需要写ID 的地方可以以任意一种方式来写,只要最终解析为同一个URI,即被认为是同一个模块。
在解析ID的过程中,会预先经过 seajs.config 中定义的 alias 和 paths 的处理。

base 路径解析规则
(第 1 层,本身的路径不依赖于任何设置)
1. 不可使用【顶级标识】,因为顶级标识就是相对于 base 基础路径来解析的,因此 base 本身只能使用【相对标识】或【根路径】等。
2. base 默认路径为 seajs 的目录,其他情况参见seajs官网,如果不是seajs推荐的源码目录结构,尽量手动设置 base 路径。
3. 【相对标识】:相对于 当前页面 解析。
paths 中路径解析规则
(第 1 层,本身的路径不依赖于任何设置)
1. 【相对标识】:在哪里被引用,相对的解析位置视被引用的地方而定,遵循当地的规则。
2. paths中的字段会被以变量的方式在被使用的地方替换,然后再解析。
比如:

//代码块(1)
//path定义:
seajs.config({
    base:"./app/src",
    path:{
        "a":"../lib", //(1) 相对路径
        "lib":"path/to/lib", //(2) 顶级标识
        "l2":"/lib" //(3) 根路径
    }
});
//模块 mod/m/m.js: 
...
require("a/jquery");
//=> 转换为:"../../lib/jquery"
//=> 加载:mod/lib/jquery (特别注意 1)
...
//模块 mod/f.js:
...
require("a/jquery");
//=> 转换为:"../../lib/jquery"
//=> 加载:lib/jquery (特别注意 2)
...

alias 中路径解析规则
(第 2 层,本身的路径可以依赖于paths的设置)
1. alias 的规则类似于 paths,并且 alias 路径也可以使用 paths 中的“变量”
2. 提醒:paths、alias 中尽量使用【顶级标识】、【根路径】、【绝对路径】,不要使用【相对标识】,因为在不同深度的模块引用时会解析为不同的路径。
3. 【相对标识】:在哪里被引用,相对的解析位置视被引用的地方而定,遵循当地的规则。
seajs.use 路径解析规则
【相对标识】:相对于 当前页面 解析。
define 定义模块 ID 解析规则 (1)

(第 3 层,路径可以相对于 alias 或 paths 来设置)
可以使用:【相对标识】、【顶级标识】、【根路径】
推荐使用【顶级标识】,如果模块的位置不在 base 基础路径内,则使用【相对标识】或【根路径】。
【相对标识】:相对 当前页面 解析

// 代码块(2)
//config -- 还使用 [代码块 (1)]中的配置
// 模块1,无歧义,根路径解析
define("/app/src/module/Base", ..);
// 模块2,无歧义,顶级标识,相对于 base 基础路径来解析
define("app/src/module/Base", ..);
// 模块3,有歧义,相对标识,此处相对于 当前页面(引用到这个模块的html页面)
// 但其他地方即便使用 【表面上相同的“ID”】,也可能会被解析不同的模块
define("./app/src/module/Base",..);

模块依赖ID 解析规则 (2)

(第 3 层,路径可以相对于 alias 或 paths 来设置)
【相对标识】:相对 base 基础路径解析

//代码块(3)
//config -- 还使用 [代码块 (1)]中的配置
//无歧义,相对于根路径解析
define("..", ["/app/src/module/Base"], ..)
// 无歧义,顶级标识,相对于 base 基础路径解析
define("..", ["app/src/module/Base"], ..)
//有歧义,相对标识,此处相对于 当前模块 来解析
//此处的依赖看起来是依赖于【代码块(2)】中的 `模块3`
//但如果当前模块跟当前页面不在同一层目录下,就不会被解析为 `模块3`

define("..", ["./app/src/module/Base"],..)
模块内 require 其他模块的ID 解析规则 (3)
(第 3 层,路径可以相对于 alias 或 paths 来设置)
【相对标识】:相对 base 基础路径解析
//代码块(4)
//config -- 还使用 [代码块 (1)]中的配置
define("..", [..], function(require){
    //无歧义,相对于根路径解析
    require("/app/src/module/Base");
});
define("..", [..], function(require){
    // 无歧义,顶级标识,相对于 base 基础路径解析
    require("app/src/module/Base");
});
define("..", [..], function(require){
    //有歧义,相对标识,此处相对于 当前模块 来解析
    //此处的依赖看起来是依赖于【代码块(2)】中的 `模块3`
    //但如果当前模块跟当前页面不在同一层目录下,就不会被解析为 `模块3`
    require("./app/src/module/Base");
})

特别提醒:模块内三处需要写ID的地方,不需要使用看起来相同的字符串,只要被解析为相同的模块即可。

总结:
1.paths 和 alias 的设置仅仅相当于一个变量,在哪里使用,就在那里替换为设定的值,然后再解析。
2.尽可能的使用【顶级标识】。
3.如果不能使用【顶级标识】,比如目录跨越比较大等,则尽量设置 alias 或 paths 通过一个【非相对路径】 标识 定位到一个目录,然后在这个标识下,再定义ID。

Javascript 相关文章推荐
js玩一玩WSH吧
Feb 23 Javascript
jquery插件制作教程 txtHover
Aug 17 Javascript
javascript调试过程中找不到哪里出错的可能原因
Dec 16 Javascript
JavaScript中使用自然对数ln的方法
Jun 14 Javascript
jQuery表格插件datatables用法详解
Nov 23 Javascript
Javascript类型系统之undefined和null浅析
Jul 13 Javascript
微信小程序 location API实例详解
Oct 02 Javascript
AngularJS自定义服务与fliter的混合使用
Nov 24 Javascript
js通过指定下标或指定元素进行删除数组的实例
Jan 12 Javascript
详解支持Angular 2的表格控件
Jan 19 Javascript
ES7中利用Await减少回调嵌套的方法详解
Nov 01 Javascript
如何在项目中使用log4.js的方法步骤
Jul 16 Javascript
判断一个对象是否为jquery对象的方法
Mar 12 #Javascript
Jquery实现自定义窗口随意的拖拽
Mar 12 #Javascript
Jquery实现自定义弹窗示例
Mar 12 #Javascript
把jQuery的类、插件封装成seajs的模块的方法
Mar 12 #Javascript
使用js检测浏览器是否支持html5中的video标签的方法
Mar 12 #Javascript
利用Keydown事件阻止用户输入实现代码
Mar 11 #Javascript
JavaScript中奇葩的假值示例应用
Mar 11 #Javascript
You might like
PHP面向对象的使用教程 简单数据库连接
2006/11/25 PHP
windows7下安装php的imagick和imagemagick扩展教程
2014/07/04 PHP
帝国cms常用标签汇总
2015/07/06 PHP
php创建无限级树型菜单
2015/11/05 PHP
php读取XML的常见方法实例总结
2017/04/25 PHP
laravel框架中路由设置,路由参数和路由命名实例分析
2019/11/23 PHP
HTML页面滚动时获取离页面顶部的距离2种实现方法
2013/09/05 Javascript
Javascrip实现文字跳动特效
2016/11/27 Javascript
ES6中数组array新增方法实例总结
2017/11/07 Javascript
JS非行间样式获取函数的实例代码
2018/06/05 Javascript
详解vue添加删除元素的方法
2018/06/30 Javascript
使用electron将vue-cli项目打包成exe的方法
2018/09/29 Javascript
Vuejs监听vuex中值的变化的方法示例
2018/12/02 Javascript
JS执行控制之节流模式实例分析
2018/12/21 Javascript
JQuery中queue方法用法示例
2019/01/31 jQuery
vue框架下部署上线后刷新报404问题的解决方案(推荐)
2019/04/03 Javascript
Node使用Selenium进行前端自动化操作的代码实现
2019/10/10 Javascript
Vue实现星级评价效果实例详解
2019/12/30 Javascript
vue项目创建步骤及路由router
2020/01/14 Javascript
python编程开发之类型转换convert实例分析
2015/11/13 Python
python 顺时针打印矩阵的超简洁代码
2018/11/14 Python
解决pyqt5中QToolButton无法使用的问题
2019/06/21 Python
python脚本定时发送邮件
2020/12/22 Python
利用HTML5的新特点实现图片文件异步上传
2014/05/29 HTML / CSS
美国钻石商店:Zales
2016/11/20 全球购物
ebookers英国:隶属全球最大的在线旅游公司Expedia
2017/12/28 全球购物
Hoka One One法国官网:美国专业跑鞋品牌
2018/12/29 全球购物
高二美术教学反思
2014/01/14 职场文书
企业业务员岗位职责
2014/03/14 职场文书
护士自我鉴定总结
2014/03/24 职场文书
大学生找工作求职信
2014/07/09 职场文书
人事局接收函
2015/01/31 职场文书
听证通知书
2015/04/24 职场文书
公司借条范本
2015/05/25 职场文书
会议承办单位欢迎词
2019/07/09 职场文书
Nginx 反向代理解决跨域问题多种情况分析
2022/01/18 Servers