ホームページ > 記事 > ウェブフロントエンド > 単純なブラウザ側の JS モジュール ローダーを実装する方法の概要
es6 より前の js には、他の言語のような成熟したモジュール関数がなく、ページにはスクリプト タグを 1 つずつ挿入することによって独自のスクリプトまたはサードパーティのスクリプトを導入することしかできず、名前の競合が簡単に発生しました。 js コミュニティは、当時の実行環境で「モジュール」効果を実現するために多大な努力を払ってきました。
一般的な js モジュラー標準には CommonJS と AMD があり、前者はノード環境で使用され、後者は Require.js などによってブラウザ環境に実装されます。さらに、CMD 仕様に準拠した国産のオープンソース プロジェクト Sea.js があります。 (現在、es6の人気によりメンテナンスは停止しています。AMDであろうとCMDであろうと、それは歴史の一部になります)
ブラウザ側のjsローダー
単純なjsローダーの実装は複雑ではなく、主に解析に分けることができます。パス、ダウンロード モジュール、解析モジュールの依存関係、および解析モジュールの 4 つのステップがあります。
まずモジュールを定義します。さまざまな仕様において、通常、js ファイルはモジュールを表します。次に、モジュール ファイル内でクロージャを構築し、モジュールのエクスポートとしてオブジェクトを渡すことができます。
define(factory() { var x = { a: 1 }; return x; });
define 関数は、ファクトリ関数パラメータを受け取ります。ブラウザがスクリプトを実行すると、define 関数が実行されます。ファクトリに格納され、その戻り値がローダーのモジュール オブジェクト modules に格納されます。
モジュールを識別するには?ファイルの URI を使用できます。これは一意の識別子であり、自然 ID です。
ファイルパス path にはいくつかの形式があります:
絶対パス: http://xxx、file://xxx
相対パス: ./xxx、../xxx、xxx (現在のページからの相対ファイルパス)
仮想絶対パス: /xxx/ は Web サイトのルート ディレクトリを表します
したがって、さまざまな形式のパスを URI に解析し、現在のページのファイル パスを参照して解析するには、resolvePath 関数が必要です。
次に、2 つのモジュール a.js と b.js を参照し、a と b の実行を必要とするコールバック関数 f を設定する必要があるとします。ローダーが a と b をプルすることを期待します。a と b がロードされると、a と b がモジュールから取得され、次のステップを実行するためにパラメーターとして f に渡されます。これは、オブザーバー モード (つまり、サブスクリプション/パブリッシング モード) を使用して実装でき、eventProxy を作成し、loading a イベントとloading b イベントをサブスクライブし、define 関数が最後まで実行され、エクスポートがモジュールにマウントされた後、エミットします。モジュールがロードされたことを示すイベント。eventProxy はそれを受信すると、a と b の両方がロードされているかどうかを確認し、完了した場合はパラメーターを f に渡してコールバックを実行します。
同様に、eventProxy もモジュール依存関係の読み込みを実装できます
// a.js define([ 'c.js', 'd.js' ], factory (c, d) { var x = c + d; return x; });
定義関数の最初のパラメーターは、モジュール a が c と d に依存することを示す依存関係配列で渡すことができます。定義が実行されると、c と d のロード イベントをサブスクライブするようにeventProxy に指示します。ロード後、コールバック関数 f を実行して a のエクスポートを保存し、a がロードされたことを示すイベントを発行します。
ブラウザ側でスクリプトを読み込む本来の方法は、srcを指定した後、ブラウザがスクリプトのダウンロードを開始します。
その後、スクリプトタグを挿入し、srcを指定することで、ローダーにモジュールをロードすることができます。この時点で、モジュールはダウンロード状態になります。
追記: ブラウザでは、スクリプト タグの動的挿入は、ページ dom が初めてロードされるときのスクリプト ロード方法とは異なります:
ページが初めてロードされるとき、ブラウザは dom を解析します。 script タグが見つかると、スクリプトがダウンロードされ、DOM の解析がブロックされ、スクリプトがダウンロードされて実行されるまで待ってから、DOM の解析が続行されます (最新のブラウザではプリロードの最適化が行われているため、複数のスクリプトがダウンロードされます)。事前に実行されますが、実行順序は DOM 内の順序と一致し、実行中に他の DOM をブロックします) 解析)
スクリプトを動的に挿入します。
var a = document.createElement('script'); xxx'; document.body.appendChild(a);
実行が完了すると、ブラウザはスクリプトをダウンロードします。プロセスは非同期です。
ダウンロードが完了したら、上記の操作を実行し、依存関係を解析->依存関係をロード->このモジュールを解析->読み込み完了->コールバックを実行します。
モジュールがダウンロードされた後、解析するときにその URI をどのようにして知ることができますか? 2 つの方法があり、1 つは srcipt.onload を使用してこのオブジェクトの src 属性を取得する方法、もう 1 つは定義関数で document.currentScript.src を使用する方法です。
基本的な機能の実装は 200 行未満のコードで比較的簡単です:
var zmm = { _modules: {}, _configs: { // 用于拼接相对路径 basePath: (function (path) { if (path.charAt(path.length - 1) === '/') { path = path.substr(0, path.length - 1); } return path.substr(path.indexOf(location.host) + location.host.length + 1); })(location.href), // 用于拼接相对根路径 host: location.protocol + '//' + location.host + '/' } }; zmm.hasModule = function (_uri) { // 判断是否已有该模块,不论加载中或已加载好 return this._modules.hasOwnProperty(_uri); }; zmm.isModuleLoaded = function (_uri) { // 判断该模块是否已加载好 return !!this._modules[_uri]; }; zmm.pushModule = function (_uri) { // 新模块占坑,但此时还未加载完成,表示加载中;防止重复加载 if (!this._modules.hasOwnProperty(_uri)) { this._modules[_uri] = null; } }; zmm.installModule = function (_uri, mod) { this._modules[_uri] = mod; }; zmm.load = function (uris) { var i, nsc; for (i = 0; i < uris.length; i++) { if (!this.hasModule(uris[i])) { this.pushModule(uris[i]); // 开始加载 var nsc = document.createElement('script'); nsc.src = uri; document.body.appendChild(nsc); } } }; zmm.resolvePath = function (path) { // 返回绝对路径 var res = '', paths = [], resPaths; if (path.match(/.*:\/\/.*/)) { // 绝对路径 res = path.match(/.*:\/\/.*?\//)[0]; // 协议+域名 path = path.substr(res.length); } else if (path.charAt(0) === '/') { // 相对根路径 /开头 res = this._configs.host; path = path.substr(1); } else { // 相对路径 ./或../开头或直接文件名 res = this._configs.host; resPaths = this._configs.basePath.split('/'); } resPaths = resPaths || []; paths = path.split('/'); for (var i = 0; i < paths.length; i++) { if (paths[i] === '..') { resPaths.pop(); } else if (paths[i] === '.') { // do nothing } else { resPaths.push(paths[i]); } } res += resPaths.join('/'); return res; }; var define = zmm.define = function (dependPaths, fac) { var _uri = document.currentScript.src; if (zmm.isModuleLoaded(_uri)) { return; } var factory, depPaths, uris = []; if (arguments.length === 1) { factory = arguments[0]; // 挂载到模块组中 zmm.installModule(_uri, factory()); // 告诉proxy该模块已装载好 zmm.proxy.emit(_uri); } else { // 有依赖的情况 factory = arguments[1]; // 装载完成的回调函数 zmm.use(arguments[0], function () { zmm.installModule(_uri, factory.apply(null, arguments)); zmm.proxy.emit(_uri); }); } }; zmm.use = function (paths, callback) { if (!Array.isArray(paths)) { paths = [paths]; } var uris = [], i; for (i = 0; i < paths.length; i++) { uris.push(this.resolvePath(paths[i])); } // 先注册事件,再加载 this.proxy.watch(uris, callback); this.load(uris); }; zmm.proxy = function () { var proxy = {}; var taskId = 0; var taskList = {}; var execute = function (task) { var uris = task.uris, callback = task.callback; for (var i = 0, arr = []; i < uris.length; i++) { arr.push(zmm._modules[uris[i]]); } callback.apply(null, arr); }; var deal_loaded = function (_uri) { var i, k, task, sum; // 当一个模块加载完成时,遍历当前任务栈 for (k in taskList) { if (!taskList.hasOwnProperty(k)) { continue; } task = taskList[k]; if (task.uris.indexOf(_uri) > -1) { // 查看这个任务中的模块是否都已加载好 for (i = 0, sum = 0; i < task.uris.length; i++) { if (zmm.isModuleLoaded(task.uris[i])) { sum ++; } } if (sum === task.uris.length) { // 都加载完成 删除任务 delete(taskList[k]); execute(task); } } } }; proxy.watch = function (uris, callback) { // 先检查一遍是否都加载好了 for (var i = 0, sum = 0; i < uris.length; i++) { if (zmm.isModuleLoaded(uris[i])) { sum ++; } } if (sum === uris.length) { execute({ uris: uris, callback: callback }); } else { // 订阅新加载任务 var task = { uris: uris, callback: callback }; taskList['' + taskId] = task; taskId ++; } }; proxy.emit = function (_uri) { console.log(_uri + ' is loaded!'); deal_loaded(_uri); }; return proxy; }();
循環依存性の問題
「循環読み込み」とは、スクリプト a の実行がスクリプト b に依存し、スクリプト b の実行が依存することを意味します。スクリプトaについて。できれば避けたいデザインです。
ブラウザ側
上記の zmm ツールを使用してモジュール a:
// main.html zmm.use('/a.js', function(){...}); // a.js define('/b.js', function(b) { var a = 1; a = b + 1; return a; }); // b.js define('/a.js', function(a) { var b = a + 1; return b; });
をロードすると、a が b のロードを待機し、b が a のロードを待機するデッドロック状態に陥ります。この状況が発生した場合、sea.js もデッドロックになります。おそらく、この動作はデフォルトでは発生しないはずです。
Seajs は、循環依存関係の問題を軽減するために require.async を使用できますが、a.js を書き換える必要があります:
// a.js define('./js/a', function (require, exports, module) { var a = 1; require.async('./b', function (b) { a = b + 1; module.exports = a; //a= 3 }); module.exports = a; // a= 1 }); // b.js define('./js/b', function (require, exports, module) { var a = require('./a'); var b = a + 1; module.exports = b; }); // main.html seajs.use('./js/a', function (a) { console.log(a); // 1 });
しかし、これを行うには、まず a が b がそれ自身に依存することを知る必要があり、使用される出力はb はまだロードされていません。 a の値は、後で a の値が変更されることを知りません。
ブラウザ側では、良い解決策がないようです。ノード モジュールのロードで発生する循環依存性の問題ははるかに小さくなります。
node/CommonJS
CommonJS モジュールの重要な機能は、ロード時の実行です。つまり、すべてのスクリプト コードが必要に応じて実行されます。 CommonJS のアプローチは、モジュールが「ループロード」されると、実行された部分のみが出力され、未実行の部分は出力されないというものです。
// a.js var a = 1; module.exports = a; var b = require('./b'); a = b + 1; module.exports = a; // b.js var a = require('./a'); var b = a + 1; module.exports = b; // main.js var a = require('./a'); console.log(a); //3
上面main.js的代码中,先加载模块a,执行require函数,此时内存中已经挂了一个模块a,它的exports为一个空对象a.exports={};接着执行a.js中的代码;执行var b = require('./b');之前,a.exports=1,接着执行require(b);b.js被执行时,拿到的是a.exports=1,b加载完成后,执行权回到a.js;最后a模块的输出为3。
CommonJS与浏览器端的加载器有着实现上的差异。node加载的模块都是在本地,执行的是同步的加载过程,即按依赖关系依次加载,执行到加载语句就去加载另一个模块,加载完了再回到函数调用点继续执行;浏览器端加载scripts由于天生限制,只能采取异步加载,执行回调来实现。
ES6
ES6模块的运行机制与CommonJS不一样,它遇到模块加载命令import时,不会去执行模块,而是只生成一个引用。等到真的需要用到时,再到模块里面去取值。因此,ES6模块是动态引用,不存在缓存值的问题,而且模块里面的变量,绑定其所在的模块。
这导致ES6处理"循环加载"与CommonJS有本质的不同。ES6根本不会关心是否发生了"循环加载",只是生成一个指向被加载模块的引用,需要开发者自己保证,真正取值的时候能够取到值。
来看一个例子:
// even.js import { odd } from './odd'; export var counter = 0; export function even(n) { counter++; return n == 0 || odd(n - 1);} // odd.js import { even } from './even'; export function odd(n) { return n != 0 && even(n - 1);} // main.js import * as m from './even.js'; m.even(10); // true; m.counter = 6
上面代码中,even.js里面的函数even有一个参数n,只要不等于0,就会减去1,传入加载的odd()。odd.js也会做类似作。
上面代码中,参数n从10变为0的过程中,foo()一共会执行6次,所以变量counter等于6。第二次调用even()时,参数n从20变为0,foo()一共会执行11次,加上前面的6次,所以变量counter等于17。
而这个例子要是改写成CommonJS,就根本无法执行,会报错。
// even.js var odd = require('./odd'); var counter = 0; exports.counter = counter; exports.even = function(n) { counter++; return n == 0 || odd(n - 1); } // odd.js var even = require('./even').even; module.exports = function(n) { return n != 0 && even(n - 1); } // main.js var m = require('./even'); m.even(10); // TypeError: even is not a function
上面代码中,even.js加载odd.js,而odd.js又去加载even.js,形成"循环加载"。这时,执行引擎就会输出even.js已经执行的部分(不存在任何结果),所以在odd.js之中,变量even等于null,等到后面调用even(n-1)就会报错。
以上就是本文的全部内容,希望本文的内容对大家的学习或者工作能带来一定的帮助,如果有疑问大家可以留言交流,同时也希望多多支持PHP中文网!
更多概述如何实现一个简单的浏览器端js模块加载器相关文章请关注PHP中文网!