Seajs 简易文档 提供简单、极致的模块化开发体验
非官方文档,整理来自己文档的文字与实例,方便速查。
为什么使用 sea.js ?
sea.js 追求简单、自然的代码书写和组织方式,具有以下核心特性:
简单友好的模块定义规范:sea.js 遵循 cmd 规范,可以像 node.js 一般书写模块代码。
自然直观的代码组织方式:依赖的自动加载、配置的简洁清晰,可以让我们更多地享受编码的乐趣。
sea.js 还提供常用插件,非常有助于开发调试和性能优化,并具有丰富的可扩展接口。
兼容性
sea.js 具备完善的测试用例,兼容所有主流浏览器:
chrome 3+
firefox 2+
safari 3.2+
opera 10+
ie 5.5+
sea.js 可运行在 mobile 端,包括 hybrid 模式的 app 上。理论上,sea.js 可以运行在任何浏览器引擎上。
seajs.configobject
alias object
别名配置,配置之后可在模块中使用require调用 require('jquery');
paths object
设置路径,方便跨目录调用。通过灵活的设置path可以在不影响base的情况下指定到某个目录。
vars object
变量配置。有些场景下,模块路径在运行时才能确定,这时可以使用 vars 变量来配置。
vars 配置的是模块标识中的变量值,在模块标识中用 {key} 来表示变量。
map array
该配置可对模块路径进行映射修改,可用于路径转换、在线调试等。
preload array
使用preload配置项,可以在普通模块加载前,提前加载并初始化好指定模块。
preload中的空字符串会被忽略掉。
注意:preload中的配置,需要等到 use 时才加载。比如:
preload 配置不能放在模块文件里面:
debug boolean
值为true时,加载器不会删除动态插入的 script 标签。插件也可以根据debug配置,来决策 log 等信息的输出。
basestring
sea.js 在解析*标识时,会相对 base 路径来解析。
注意:一般请不要配置 base 路径,把 sea.js 放在合适的路径往往更简单一致。
charsetstring | function
获取模块文件时,<script> 或 <link> 标签的charset属性。 默认是utf-8
charset还可以是一个函数:
seajs.use function
用来在页面中加载一个或多个模块。seajs.use(id, callback?)
注意:seajs.use 与 dom ready 事件没有任何关系。如果某些操作要确保在 dom ready 后执行,需要使用 jquery 等类库来保证。比如
注意:use方法第一个参数一定要有,但是可以是null,也可以是一个变量
seajs.cache ojbect
通过 seajs.cache,可以查阅当前模块系统中的所有模块信息。
比如,打开 seajs.org,然后在 webkit developer tools 的 console 面板中输入 seajs.cache,可以看到:
这些就是文档首页用到的模块。展开某一项可以看到模块的具体信息,含义可参考:cmd 模块定义规范 中的 module 小节。
seajs.reslove function
类似require.resolve,会利用模块系统的内部机制对传入的字符串参数进行路径解析。
seajs.resolve 方法不光可以用来调试路径解析是否正确,还可以用在插件开发环境中。
seajs.data object
通过 seajs.data,可以查看 seajs 所有配置以及一些内部变量的值,可用于插件开发。当加载遇到问题时,也可用于调试。
常见问题
关于模块标识
seajs模块标识主要以小驼峰字符串、.或..
分为 相对 与 * 标识。以.或..开头,则为相对标识 。以小驼峰字符串开关,则为*标识。
关于路径
seajs除了相对与*标识之外,还可以使用普通路径来加载模块。
就到当前页面的脚本分析(可以右键查看源码)
开始的时候会觉得seajs的路径有点不习惯,由其是base路径。切记base路径就是sea.js的那个文件的上级路径,然后所有*标识,相对标识都是相对于这个base来调整。
上一篇: 面试题大本营
下一篇: 实现原生js实现轮播图