# 組件間通信與事件

# 組件間通信

組件間的基本通信方式有以下幾種。

• WXML 數(shù)據(jù)綁定：用于父組件向子組件的指定屬性設(shè)置數(shù)據(jù)，僅能設(shè)置 JSON 兼容數(shù)據(jù)（自基礎(chǔ)庫版本 2.0.9 開始，還可以在數(shù)據(jù)中包含函數(shù)）。具體在 組件模板和樣式 章節(jié)中介紹。
• 事件：用于子組件向父組件傳遞數(shù)據(jù)，可以傳遞任意數(shù)據(jù)。
• 如果以上兩種方式不足以滿足需要，父組件還可以通過 this.selectComponent 方法獲取子組件實(shí)例對(duì)象，這樣就可以直接訪問組件的任意數(shù)據(jù)和方法。

# 監(jiān)聽事件

事件系統(tǒng)是組件間通信的主要方式之一。自定義組件可以觸發(fā)任意的事件，引用組件的頁面可以監(jiān)聽這些事件。關(guān)于事件的基本概念和用法，參見 事件 。

監(jiān)聽自定義組件事件的方法與監(jiān)聽基礎(chǔ)組件事件的方法完全一致：

代碼示例：

<!-- 當(dāng)自定義組件觸發(fā)“myevent”事件時(shí)，調(diào)用“onMyEvent”方法 -->
<component-tag-name bindmyevent="onMyEvent" />
<!-- 或者可以寫成 -->
<component-tag-name bind:myevent="onMyEvent" />

Page({
  onMyEvent: function(e){
    e.detail // 自定義組件觸發(fā)事件時(shí)提供的detail對(duì)象
  }
})

# 觸發(fā)事件

自定義組件觸發(fā)事件時(shí)，需要使用 triggerEvent 方法，指定事件名、detail對(duì)象和事件選項(xiàng)：

代碼示例：

在開發(fā)者工具中預(yù)覽效果

<!-- 在自定義組件中 -->
<button bindtap="onTap">點(diǎn)擊這個(gè)按鈕將觸發(fā)“myevent”事件</button>

Component({
  properties: {},
  methods: {
    onTap: function(){
      var myEventDetail = {} // detail對(duì)象，提供給事件監(jiān)聽函數(shù)
      var myEventOption = {} // 觸發(fā)事件的選項(xiàng)
      this.triggerEvent('myevent', myEventDetail, myEventOption)
    }
  }
})

觸發(fā)事件的選項(xiàng)包括：

關(guān)于冒泡和捕獲階段的概念，請(qǐng)閱讀 事件 章節(jié)中的相關(guān)說明。

代碼示例：

在開發(fā)者工具中預(yù)覽效果

// 頁面 page.wxml
<another-component bindcustomevent="pageEventListener1">
  <my-component bindcustomevent="pageEventListener2"></my-component>
</another-component>

// 組件 another-component.wxml
<view bindcustomevent="anotherEventListener">
  <slot />
</view>

// 組件 my-component.wxml
<view bindcustomevent="myEventListener">
  <slot />
</view>

// 組件 my-component.js
Component({
  methods: {
    onTap: function(){
      this.triggerEvent('customevent', {}) // 只會(huì)觸發(fā) pageEventListener2
      this.triggerEvent('customevent', {}, { bubbles: true }) // 會(huì)依次觸發(fā) pageEventListener2 、 pageEventListener1
      this.triggerEvent('customevent', {}, { bubbles: true, composed: true }) // 會(huì)依次觸發(fā) pageEventListener2 、 anotherEventListener 、 pageEventListener1
    }
  }
})

# 獲取組件實(shí)例

可在父組件里調(diào)用 this.selectComponent ，獲取子組件的實(shí)例對(duì)象。

調(diào)用時(shí)需要傳入一個(gè)匹配選擇器 selector，如：this.selectComponent(".my-component")。

selector 詳細(xì)語法可查看 selector 語法參考文檔。

代碼示例：

在開發(fā)者工具中預(yù)覽效果

// 父組件
Page({
  data: {},
  getChildComponent: function () {
    const child = this.selectComponent('.my-component');
    console.log(child)
  }
})

在上例中，父組件將會(huì)獲取 class 為 my-component 的子組件實(shí)例對(duì)象，即子組件的 this 。

注意 ：默認(rèn)情況下，小程序與插件之間、不同插件之間的組件將無法通過 selectComponent 得到組件實(shí)例（將返回 null）。如果想讓一個(gè)組件在上述條件下依然能被 selectComponent 返回，可以自定義其返回結(jié)果（見下）。

# 自定義的組件實(shí)例獲取結(jié)果

若需要自定義 selectComponent 返回的數(shù)據(jù)，可使用內(nèi)置 behavior: wx://component-export

從基礎(chǔ)庫版本 2.2.3 開始提供支持。

使用該 behavior 時(shí)，自定義組件中的 export 定義段將用于指定組件被 selectComponent 調(diào)用時(shí)的返回值。

代碼示例：

在開發(fā)者工具中預(yù)覽效果

// 自定義組件 my-component 內(nèi)部
Component({
  behaviors: ['wx://component-export'],
  export() {
    return { myField: 'myValue' }
  }
})

<!-- 使用自定義組件時(shí) -->
<my-component id="the-id" />

// 父組件調(diào)用
const child = this.selectComponent('#the-id') // 等于 { myField: 'myValue' }

在上例中，父組件獲取 id 為 the-id 的子組件實(shí)例的時(shí)候，得到的是對(duì)象 { myField: 'myValue' } 。