Vue 元件間通信方式

 前言

元件（Component）是 Vue.js 最強大的功能之一。元件可以擴充 HTML 元素，封裝可重用的代碼。一般來說，元件可以有以下幾種關系：

如上圖所示，A 和 B、B 和 C、B 和 D 都是父子關系，C 和 D 是兄弟關系，A 和 C 是隔代關系（可能隔多代）。

針對不同的使用場景，如何選擇行之有效的通信方式？這是我們所要探讨的主題。本文總結了vue元件間通信的幾種方式，如props、

$emit

/

$on

、vuex、

$parent

/

$children

、

$attrs

/

$listeners

和provide/inject，以通俗易懂的執行個體講述這其中的差别及使用場景，希望對小夥伴有些許幫助。

方法一、 

props 

/  

$emit

父元件A通過綁定自定義屬性向子元件B傳遞，子元件B通過props的方式來接收；子元件B如果想要向父元件A 傳遞至，則需要在 B 元件中綁定事件，通過 $emit來發射出一個自定義事件, 父元件A 中 通過v-on 的方式接收即可。

1.父元件向子元件傳值

子元件Users.vue中如何擷取父元件App.vue中的資料： 

users？

//App.vue父元件
<template>
  <div id="app">
    <users v-bind:users="users"></users>//前者自定義名稱便于子元件調用，後者要傳遞資料名
  </div>
</template>
<script>
import Users from "./components/Users"
export default {
  name: 'App',
  data(){
    return{
      users:["Henry","Bucky","Emily"]
    }
  },
  components:{
    "users":Users
  }
}
           

//users子元件
<template>
  <div class="hello">
    <ul>
      <li v-for="user in users">{{user}}</li>//周遊傳遞過來的值，然後呈現到頁面
    </ul>
  </div>
</template>
<script>
export default {
  name: 'HelloWorld',
  props:{
    users:{           //這個就是父元件中子标簽自定義名字
      type:Array,
      required:true
    }
  }
}
</script>
           

總結：父元件通過props向下傳遞資料給子元件。注：元件中的資料共有三種形式：data、props、computed

2.子元件向父元件傳值（通過事件形式） 

父元件如何擷取子元件傳遞過來的值: ‘子向父元件傳值’？

// 子元件
<template>
  <header>
    <h1 @click="changeTitle">{{title}}</h1>//綁定一個點選事件
  </header>
</template>
<script>
export default {
  name: 'app-header',
  data() {
    return {
      title:"Vue.js Demo"
    }
  },
  methods:{
    changeTitle() {
      this.$emit("titleChanged","子向父元件傳值");//自定義事件  傳遞值“子向父元件傳值”
    }
  }
}
</script>
           

// 父元件
<template>
  <div id="app">
    <app-header v-on:titleChanged="updateTitle" ></app-header>//與子元件titleChanged自定義事件保持一緻
   // updateTitle($event)接受傳遞過來的文字
    <h2>{{title}}</h2>
  </div>
</template>
<script>
import Header from "./components/Header"
export default {
  name: 'App',
  data(){
    return{
      title:"傳遞的是一個值"
    }
  },
  methods:{
    updateTitle(e){   //聲明這個函數
      this.title = e;
    }
  },
  components:{
   "app-header":Header,
  }
}
</script>
           

總結：子元件通過$emit發射一個自定義事件給父元件發送消息，實際上就是子元件把自己的資料發送到父元件。

方法二、

$emit

/

$on

這種方法通過一個空的Vue執行個體作為中央事件總線（事件中心），用它來觸發事件和監聽事件,巧妙而輕量地實作了任何元件間的通信，包括父子、兄弟、跨級。當我們的項目比較大時，可以選擇更好的狀态管了解決方案vuex。

1.具體實作方式：

• var Event=new Vue();

• Event.$emit(事件名,資料);

• Event.$on(事件名,data => {});

2.舉個例子

假設兄弟元件有三個，分别是A、B、C元件，C元件如何擷取A或者B元件的資料？

<div id="itany">
    <my-a></my-a>
    <my-b></my-b>
    <my-c></my-c>
</div>
<template id="a">
  <div>
    <h3>A元件：{{name}}</h3>
    <button @click="send">将資料發送給C元件</button>
  </div>
