Seajs简易文档 极致简单的模块化开发体验

整理了一份 Sea.js 的文档速查，内容来自官方文档的文字和实例，方便日常翻阅。Sea.js 的目标很简单——给前端开发者提供一种极致的模块化开发体验，告别繁杂的全局变量和手工管理依赖。

为什么用 Sea.js？

Sea.js 追求简单、自然的编码组织方式，几个核心特性很吸引人：

• 简单友好的模块定义规范：遵循 CMD 规范，写模块代码就像写 Node.js 一样自然。
• 自然直观的代码组织：依赖自动加载、配置简洁清晰，可以更多地享受编码的乐趣。
• 还有常用插件，非常有助于开发调试和性能优化，并且有丰富的可扩展接口。

兼容性

Sea.js 测试用例很完善，兼容所有主流浏览器：

Chrome 3+
Firefox 2+
Safari 3.2+
Opera 10+
IE 5.5+

移动端同样没问题，包括 Hybrid 模式的 App。理论上，Sea.js 可以在任何浏览器引擎上运行。

seajs.config 配置项

alias

配置别名后，模块里就可以用 require('jquery') 这种简洁的方式调用了。

seajs.config({
  alias: { 'jquery': 'jquery/jquery/1.10.1/jquery' }
});

define(function(require, exports, module) {
  var $ = require('jquery');
});

paths

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

seajs.config({
  paths: {
    'gallery': 'https://a.alipayobjects.com/gallery'
  },
  alias: {
    'underscore': 'gallery/underscore'
  }
});

define(function(require, exports, module) {
  var _ = require('underscore');
  // → 加载的是 https://a.alipayobjects.com/gallery/underscore.js
});

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

这个配置可以对模块路径进行映射修改，常用于路径转换、在线调试等。

seajs.config({
  map: [ [ '.js', '-debug.js' ] ]
});

define(function(require, exports, module) {
  var a = require('./a');
  // → 加载的是 path/to/a-debug.js
});

preload

在普通模块加载前，提前加载并初始化好指定模块。preload 中的空字符串会被忽略。

seajs.config({
  preload: [
    Function.prototype.bind ? '' : 'es5-safe',
    this.JSON ? '' : 'json'
  ]
});

注意：preload 的配置要等到 use 时才加载。比如：

seajs.config({ preload: 'a' });
seajs.use('./b');  // 在加载 b 之前，会确保模块 a 已经加载并执行好

preload 配置不能放在模块文件里面：

seajs.config({ preload: 'a' });
define(function(require, exports) {
  // 此处执行时，不能保证模块 a 已经加载并执行好
});

debug

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

base

Sea.js 在解析顶级标识时会相对 base 路径来解析。一般不建议配置 base，把 sea.js 放在合适的路径往往更简单一致。

charset

获取模块文件时，

开始的时候可能会觉得 Sea.js 的路径有点不习惯，尤其是 base 路径。切记：base 路径就是 sea.js 文件所在目录的上级路径，所有顶级标识、相对标识都是相对于这个 base 来调整的。