jQuery.Callbacks()メソッド

jQuery 杂项方法jQuery 雑多なメソッド

例

$.Callbacks のリストにコールバック関数を追加します

$(function () { function fn1( value ) { alert( value ); } function fn2( value ) { fn1("fn2 says: " + value); return false; } var callbacks = $.Callbacks(); callbacks.add( fn1 ); //出力: foo! callbacks.fire( "foo!" ); callbacks.add( fn2 ); //出力: bar!、fn2 says: bar! callbacks.fire( "bar!" ); })

試してみる »

定義と使い方

$.Callbacks() は多目的コールバック関数リストオブジェクトを指し、コールバック関数のキューを管理する強力な方法を提供します。

ヒント:$.Callbacks は jQuery 内部で使用され、.ajax や $.Deferred などのコンポーネントに基本機能を提供する関数です。同様の機能を持ついくつかのコンポーネント、例えば自作のプラグインなどでも使用できます。


構文

$.Callbacks( flags )

パラメータ 説明
flags 省略可能。String型。スペース区切りのフラグのオプションリストで、コールバックリストの動作を変更するために使用します。


实例

その他の例

以下は .remove() を使用してコールバックリストから特定のコールバックを削除する例です。

例

$(function () { function fn1( value ) { alert( value ); } function fn2( value ) { fn1("fn2 says: " + value); return false; } var callbacks = $.Callbacks(); callbacks.add( fn1 ); //出力: foo! callbacks.fire( "foo!" ); callbacks.add( fn2 ); //出力: bar!、fn2 says: bar! callbacks.fire( "bar!" ); callbacks.remove( fn2 ); //foobar のみが出力されます。fn2 は削除済みです。 callbacks.fire( "foobar" ); })

試してみる »


サポートされている Flags パラメータ

この flags パラメータは $.Callbacks() のオプションパラメータで、スペース区切りのフラグのオプションリストから構成され、コールバックリストの動作を変更するために使用されます(例: $.Callbacks( 'unique stopOnFalse' ))。
以下は利用可能な flags です:

パラメータ 説明
once このコールバックリストが一度だけ実行されることを保証します
memory 前回の fire 時のパラメータ値をキャッシュします。add() でコールバック関数を追加するとき、前回のパラメータ値を使って新しく追加されたコールバック関数を即座に呼び出します。
unique 各コールバックは一度だけ追加され、重複して追加されることはありません。 stopOnFalse あるコールバック関数が false を返した後、後続のコールバック関数を中断します。

以下は $.Callbacks( "once" ) の例です。

例

$(function () { function fn1( value ) { alert( value ); } function fn2( value ) { fn1("fn2 says: " + value); return false; } var callbacks = $.Callbacks( "once" ); callbacks.add( fn1 ); callbacks.fire( "foo" ); callbacks.add( fn2 ); callbacks.fire( "bar" ); callbacks.remove( fn2 ); callbacks.fire( "foobar" ); /*出力のみ: foo*/ })

試してみる »

以下は $.Callbacks( "memory" ) の例です。

例

$(function () { function fn1( value ) { alert( value ); } function fn2( value ) { fn1("fn2 says: " + value); return false; } var callbacks = $.Callbacks( "memory" ); callbacks.add( fn1 ); callbacks.fire( "foo" ); callbacks.add( fn2 ); callbacks.fire( "bar" ); callbacks.remove( fn2 ); callbacks.fire( "foobar" ); /*出力: foo fn2 says:foo bar fn2 says:bar foobar*/ })

試してみる »

以下は $.Callbacks( "unique" ) の例です。

例

$(function () { function fn1( value ) { alert( value ); } function fn2( value ) { fn1("fn2 says: " + value); return false; } var callbacks = $.Callbacks( "unique" ); callbacks.add( fn1 ); callbacks.fire( "foo" ); callbacks.add( fn1 ); // repeat addition callbacks.add( fn2 ); callbacks.fire( "bar" ); callbacks.remove( fn2 ); callbacks.fire( "foobar" ); /*出力: foo bar fn2 says:bar foobar*/ })

試してみる »

以下は $.Callbacks( "stopOnFalse" ) の例です。

例

$(function () { function fn1( value ) { alert( value ); return false; } function fn2( value ) { fn1( "fn2 says: " + value ); return false; } var callbacks = $.Callbacks( "stopOnFalse" ); callbacks.add( fn1 ); callbacks.fire( "foo" ); callbacks.add( fn2 ); callbacks.fire( "bar" ); callbacks.remove( fn2 ); callbacks.fire( "foobar" ); /*出力: foo bar foobar*/ })

試してみる »

$.Callbacks() は1つのリストに複数の flags(フラグ)を設定できます。1つだけではなく、累積的な効果があり、"&&" に似ています。
以下は $.Callbacks( 'unique memory' ) の例です。

例

$(function () { function fn1( value ) { alert( value ); return false; } function fn2( value ) { fn1( "fn2 says: " + value ); return false; } var callbacks = $.Callbacks( "unique memory" ); callbacks.add( fn1 ); callbacks.fire( "foo" ); callbacks.add( fn1 ); // repeat addition callbacks.add( fn2 ); callbacks.fire( "bar" ); callbacks.add( fn2 ); callbacks.fire( "baz" ); callbacks.remove( fn2 ); callbacks.fire( "foobar" ); /*出力: foo fn2 says:foo bar fn2 says:bar baz fn2 says:baz foobar*/ })

試してみる »

$.Callbacks メソッドは分離することもできます。例:

例

$(function () { function fn1( value ) { alert( value ); } var callbacks = $.Callbacks(), add = callbacks.add, remove = callbacks.remove, fire = callbacks.fire; add( fn1 ); fire( "hello world" ); remove( fn1 ); /*出力: hello world*/ })

試してみる »


$.Callbacks、$.Deferred と Pub/Sub

pub / sub(オブザーバーパターン)の背後にある一般的な考え方は、アプリケーションの疎結合と効率的な通信を促進することです。オブザーバーはサブスクライバーとも呼ばれ、観察対象を指します。パブリッシャー(Publisher)はイベント発生時に購読者へ通知します。

$.Callbacks() の作成コンポーネントのデモとして、コールバック関数リストだけを使用して Pub/Sub システムを実装できます。$.Callbacks をメッセージキューとして使用すると、次のようにしてメッセージの公開と購読を実装できます。

例

$(function () { function fn1( value ) { alert( value ); return false; } function fn2( value ) { fn1( "fn2 says: " + value ); return false; } var topics = {}; jQuery.Topic = function( id ) { var callbacks, method, topic = id && topics[ id ]; if ( !topic ) { callbacks = jQuery.Callbacks(); topic = { publish: callbacks.fire, subscribe: callbacks.add, unsubscribe: callbacks.remove }; if ( id ) { topics[ id ] = topic; } } return topic; }; //サブスクライバー $.Topic( "mailArrived" ).subscribe( fn1 ); $.Topic( "mailArrived" ).subscribe( fn2 ); $.Topic( "mailSent" ).subscribe( fn1 ); //パブリッシャー $.Topic( "mailArrived" ).publish( "hello world!" ); $.Topic( "mailSent" ).publish( "woo! mail!" ); /*出力: hello world! fn2 says: hello world! woo! mail!*/ })

試してみる »

さらに改善して $.Deferreds を使用すると、特定のタスクが完了(または解決)したときに、パブリッシャーがサブスクライバーへ確実に通知を公開できるようになります。次のサンプルコードを参照してください:

例

$(function () { function fn1( value ) { alert( value ); return false; } function fn2( value ) { fn1( "fn2 says: " + value ); return false; } var topics = {}; jQuery.Topic = function( id ) { var callbacks, method, topic = id && topics[ id ]; if ( !topic ) { callbacks = jQuery.Callbacks(); topic = { publish: callbacks.fire, subscribe: callbacks.add, unsubscribe: callbacks.remove }; if ( id ) { topics[ id ] = topic; } } return topic; }; //mailArrived 通知を購読します $.Topic( "mailArrived" ).subscribe( fn1 ); //遅延 $.Deferreds の代わりに新しいオブジェクトを作成します var dfd = $.Deferred(); //新しいメッセージを定義します(直接公開しません) var topic = $.Topic( "mailArrived" ); //遅延が解決されたら、サブスクライバーへ通知を公開します dfd.done( topic.publish ); /*ここで、サブスクライバーに返信されるメッセージは遅延が解決されるまで保持されます。 可能な限り複雑な処理(例えば Ajax 呼び出しの完了を待つ)を統合できるため、 実際にはメッセージは一度だけ公開されます。*/ //完了。 dfd.resolve( "公開されました!" ); })

試してみる »


jQuery 杂项方法jQuery 雑多なメソッド

その他の拡張