非官方文档,整理来自己官方文档的文字与实例,方便速查。
seajs.config Object
alias Object
别名配置,配置之后可在模块中使用require调用 require('jquery');
seajs.config({
alias: { 'jquery': 'jquery/jquery/1.10.1/jquery' }
});define(function(require, exports, module) {
//引用jQuery模块
var $ = require('jquery');
});
paths Object
设置路径,方便跨目录调用。通过灵活的设置path可以在不影响base
的情况下指定到某个目录。
seajs.config({
//设置路径
paths: {
'gallery': 'https://a.alipayobjects.com/gallery'
},// 设置别名,方便调用
alias: {
'underscore': 'gallery/underscore'
}
});
vars Object
变量配置。有些场景下,模块路径在运行时才能确定,这时可以使用 vars
变量来配置。
vars
配置的是模块标识中的变量值,在模块标识中用 {key}
来表示变量。
seajs.config({ // 变量配置 vars: { 'locale': 'zh-cn' } }); define(function(require, exports, module) { var lang = require('./i18n/{locale}.js'); //=> 加载的是 path/to/i18n/zh-cn.js });
map Array
该配置可对模块路径进行映射修改,可用于路径转换、在线调试等。
seajs.config({ map: [ [ '.js', '-debug.js' ] ] }); define(function(require, exports, module) { var a = require('./a'); //=> 加载的是 path/to/a-debug.js });
preload Array
使用preload配置项,可以在普通模块加载前,提前加载并初始化好指定模块。
// 在老浏览器中,提前加载好 ES5 和 json 模块 seajs.config({ preload: [ Function.prototype.bind ? '' : 'es5-safe', this.JSON ? '' : 'json' ] });
seajs.config({
preload: 'a'
});// 在加载 b 之前,会确保模块 a 已经加载并执行好
seajs.use('./b');
seajs.config({
preload: 'a'
});define(function(require, exports) {
// 此处执行时,不能保证模块 a 已经加载并执行好
});
debug Boolean
值为true时,加载器不会删除动态插入的 script 标签。插件也可以根据debug配置,来决策 log 等信息的输出。
base String
Sea.js 在解析顶级标识时,会相对 base 路径来解析。
charset String|Function
获取模块文件时,<script> 或 <link> 标签的charset属性。 默认是utf-8
charset还可以是一个函数:
seajs.config({
charset: function(url) {
// xxx 目录下的文件用 gbk 编码加载
if (url.indexOf('http://example.com/js/xxx') === 0) {
return 'gbk';
}// 其他文件用 utf-8 编码
return 'utf-8';
}
});
seajs.use Function
用来在页面中加载一个或多个模块。seajs.use(id, callback?)
// 加载一个模块
seajs.use('./a');// 加载一个模块,在加载完成时,执行回调
seajs.use('./a', function(a) {
a.doSomething();
});// 加载多个模块,在加载完成时,执行回调
seajs.use(['./a', './b'], function(a, b) {
a.doSomething();
b.doSomething();
});
seajs.use(['jquery', './main'], function($, main) { $(document).ready(function() { main.init(); }); });
var bootstrap = ['bootstrap.css', 'bootstrap-responsive.css', 'bootstrap.js'];
seajs.use(bootstrap, function() {
//do something
});
seajs.cache Ojbect
通过 seajs.cache,可以查阅当前模块系统中的所有模块信息。
比如,打开 seajs.org,然后在 WebKit Developer Tools 的 Console 面板中输入 seajs.cache,可以看到:
Object > http://seajs.org/docs/assets/main.js: x > https://a.alipayobjects.com/jquery/jquery/1.10.1/jquery.js: x > __proto__: Object
这些就是文档首页用到的模块。展开某一项可以看到模块的具体信息,含义可参考:CMD模块定义规范 中的 module 小节。
seajs.reslove Function
类似require.resolve,会利用模块系统的内部机制对传入的字符串参数进行路径解析。
seajs.resolve('jquery');
// => http://path/to/jquery.jsseajs.resolve('./a', 'http://example.com/to/b.js');
// => http://example.com/to/a.js
seajs.data Object
通过 seajs.data,可以查看 seajs 所有配置以及一些内部变量的值,可用于插件开发。当加载遇到问题时,也可用于调试。
常见问题
关于模块标识
Seajs模块标识主要以小驼峰字符串、.或..
// 在 http://example.com/js/a.js 的 factory 中:
require.resolve('./b');
// => http://example.com/js/b.js// 在 http://example.com/js/a.js 的 factory 中:
require.resolve('../c');
// => http://example.com/c.js
分为 相对 与 顶级 标识。以.或..开头,则为相对标识 。以小驼峰字符串开关,则为顶级标识。
// 假设 base 路径是:http://example.com/assets/
// 在模块代码里:
require.resolve('gallery/jquery/1.9.1/jquery');
// => http://example.com/assets/gallery/jquery/1.9.1/jquery.js
关于路径
Seajs除了相对与顶级标识之外,还可以使用普通路径来加载模块。
就到当前页面的脚本分析(可以右键查看源码)
//sea.js的路径,即 base 路径,相对于当前页面
<script src="http://yslove.net/actjs/assets/sea-modules/seajs/2.1.1/sj.js"></script><script type="text/javascript">
//配置Seajs
seajs.config({
alias: {
//顶级标识,基于 base 路径
'actjs': 'actjs/core/0.0.7/core.js',
// => http://
'position': 'actjs/util/0.0.2/position.js'
}
});seajs.config({
alias: {
//普通路径,相对于当前页面
'affix': '../../actjs/assets/widget/src/widget-affix.js',//相对标识,相对于当前页面
'init': './src/init.js'
}
});
</script>
参考:
CMD 模块定义规范 【define定义模块】