Seajs 簡易文件 提供簡單、極致的模組化開發體驗_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');

 

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'
  }
});

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

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配置項，可以在普通模組載入前，事先載入並初始化好指定模組。

preload中的空字串會被忽略掉。

// 在老浏览器中，提前加载好 ES5 和 json 模块
seajs.config({
  preload: [
    Function.prototype.bind ? '' : 'es5-safe',
    this.JSON ? '' : 'json'
  ]
});

注意：preload中的配置，需要等到 use 時才載入。如：

seajs.config({
  preload: 'a'
});

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

preload 設定不能放在模組檔案裡面：

seajs.config({
  preload: 'a'
});

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

debug Boolean

值為true時，載入器不會刪除動態插入的 script 標籤。插件也可以根據debug配置，來決策 log 等資訊的輸出。

baseString

Sea.js 在解析頂層識別時，會相對 base 路徑來解析。

注意：一般請不要配置 base 路徑，把 sea.js 放在適當的路徑往往比較簡單一致。
charsetString | Function

取得模組檔案時，<script> 或 <link> 標籤的charset屬性。 預設是utf-8</script>

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 與 DOM ready 事件沒有任何關係。如果某些操作要確保在 DOM ready 後執行，則需要使用 jquery 等類別庫來保證。如

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

注意：use方法第一個參數一定要有，但是可以是null，也可以是一個變數

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.js

seajs.resolve('./a', 'http://example.com/to/b.js');
// => http://example.com/to/a.js

seajs.resolve 方法不光可以用来调试路径解析是否正确，还可以用在插件开发环境中。

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>

开始的时候会觉得Seajs的路径有点不习惯，由其是Base路径。切记Base路径就是sea.js的那个文件的上级路径，然后所有顶级标识，相对标识都是相对于这个Base来调整。