</template>
<template id="b">
  <div>
    <h3>B元件：{{age}}</h3>
    <button @click="send">将數組發送給C元件</button>
  </div>
</template>
<template id="c">
  <div>
    <h3>C元件：{{name}}，{{age}}</h3>
  </div>
</template>
<script>
var Event = new Vue();//定義一個空的Vue執行個體
var A = {
    template: '#a',
    data() {
      return {
        name: 'tom'
      }
    },
    methods: {
      send() {
        Event.$emit('data-a', this.name);
      }
    }
}
var B = {
    template: '#b',
    data() {
      return {
        age: 20
      }
    },
    methods: {
      send() {
        Event.$emit('data-b', this.age);
      }
    }
}
var C = {
    template: '#c',
    data() {
      return {
        name: '',
        age: ""
      }
    },
    mounted() {//在模闆編譯完成後執行
     Event.$on('data-a',name => {
         this.name = name;//箭頭函數内部不會産生新的this，這邊如果不用=>,this指代Event
     })
     Event.$on('data-b',age => {
         this.age = age;
     })
    }
}
var vm = new Vue({
    el: '#itany',
    components: {
      'my-a': A,
      'my-b': B,
      'my-c': C
    }
});
</script>
           

方法三、 vuex

1.簡要介紹Vuex原理

Vuex實作了一個單向資料流，在全局擁有一個State存放資料，當元件要更改State中的資料時，必須通過Mutation進行，Mutation同時提供了訂閱者模式供外部插件調用擷取State資料的更新。而當所有異步操作(常見于調用後端接口異步擷取更新資料)或批量的同步操作需要走Action，但Action也是無法直接修改State的，還是需要通過Mutation來修改State的資料。最後，根據State的變化，渲染到視圖上。

2.簡要介紹各子產品在流程中的功能：

• Vue Components：Vue元件。HTML頁面上，負責接收使用者操作等互動行為，執行dispatch方法觸發對應action進行回應。
• dispatch：操作行為觸發方法，是唯一能執行action的方法。
• actions：操作行為處理子產品,由元件中的 

  $store.dispatch('action 名稱',data1)

  來觸發。然後由commit()來觸發mutation的調用 , 間接更新 state。負責處理Vue Components接收到的所有互動行為。包含同步/異步操作，支援多個同名方法，按照注冊的順序依次觸發。向背景API請求的操作就在這個子產品中進行，包括觸發其他action以及送出mutation的操作。該子產品提供了Promise的封裝，以支援action的鍊式觸發。
• commit：狀态改變送出操作方法。對mutation進行送出，是唯一能執行mutation的方法。
• mutations：狀态改變操作方法，由actions中的 

  commit('mutation 名稱')

  來觸發。是Vuex修改state的唯一推薦方法。該方法隻能進行同步操作，且方法名隻能全局唯一。操作之中會有一些hook暴露出來，以進行state的監控等。
• state：頁面狀态管理容器對象。集中存儲Vue components中data對象的零散資料，全局唯一，以進行統一的狀态管理。頁面顯示所需的資料從該對象中進行讀取，利用Vue的細粒度資料響應機制來進行高效的狀态更新。
• getters：state對象讀取方法。圖中沒有單獨列出該子產品，應該被包含在了render中，Vue Components通過該方法讀取全局state對象。

3.Vuex與localStorage

vuex 是 vue 的狀态管理器，存儲的資料是響應式的。但是并不會儲存起來，重新整理之後就回到了初始狀态，具體做法應該在vuex裡資料改變的時候把資料拷貝一份儲存到localStorage裡面，重新整理之後，如果localStorage裡有儲存的資料，取出來再替換store裡的state。

import Vue from 'vue'
import Vuex from 'vuex'
import getters from './getters' // 導入響應的子產品，*相當于引入了這個元件下所有導出的事例
import actions from './actions'

const store = new Vuex.Store({
    state: {// 共同維護的一個狀态，state裡面可以是很多個全局狀态
        defaultCity = "上海";
        city: defaultCity
    },
    getters,  // 擷取資料并渲染
    actions,  // 資料的異步操作
    mutations: {// 處理資料的唯一途徑，state的改變或指派隻能在這裡
        changeCity(state, city) {
            state.city = city;
            try{
                // 資料改變的時候把資料拷貝一份儲存到localStorage裡面
                window.localStorage.setItem('defaultCity', JSON.stringify(state.city));
            }catch(e) {
                //do something
            }
        }
    }  
})

