seajs

旨在纪录seajs的api，公司还在用sea呢

1 seajs.config

seajs.config({
// 别名配置：文件的真实路径与调用标识分开，以免调用标识太长
  alias: {
    'es5-safe': 'gallery/es5-safe/0.9.3/es5-safe',
    'json': 'gallery/json/1.0.2/json',
    'jquery': 'jquery/jquery/1.10.1/jquery'
  },

  // 路径配置：当目录比较深，或需要跨目录调用模块时
  paths: {
    'gallery': 'https://a.alipayobjects.com/gallery'
  },

  // 变量配置：有些场景下，模块路径在运行时才能确定
  vars: {
    'locale': 'zh-cn'
  },
  // var lang = require('./i18n/{locale}.js');
     //=> 加载的是 path/to/i18n/zh-cn.js

  // 映射配置：对模块路径进行映射修改，可用于路径转换、在线调试等。
  map: [
    [ '.js', '-debug.js' ]
  ]
  // var a = require('./a');
     //=> 加载的是 path/to/a-debug.js

  // 预加载项:可以在普通模块加载前，提前加载并初始化好指定模块。
  // preload 中的空字符串会被忽略掉。
  // preload 中的配置，需要等到 use 时才加载
  // preload 配置不能放在模块文件里面.否则不能保证模块 a 已经加载并执行好
  preload: [
    Function.prototype.bind ? '' : 'es5-safe',
    this.JSON ? '' : 'json'
  ],

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

  debug: true,

  // Sea.js 的基础路径：sea.js 在解析顶级标识时，会相对 base 路径来解析
  // 推荐始终手动设置一个准确的 base 路径

//   http://example.com/test/js/sea/sea.js

// http://example.com/test/index.html

// 在index.html中调用了sea.js

// base的默认值为 "http://example.com/test/js/sea/"

// 以 "." 开头 会相对于当前（被调用的）模块解析地址。 如果不存在被调用的模块（如seajs.use() ）， 则会相对于当前页面解析地址。

// 以 "/" 开头 相对于当前页面的根目录 解析地址

// 普通命名 直接加上base前缀
  base: 'http://example.com/path/to/base/',

  // 文件编码 默认utf-8
  charset: 'utf-8'
});

2 seajs.use

/用来在页面中加载一个或多个模块，并且可使用回调; 参数依次为加载的模块的返回值
  seajs.use('./a');

  //加载一个模块，在加载完成时，执行回调
  seajs.use('./a', function(a) {
    a.doSomething();
  });

  // 加载多个模块，在加载完成时，执行回调
  seajs.use(['./a', './b'], function(a, b) {
    a.doSomething();
    b.doSomething();
  });

3 define

//define(factory)
  // 全局函数，用来定义模块
  // factory可以是函数，对象和字符串，对象和字符串代表模块接口就是该对象或者字符串
  // 

  // factory为函数时，表示是模块的构造方法。执行该构造方法，可以得到模块向外提供的接口。
  // 默认会传入三个参数：require、exports 和 module

  // require 是一个方法，接受 模块标识 作为唯一参数，用来获取其他模块提供的接口
  // 正确拼写，不能重命名修改，并且只能传递直接量
  // // 错误！ require(myModule); require("my-" + "module");require("MY-MODULE".toLowerCase());
    // 正确！require("my-module");

  // 条件加载依然会加载两个，因为静态角度分析，会同时依赖两个

4 require.resolve

// 使用模块系统内部的路径解析机制来解析并返回模块路径。该函数不会加载模块，只返回解析后的绝对路径。
// 一般用在插件环境或需动态拼接模块路径的场景下
define(function(require, exports) {

  console.log(require.resolve('./b'));
  // ==> http://example.com/path/to/b.js

});

5 require.async

// require.async 方法用来在模块内部异步加载模块，并在加载完成后执行指定回调。callback 参数可选。

define(function(require, exports, module) {

  // 异步加载一个模块，在加载完成时，执行回调
  require.async('./b', function(b) {
    b.doSomething();
  });

  // 异步加载多个模块，在加载完成时，执行回调
  require.async(['./c', './d'], function(c, d) {
    c.doSomething();
    d.doSomething();
  });

});

6 exports 是一个对象，用来向外提供模块接口

// 除了给 exports 对象增加成员，还可以使用 return 直接向外提供接口
// exports 仅仅是 module.exports 的一个引用。在 factory 内部给 exports 重新赋值时，并不会改变 module.exports 的值。因此给 exports 赋值是无效的
define(function(require, exports) {

  // 错误用法！！!
  exports = {
    foo: 'bar',
    doSomething: function() {}
  };

});
define(function(require, exports, module) {

  // 正确写法
  module.exports = {
    foo: 'bar',
    doSomething: function() {}
  };

});

7 module对象

// module.id 模块的唯一标识。
define('id', [], function(require, exports, module) {
});
// 上面代码中，define 的第一个参数就是模块标识。

// module.uri根据模块系统的路径解析规则得到的模块绝对路径。
define(function(require, exports, module) {
  console.log(module.uri); 
  // ==> http://example.com/path/to/this/file.js
});
// 一般情况下（没有在 define 中手写 id 参数时），module.id 的值就是 module.uri，两者完全相同。

// module.dependencies dependencies 是一个数组，表示当前模块的依赖。

// module.exports 当前模块对外提供的接口。
// 对 module.exports 的赋值需要同步执行，不能放在回调函数里。下面这样是不行的：
// x.js
define(function(require, exports, module) {
  // 错误用法
  setTimeout(function() {
    module.exports = { a: "hello" };
  }, 0);
});