JavaScriptでのカスタムイベントの書き方を詳しく解説

イベントをカスタマイズして、より柔軟な開発を実現できます。イベントは、適切に使用すると非常に強力なツールになります。イベントベースの開発には多くの利点があります (後述)。

カスタムイベントに関連する関数は、event、customevent、およびdispatcheventです。

イベントを直接カスタマイズするには、event コンストラクターを使用します。

var event = new event('build');

// listen for the event.
elem.addeventlistener('build', function (e) { ... }, false);

// dispatch the event.
elem.dispatchevent(event);

ログイン後にコピー

customevent は、より高度にカスタマイズされたイベントを作成でき、いくつかのデータを添付することもできます。具体的な使用方法は次のとおりです。

var myevent = new customevent(eventname, options);

ログイン後にコピー

オプションは次のとおりです:

{
  detail: {
    ...
  },
  bubbles: true,
  cancelable: false
}

ログイン後にコピー

detail はいくつかの初期化情報を保存し、トリガーされたときに呼び出すことができます。他のプロパティは、イベントにバブリング機能があるかどうかなどを定義します。

組み込みイベントは特定の操作に基づいてブラウザによってトリガーされますが、カスタムイベントは手動でトリガーする必要があります。 dispatchevent 関数は、イベントをトリガーするために使用されます。

element.dispatchevent(customevent);

ログイン後にコピー

上記のコードは、customevent イベントが要素でトリガーされることを示しています。組み合わせて使用します:

// add an appropriate event listener
obj.addeventlistener("cat", function(e) { process(e.detail) });

// create and dispatch the event
var event = new customevent("cat", {"detail":{"hazcheeseburger":true}});
obj.dispatchevent(event);

ログイン後にコピー

カスタムイベントを使用するには互換性の問題に注意する必要がありますが、jquery を使用するとはるかに簡単です。

// 绑定自定义事件
$(element).on('mycustomevent', function(){});

// 触发事件
$(element).trigger('mycustomevent');
此外，你还可以在触发自定义事件时传递更多参数信息：

$( "p" ).on( "mycustomevent", function( event, myname ) {
 $( this ).text( myname + ", hi there!" );
});
$( "button" ).click(function () {
 $( "p" ).trigger( "mycustomevent", [ "john" ] );
});

ログイン後にコピー

javascript カスタムイベントは、クリックや送信などの標準イベントとは異なる自己カスタマイズされたイベントです。カスタムイベントの利点を説明する前に、カスタムイベントの例を見てみましょう。

<div id="testbox"></div>

// 创建事件
var evt = document.createevent('event');
// 定义事件类型
evt.initevent('customevent', true, true);
// 在元素上监听事件
var obj = document.getelementbyid('testbox');
obj.addeventlistener('customevent', function(){
  console.log('customevent 事件触发了');
}, false);

ログイン後にコピー

特定の効果については、デモを表示できます。コンソールで obj.dispatchevent(evt) と入力します。コンソールに「customevent イベントがトリガーされました」という出力が表示され、カスタムイベントが正常にトリガーされたことがわかります。

このプロセスでは、createevent メソッドは空のイベント evt を作成し、initevent メソッドを使用してイベントタイプを合意されたカスタムイベントとして定義し、対応する要素を監視してから、dispatchevent を使用してイベントをトリガーします。

はい、カスタムイベントのメカニズムは通常のイベントのメカニズムと同じです。イベントをリッスンし、コールバック操作を記述し、イベントがトリガーされた後にコールバックを実行します。ただし、違いは、カスタムイベントがトリガーされたときに、カスタムイベントが完全に制御されることです。これは、一種の javascript 分離が達成されることを意味します。カスタムイベントメカニズムを使用して、関連する複数の論理的に複雑な操作を柔軟に制御できます。

もちろん、ご想像のとおり、上記のコードは以前のバージョンの ie では機能しません。実際、createevent() は ie8 およびそれ以前のバージョンの ie ではサポートされていませんが、ie のプライベート fireevent() は存在します。ただし、残念ながら、fireevent は標準イベントのトリガーのみをサポートします。したがって、カスタムイベントをトリガーするには、特別で簡単な方法しか使用できません。

// type 为自定义事件，如 type = 'customevent'，callback 为开发者实际定义的回调函数
obj[type] = 0;
obj[type]++;
 
obj.attachevent('onpropertychange', function(event){
  if( event.propertyname == type ){
    callback.call(obj);
  }
});

ログイン後にコピー

このメソッドの原理は、実際にはカスタム属性を dom に追加し、同時に要素の propertychange イベントをリッスンすることです。dom のプロパティの値が変更されると、propertychange コールバックがトリガーされます。変更された属性がカスタム属性かどうか、カスタム属性であれば開発者が実際に定義したコールバックが実行されます。これはカスタムイベントのメカニズムをシミュレートします。

カスタムイベントメカニズムを標準イベントの監視およびシミュレーショントリガーと連携させるために、完全なイベントメカニズムをここに示します。このメカニズムは、標準イベントとカスタムイベントの監視、監視の削除、およびシミュレーショントリガー操作をサポートします。コードのロジックを明確にするために、カスタムイベントには「custom」という接頭辞が付けられることに注意してください (例:customtest、customalert)。