export default store;
           

這裡需要注意的是：由于vuex裡，我們儲存的狀态，都是數組，而localStorage隻支援字元串，是以需要用JSON轉換：

• JSON.stringify(state.subscribeList); // array -> string

• JSON.parse(window.localStorage.getItem("subscribeList")); // string -> array

 方法四、 

$attrs　

/ 

$listeners

1.簡介

多級元件嵌套需要傳遞資料時，通常使用的方法是通過vuex。但如果僅僅是傳遞資料，而不做中間處理，使用 vuex 處理，未免有點大材小用。為此Vue2.4 版本提供了另一種方法----

$attrs

/

$listeners

• $attrs

  ：包含了父作用域中不被 prop 所識别 (且擷取) 的特性綁定 (class 和 style 除外)。當一個元件沒有聲明任何 prop 時，這裡會包含所有父作用域的綁定 (class 和 style 除外)，并且可以通過 v-bind="$attrs" 傳入内部元件。通常配合 interitAttrs 選項一起使用。

• $listeners

  ：包含了父作用域中的 (不含 .native 修飾器的) v-on 事件監聽器。它可以通過 v-on="$listeners" 傳入内部元件

接下來我們看個跨級通信的例子：

// index.vue
<template>
  <div>
    <h2>浪裡行舟</h2>
    <child-com1
      :foo="foo"
      :boo="boo"
      :coo="coo"
      :doo="doo"
      title="前端工匠"
    ></child-com1>
  </div>
</template>
<script>
const childCom1 = () => import("./childCom1.vue");
export default {
  components: { childCom1 },
  data() {
    return {
      foo: "Javascript",
      boo: "Html",
      coo: "CSS",
      doo: "Vue"
    };
  }
};
</script>
           

// childCom1.vue
<template class="border">
  <div>
    <p>foo: {{ foo }}</p>
    <p>childCom1的$attrs: {{ $attrs }}</p>
    <child-com2 v-bind="$attrs"></child-com2>
  </div>
</template>
<script>
const childCom2 = () => import("./childCom2.vue");
export default {
  components: {
    childCom2
  },
  inheritAttrs: false, // 可以關閉自動挂載到元件根元素上的沒有在props聲明的屬性
  props: {
    foo: String // foo作為props屬性綁定
  },
  created() {
    console.log(this.$attrs); // { "boo": "Html", "coo": "CSS", "doo": "Vue", "title": "前端工匠" }
  }
};
</script>
           

// childCom2.vue
<template>
  <div class="border">
    <p>boo: {{ boo }}</p>
    <p>childCom2: {{ $attrs }}</p>
    <child-com3 v-bind="$attrs"></child-com3>
  </div>
</template>
<script>
const childCom3 = () => import("./childCom3.vue");
export default {
  components: {
    childCom3
  },
  inheritAttrs: false,
  props: {
    boo: String
  },
  created() {
    console.log(this.$attrs); // { "coo": "CSS", "doo": "Vue", "title": "前端工匠" }
  }
};
</script>
           

// childCom3.vue
<template>
  <div class="border">
    <p>childCom3: {{ $attrs }}</p>
  </div>
</template>
<script>
export default {
  props: {
    coo: String,
    title: String
  }
};
</script>
// childCom3.vue
<template>
  <div class="border">
    <p>childCom3: {{ $attrs }}</p>
  </div>
</template>
<script>
export default {
  props: {
    coo: String,
    title: String
  }
};
</script>
           

總結：

$attrs

與

$listeners

是兩個對象，

$attrs

裡存放的是父元件中綁定的非 Props 屬性，

$listeners

裡存放的是父元件中綁定的非原生事件。

方法五、provide/inject

1.簡介

Vue2.2.0新增API,這對選項需要一起使用，以允許一個祖先元件向其所有子孫後代注入一個依賴，不論元件層次有多深，并在起上下遊關系成立的時間裡始終生效。一言而蔽之：祖先元件中通過provider來提供變量，然後在子孫元件中通過inject來注入變量。provide / inject API 主要解決了跨級元件間的通信問題，不過它的使用場景，主要是子元件擷取上級元件的狀态，跨級元件間建立了一種主動提供與依賴注入的關系。

2.舉個例子

