事件监听与触发

了解事件监听 API，如何触发 ViewModel 的事件、组件节点的事件

通过本节，你将学会：

  • 监听与移除监听事件：$on()、$off
  • 触发ViewModel事件：$emit()
  • 监听原生组件事件
  • 触发原生组件事件：$emitElement()

监听与移除监听事件

$on 用于监听自定义事件；$off移除对应的事件监听

$on(evtName, fnHandler)

在当前页面注册监听事件， 可监听$emit()、 $dispatch()、 $broadcast()等触发的自定义事件，不能用于注册组件节点的事件响应

示例如下：

  1. export default {
  2.   onInit() {
  3.     this.$on('customEvtType1', this.customEvtType1Handler)
  4.   },
  5.   customEvtType1Handler(evt) {
  6.     // 事件类型，事件参数
  7.     console.info(
  8.       `触发事件：类型：${evt.type}, 参数： ${JSON.stringify(evt.detail)}`
  9.     )
  10.   }
  11. }

$off(evtName, fnHandler)

移除事件监听，参数 fnHandler 为可选，传递仅移除指定的响应函数，不传递则移除此事件的所有监听

示例如下：

  1. export default {
  2.   removeEventHandler() {
  3.     // 不传递fnHandler：移除所有监听
  4.     this.$off('customEvtType1')
  5.     // 传递fnHandler：移除指定的监听函数
  6.     this.$off('customEvtType1', this.customEvtType1Handler)
  7.   }
  8. }

触发ViewModel事件

页面的交互中可能会遇到一些非手动触发的需求，$emit() 通过触发当前实例上的事件达到动态触发事件的行为

$emit(evtName, evtDetail)

触发当前实例监听事件函数，与 $on() 配合使用

注意：$emit() 目前只触发 $on 所监听的事件

示例如下：

  1. export default {
  2.   emitEvent() {
  3.     this.$emit('customEvtType1', { params: '参数内容' })
  4.   }
  5. }

监听原生组件事件

原生组件支持一系列事件，如通用事件（如：click, disappear）、组件专有事件（如：focus）；

很多开发者希望能够在事件回调函数中，获取到当前触发事件的组件信息，并进行进一步的操作，那么办法有以下多种，如下代码所示：

  • 在响应函数执行时通过 target 获取，如：onClickHandler
  • 在响应函数绑定时传递参数，如：onClickHandler2

通用事件简写

如：onclick,onchange 可简写成 @click,@change

示例如下：

  1. <template>
  2.   <div class="tutorial-page">
  3.     <text id="elNode1" class="{{ elClassName + 1 }}" disabled="false" onclick="onClickHandler">组件节点1</text>
  4.     <text id="elNode2" class="class-static-1 {{ elClassName + 2 }}" onclick="onClickHandler2('参数1', argName)">组件节点2</text>
  5.   </div>
  6. </template>
  8. <style lang="less">
  9.   .tutorial-page {
  10.     flex-direction: column;
  11.   }
  12. </style>
  14. <script>
  15.   export default {
  16.     private: {
  17.       elClassName: 'class-dynamic',
  18.       argName: '动态参数'
  19.     },
  20.     onClickHandler (evt) {
  21.       // 事件类型，参数详情
  22.       console.info(`触发事件：类型：${evt.type}, 详情： ${JSON.stringify(evt.detail)}`);
  24.       if (evt.target) {
  25.         console.info(`触发事件：节点：${evt.target.id}, ${evt.target.attr.disabled}`)
  26.       }
  27.     },
  28.     onClickHandler2 (arg1, arg2, evt) {
  29.       // 事件类型，事件参数，target
  30.       console.info(`触发事件：类型：${evt.type}, 参数： ${arg1}, ${arg2}`);
  31.     }
  32.   }
  33. </script>

触发原生组件事件

除了用户手动操作触发事件，响应回调之外；开发者可以在代码中通过$emitElement()完成事件的动态触发