/**
 * @description 包含事件监听、移除和模拟事件触发的事件机制，支持链式调用
 *
 */
 
(function( window, undefined ){
 
var Ev = window.Ev = window.$ = function(element){
 
  return new Ev.fn.init(element);
};
 
// Ev 对象构建
 
Ev.fn = Ev.prototype = {
 
  init: function(element){
 
    this.element = (element && element.nodeType == 1)? element: document;
  },
 
  /**
   * 添加事件监听
   * 
   * @param {String} type 监听的事件类型
   * @param {Function} callback 回调函数
   */
 
  add: function(type, callback){
 
    var _that = this;
     
    if(_that.element.addEventListener){
       
      /**
       * @supported For Modern Browers and IE9+
       */
       
      _that.element.addEventListener(type, callback, false);
       
    } else if(_that.element.attachEvent){
       
      /**
       * @supported For IE5+
       */
 
      // 自定义事件处理
      if( type.indexOf('custom') != -1 ){
 
        if( isNaN( _that.element[type] ) ){
 
          _that.element[type] = 0;
 
        } 
 
        var fnEv = function(event){
 
          event = event ? event : window.event
           
          if( event.propertyName == type ){
            callback.call(_that.element);
          }
        };
 
        _that.element.attachEvent('onpropertychange', fnEv);
 
        // 在元素上存储绑定的 propertychange 的回调，方便移除事件绑定
        if( !_that.element['callback' + callback] ){
     
          _that.element['callback' + callback] = fnEv;
 
        }
    
      // 标准事件处理
      } else {
    
        _that.element.attachEvent('on' + type, callback);
      }
       
    } else {
       
      /**
       * @supported For Others
       */
       
      _that.element['on' + type] = callback;
 
    }
 
    return _that;
  },
 
  /**
   * 移除事件监听
   * 
   * @param {String} type 监听的事件类型
   * @param {Function} callback 回调函数
   */
   
  remove: function(type, callback){
 
    var _that = this;
     
    if(_that.element.removeEventListener){
       
      /**
       * @supported For Modern Browers and IE9+
       */
       
      _that.element.removeEventListener(type, callback, false);
       
    } else if(_that.element.detachEvent){
       
      /**
       * @supported For IE5+
       */
       
      // 自定义事件处理
      if( type.indexOf('custom') != -1 ){
 
        // 移除对相应的自定义属性的监听
        _that.element.detachEvent('onpropertychange', _that.element['callback' + callback]);
 
        // 删除储存在 DOM 上的自定义事件的回调
        _that.element['callback' + callback] = null;
      
      // 标准事件的处理
      } else {
      
        _that.element.detachEvent('on' + type, callback);
      
      }
 
    } else {
       
      /**
       * @supported For Others
       */
       
      _that.element['on' + type] = null;
       
    }
 
    return _that;
 
  },
   
  /**
   * 模拟触发事件
   * @param {String} type 模拟触发事件的事件类型
   * @return {Object} 返回当前的 Kjs 对象
   */
   
  trigger: function(type){
 
    var _that = this;
     
    try {
        // 现代浏览器
      if(_that.element.dispatchEvent){
        // 创建事件
        var evt = document.createEvent('Event');
        // 定义事件的类型
        evt.initEvent(type, true, true);
        // 触发事件
        _that.element.dispatchEvent(evt);
      // IE
      } else if(_that.element.fireEvent){
         
        if( type.indexOf('custom') != -1 ){
 
          _that.element[type]++;
 
        } else {
 
          _that.element.fireEvent('on' + type);
        }
    
      }
 
    } catch(e){
 
    };
 
    return _that;
       
  }
}
 
Ev.fn.init.prototype = Ev.fn;
 
})( window );
测试用例1（自定义事件测试）

// 测试用例1（自定义事件测试）
// 引入事件机制
// ...
// 捕捉 DOM
var testBox = document.getElementById('testbox');
// 回调函数1
function triggerEvent(){
    console.log('触发了一次自定义事件 customConsole');
}
// 回调函数2
function triggerAgain(){
    console.log('再一次触发了自定义事件 customConsole');
}
// 封装
testBox = $(testBox);
// 同时绑定两个回调函数，支持链式调用
testBox.add('customConsole', triggerEvent).add('customConsole', triggerAgain);

ログイン後にコピー

完全なコードは、デモにあります。

デモを開いた後、コンソールで testbox.trigger('customconsole') を呼び出して、カスタムイベントを自分でトリガーします。コンソールに 2 つのプロンプトが出力されることがわかります。次に、testbox.remove('customconsole',triggeragain) と入力して、ペアを削除します。後者のリスナーについては、testbox.trigger('customconsole') を使用してカスタムイベントをトリガーします。コンソールはプロンプトのみを出力することがわかります。つまり、最後のリスナーは正常に削除されています。この時点で、すべてイベントメカニズムの機能は正常に動作しています。

JavaScriptでのカスタムイベントの書き方を詳しく解説_基礎知識