ホームページ > 記事 > ウェブフロントエンド > Seajs のシンプルなドキュメントは、シンプルかつ究極のモジュール開発エクスペリエンスを提供します_Seajs
非公式ドキュメントは、簡単に参照できるように、独自の 公式 ドキュメントのテキストと例から編集されています。
Sea.js を使用する理由?
Sea.js は、コードを記述して編成するシンプルで自然な方法を追求しており、次の主要な機能を備えています。
シンプルでフレンドリーなモジュール定義仕様: Sea.js は CMD 仕様に従っており、Node.js と同様のモジュール コードを作成できます。
自然で直感的なコード構成: 依存関係の自動読み込みと簡潔で明確な構成により、コーディングをさらに楽しむことができます。
Sea.js は、開発、デバッグ、パフォーマンスの最適化に非常に役立ち、豊富な拡張可能なインターフェイスを備えた一般的に使用されるプラグインも提供します。
互換性
Sea.js には完全なテスト ケースがあり、すべての主要なブラウザーと互換性があります:
Chrome 3+
Firefox 2 以降
Safari 3.2+
オペラ 10+
IE 5.5+
Sea.js は、ハイブリッド モード アプリを含め、モバイル側で実行できます。理論上、Sea.js はどのブラウザ エンジンでも実行できます。
seajs.configObject
エイリアス オブジェクト
エイリアス設定、設定後、モジュール内で require を使用して require('jquery');
seajs.config({ alias: { 'jquery': 'jquery/jquery/1.10.1/jquery' } });
define(function(require, exports, module) { //引用jQuery模块 var $ = require('jquery'); });
パス オブジェクト
ディレクトリ間の呼び出しを容易にするパスを設定します。パスを柔軟に設定することで、ベースに影響を与えることなくディレクトリを指定できます。
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 変数を使用して構成できます。
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 });
マップ 配列
この構成はモジュール パスのマッピングと変更が可能で、パス変換やオンライン デバッグなどに使用できます。
seajs.config({ map: [ [ '.js', '-debug.js' ] ] });
define(function(require, exports, module) { var a = require('./a'); //=> 加载的是 path/to/a-debug.js });
プリロード 配列
プリロード設定項目を使用すると、通常のモジュールをロードする前に、指定したモジュールを事前にロードして初期化することができます。
プリロード内の空の文字列は無視されます。
// 在老浏览器中,提前加载好 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 已经加载并执行好 });
デバッグ ブール値
値が true の場合、ローダーは動的に挿入されたスクリプト タグを削除しません。プラグインは、デバッグ設定に基づいてログやその他の情報の出力を決定することもできます。
ベース文字列
Sea.js がトップレベルの識別子を解析するとき、ベース パスを基準にして解析されます。
注: 通常、ベース パスは設定しないでください。多くの場合、sea.js を適切なパスに配置する方が簡単で一貫性が高くなります。
関数
モジュールファイルを取得するとき、3f1c4e4b6b16bbbd69b2ee476dc4f83a または 2cdf5bf648cf2f33323966d7f58a7f3f の 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 関数
ページに 1 つ以上のモジュールをロードするために使用されます。 seajs.use(id, コールバック?)
// 加载一个模块 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 の準備ができた後に特定の操作が確実に実行されるようにしたい場合は、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 オブジェクト
seajs.cache を通じて、現在のモジュール システム内のすべてのモジュール情報を確認できます。
たとえば、seajs.org を開いて、WebKit 開発者ツールのコンソール パネルに 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 モジュール定義仕様 を参照してください。
seajs.reslove 関数
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来调整。