$emitElement(evtName, evtDetail, id)

可以触发指定组件 id 的事件，通过evt.detail获取传递的参数；该方法对自定义组件无效

示例如下：

<template>
  <div class="tutorial-page">
    <text onclick="emitElement">触发组件节点的事件：click</text>
    <text id="elNode1" class="{{ elClassName + 1 }}" disabled="false" onclick="onClickHandler">组件节点1</text>
    <text id="elNode2" class="class-static-1 {{ elClassName + 2 }}" onclick="onClickHandler2('参数1', argName)">组件节点2</text>
  </div>
</template>

<style lang="less">
  .tutorial-page {
    flex-direction: column;
  }
</style>

<script>
  export default {
    private: {
      elClassName: 'class-dynamic',
      argName: '动态参数'
    },
    onClickHandler (evt) {
      // 事件类型，参数详情
      console.info(`触发事件：类型：${evt.type}, 详情： ${JSON.stringify(evt.detail)}`);

      if (evt.target) {
        console.info(`触发事件：节点：${evt.target.id}, ${evt.target.attr.disabled}`)
      }
    },
    onClickHandler2 (arg1, arg2, evt) {
      // 事件类型，事件参数，target
      console.info(`触发事件：类型：${evt.type}, 参数： ${arg1}, ${arg2}`);
    },
    emitElement () {
      // 注意：通过此类方式的事件不会携带target属性，开发者可以通过detail参数实现
      this.$emitElement('click', { params: '参数内容' }, 'elNode1')
    }
  }
</script>

使用原生组件的冒泡功能

我们在 1040+ 版本对某些通用事件开放了冒泡功能，详见通用事件。

在未支持冒泡功能之前，开发者仅可以使用 target 属性，指向事件触发的节点。

在已支持冒泡功能之后，开发者可以同时使用 target 与 currentTarget，具体的指向与web规范保持一致；前者指向事件目标节点，后者指向事件触发节点。

为了兼容已经发布的快应用，以上更新，需要开发者在 manifest.json 中将 minPlatformVersion 设置为 1040 或以上，请开发者注意区别，做好后向兼容。

示例如下：

<template>
  <div class="tutorial-page">
    <div id="parentNode" class="outer" onclick="onParentClickHandler">
      <text class="inner" id="childNode1" onclick="onChildClickHandler">子组件1</text>
      <text class="inner" id="childNode2">子组件2</text>
    </div>
  </div>
</template>

<style>
  .outer {
    width: 750px;
    height: 500px;
    background-color: #eeeeee;
  }

  .inner {
    flex: 1;
    margin: 100px;
    background-color: skyblue;
  }
</style>

<script>
  export default {
    onParentClickHandler (evt) {
      // 事件类型
      console.info(`触发父组件事件：类型：${evt.type}`);

      if (evt.target) {
        console.info(`事件目标节点：${this.getNodeName(evt.target)}`)
      }

      if (evt.currentTarget) {
        console.info(`事件发生节点：${this.getNodeName(evt.currentTarget)}`)
      }
    },
    onChildClickHandler (evt) {
      // 事件类型
      console.info(`触发子组件事件：类型：${evt.type}`)

      if (evt.target) {
        console.info(`事件目标节点：${this.getNodeName(evt.target)}`)
      }

      if (evt.currentTarget) {
        console.info(`事件发生节点：${this.getNodeName(evt.currentTarget)}`)
      }
    },
    getNodeName (node) {
      const parentNode = this.$element('parentNode')
      const childNode1 = this.$element('childNode1')
      const childNode2 = this.$element('childNode2')
      let name = ''

      switch (node) {
        case parentNode: {
          name = 'parentNode'
          break
        }
        case childNode1: {
          name = 'childNode1'
          break
        }
        case childNode2: {
          name = 'childNode2'
          break
        }
      }

      return name
    }
  }
</script>

总结

掌握监听与触发事件能够更好的分离业务逻辑，减少方法响应上的耦合