Seajs提供简单、极致的模块化开发体验

本文详细介绍了Sea.js的配置选项,包括别名、路径、变量、映射及预加载配置,并解释了如何使用seajs.use加载模块。此外还涵盖了调试技巧和一些常见问题的解答。

seajs.configObject

aliasObject

别名配置,配置之后可在模块中使用require调用 require('jquery');

 
1seajs.config({
2    alias: { 'jquery': 'jquery/jquery/1.10.1/jquery' }
3});
4define(function(require, exports, module) {
5    //引用jQuery模块
6    var $ = require('jquery');
7});

pathsObject

设置路径,方便跨目录调用。通过灵活的设置path可以在不影响base的情况下指定到某个目录。

01 seajs.config({
02     //设置路径
03     paths: {
04         'gallery''https://a.alipayobjects.com/gallery'
05     },
06  
07     // 设置别名,方便调用
08     alias: {
09         'underscore''gallery/underscore'
10     }
11 });
12 define(function(require, exports, module) {
13     var _ = require('underscore');
14      //=> 加载的是 https://a.alipayobjects.com/gallery/underscore.js
15 });

 

varsObject

变量配置。有些场景下,模块路径在运行时才能确定,这时可以使用 vars 变量来配置。

vars 配置的是模块标识中的变量值,在模块标识中用 {key} 来表示变量。

01 seajs.config({
02     // 变量配置
03     vars: {
04         'locale''zh-cn'
05     }
06 });
07 define(function(require, exports, module) {
08   var lang = require('./i18n/{locale}.js');
09      //=> 加载的是 path/to/i18n/zh-cn.js
10 });

 

mapArray

该配置可对模块路径进行映射修改,可用于路径转换、在线调试等。

1 seajs.config({
2     map: [
3         '.js''-debug.js' ]
4     ]
5 });
6 define(function(require, exports, module) {
7     var a = require('./a');
8     //=> 加载的是 path/to/a-debug.js
9 });

 

preloadArray

使用preload配置项,可以在普通模块加载前,提前加载并初始化好指定模块。

preload中的空字符串会被忽略掉。
// 在老浏览器中,提前加载好 ES5 和 json 模块
 
1seajs.config({
2    preload: [
3        Function.prototype.bind ? '' : 'es5-safe',
4        this.JSON ? '' : 'json'
5    ]
6});
注意:preload中的配置,需要等到 use 时才加载。比如:
01 seajs.config({
02     preload: 'a'
03 });
04  
05 // 在加载 b 之前,会确保模块 a 已经加载并执行好
06 seajs.use('./b');
07 preload 配置不能放在模块文件里面:
08 seajs.config({
09     preload: 'a'
10 });
11  
12 define(function(require, exports) {
13     // 此处执行时,不能保证模块 a 已经加载并执行好
14 });
 

debugBoolean

值为true时,加载器不会删除动态插入的 script 标签。插件也可以根据debug配置,来决策 log 等信息的输出。

baseString

Sea.js 在解析顶级标识时,会相对 base 路径来解析。

注意:一般请不要配置 base 路径,把 sea.js 放在合适的路径往往更简单一致。

charseString | Function

获取模块文件时,<script> 或 <link> 标签的charset属性。 默认是utf-8

charset还可以是一个函数:

01 seajs.config({
02     charset: function(url) {
03         // xxx 目录下的文件用 gbk 编码加载
04         if (url.indexOf('http://example.com/js/xxx') === 0) {
05           return 'gbk';
06         }
07  
08         // 其他文件用 utf-8 编码
09         return 'utf-8';
10     }
11 });

 

seajs.useFunction

用来在页面中加载一个或多个模块。seajs.use(id, callback?)

01 // 加载一个模块
02 seajs.use('./a');
03  
04 // 加载一个模块,在加载完成时,执行回调
05 seajs.use('./a'function(a) {
06   a.doSomething();
07 });
08  
09 // 加载多个模块,在加载完成时,执行回调
10 seajs.use(['./a''./b'], function(a, b) {
11   a.doSomething();
12   b.doSomething();
13 });

 

注意:seajs.use 与 DOM ready 事件没有任何关系。如果某些操作要确保在 DOM ready 后执行,需要使用 jquery 等类库来保证。比如

1 seajs.use(['jquery''./main'], function($, main) {
2     $(document).ready(function() {
3         main.init();
4     });
5 });

 

seajs.cacheOjbect

通过 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.resloveFunction

类似require.resolve,会利用模块系统的内部机制对传入的字符串参数进行路径解析。

 
1seajs.resolve('jquery');
3 
4seajs.resolve('./a', 'http://example.com/to/b.js');
seajs.resolve 方法不光可以用来调试路径解析是否正确,还可以用在插件开发环境中。

seajs.dataObject

通过 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 路径,相对于当前页面

 
02 
03<script type="text/javascript">
04//配置Seajs
05seajs.config({
06    alias: {
07        //顶级标识,基于 base 路径
08        'actjs': 'actjs/core/0.0.7/core.js',
09            // => http://
10        'position': 'actjs/util/0.0.2/position.js'
11    }
12});
13 
14seajs.config({
15    alias: {
16        //普通路径,相对于当前页面
17        'affix': '../../actjs/assets/widget/src/widget-affix.js',
18 
19        //相对标识,相对于当前页面
20        'init': './src/init.js'
21    }
22});
23</script>
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值