假設有兩個元件： A.vue 和 B.vue，B 是 A 的子元件

// A.vue
export default {
  provide: {
    name: '你好'
  }
}
           

// B.vue
export default {
  inject: ['name'],
  mounted () {
    console.log(this.name);  // 你好
  }
}
           

可以看到，在 A.vue 裡，我們設定了一個 provide: name，值為 浪裡行舟，它的作用就是将 name 這個變量提供給它的所有子元件。而在 B.vue 中，通過

inject

 注入了從 A 元件中提供的 name 變量，那麼在元件 B 中，就可以直接通過 this.name 通路這個變量了，它的值也是 浪裡行舟。這就是 provide / inject API 最核心的用法。

需要注意的是：provide 和 inject 綁定并不是可響應的。這是刻意為之的。然而，如果你傳入了一個可監聽的對象，那麼其對象的屬性還是可響應的----vue官方文檔 是以，上面 A.vue 的 name 如果改變了，B.vue 的 this.name 是不會改變的，仍然是“ 你好”。

3.provide與inject 怎麼實作資料響應式

一般來說，有兩種辦法：

• provide祖先元件的執行個體，然後在子孫元件中注入依賴，這樣就可以在子孫元件中直接修改祖先元件的執行個體的屬性，不過這種方法有個缺點就是這個執行個體上挂載很多沒有必要的東西比如props，methods
• 使用2.6最新API Vue.observable 優化響應式 provide(推薦)

// A 元件
<div>
      <h1>A 元件</h1>
      <button @click="() => changeColor()">改變color</button>
      <ChildrenB />
      <ChildrenC />
</div>
......
  data() {
    return {
      color: "blue"
    };
  },
  // provide() {
  //   return {
  //     theme: {
  //       color: this.color //這種方式綁定的資料并不是可響應的
  //     } // 即A元件的color變化後，元件D、E、F不會跟着變
  //   };
  // },
  provide() {
    return {
      theme: this//方法一：提供祖先元件的執行個體
    };
  },
  methods: {
    changeColor(color) {
      if (color) {
        this.color = color;
      } else {
        this.color = this.color === "blue" ? "red" : "blue";
      }
    }
  }
  // 方法二:使用2.6最新API Vue.observable 優化響應式 provide
  // provide() {
  //   this.theme = Vue.observable({
  //     color: "blue"
  //   });
  //   return {
  //     theme: this.theme
  //   };
  // },
  // methods: {
  //   changeColor(color) {
  //     if (color) {
  //       this.theme.color = color;
  //     } else {
  //       this.theme.color = this.theme.color === "blue" ? "red" : "blue";
  //     }
  //   }
  // }
           

// F 元件
<template functional>
  <div class="border2">
    <h3 :style="{ color: injections.theme.color }">F 元件</h3>
  </div>
</template>
<script>
export default {
  inject: {
    theme: {
      //函數式元件取值不一樣
      default: () => ({})
    }
  }
};
</script>
           

方法六、 

$parent

 / 

$children

　＆ 

ref

• ref

  ：如果在普通的 DOM 元素上使用，引用指向的就是 DOM 元素；如果用在子元件上，引用就指向元件執行個體

• $parent

   / 

  $children

  ：通路父 / 子執行個體

需要注意的是：這兩種都是直接得到元件執行個體，使用後可以直接調用元件的方法或通路資料。我們先來看個用

ref

來通路元件的例子：

// component-a 子元件
export default {
  data () {
    return {
      title: 'Vue.js'
    }
  },
  methods: {
    sayHello () {
      window.alert('Hello');
    }
  }
}
           

// 父元件
<template>
  <component-a ref="comA"></component-a>
</template>
<script>
  export default {
    mounted () {
      const comA = this.$refs.comA;
      console.log(comA.title);  // Vue.js
      comA.sayHello();  // 彈窗
    }
  }
</script>
           

注意！！！這兩種方法的弊端是，無法在跨級或兄弟間通信

總結

常見使用場景可以分為三類：

• 父子通信： （props）和（

  $emit

  ）；（

  $parent

   / 

  $children

  ）；（ref）也可以通路元件執行個體；provide / inject API；

  $attrs/$listeners

• 兄弟通信： Bus；Vuex
• 跨級通信： Bus；Vuex；provide / inject API、

  $attrs/$listeners