vue3-组合式api-provide/inject详解

时间:2022-11-10 一只向上爬的小蜗牛人气:0

provide/inject 适用于跨级通信，例如在父组件中改变值，在孙组件中通过依赖注入的方式能获取到父组件中改变的这个值

一、父组件

<template>
  <div>
    <!-- 子组件 -->
    <son></son>
    <button @click="changeName">改变名字</button>
  </div>
</template>

<script>
import son from "./son.vue";

import { provide, ref } from "vue";

export default {
  components: {
    son,
  },
  setup() {
    const name = ref("张三");

    //把name提供出去
    provide("name", name);

    //改变名字
    function changeName() {
      name.value = "李四";
    }

    return {
      changeName,
    };
  },
};
</script>

二、子组件

<template>
  <div>
    <h2>我是子组件</h2>
    name: {{ name }}
    <!-- 孙组件 -->
    <grandson></grandson>
  </div>
</template>

<script>
import grandson from "./grandson.vue";
import { inject } from "vue";

export default {
  components: {
    grandson,
  },
  setup() {
    //依赖注入
    const name = inject("name");

    return {
      name,
    };
  },
};
</script>

三、孙组件

<template>
  <div>
    <h2>我是孙组件</h2>
    name: {{ name }}
  </div>
</template>

<script>
import { inject } from "vue";

export default {
  setup() {
    //依赖注入
    const name = inject("name");

    return {
      name,
    };
  },
};
</script>

四、运行项目界面效果如下

点击改变名字按钮子组件孙组件 name 由张三变为李四

Vue3:组合式API-依赖注入（provide()、inject()）

1.provide()

提供一个值，可以被后代组件注入。

provide() 接受两个参数：第一个参数是要注入的 key，可以是一个字符串或者一个 symbol，第二个参数是要注入的值。

当使用 TypeScript 时，key 可以是一个被类型断言为 InjectionKey 的 symbol。InjectionKey 是一个 Vue 提供的工具类型，继承自 Symbol，可以用来同步 provide() 和 inject() 之间值的类型。

与注册生命周期钩子的 API 类似，provide() 必须在组件的 setup() 阶段同步调用。

2.inject()

注入一个由祖先组件或整个应用 (通过 app.provide()) 提供的值。

第一个参数是注入的 key。Vue 会遍历父组件链，通过匹配 key 来确定所提供的值。如果父组件链上多个组件对同一个 key 提供了值，那么离得更近的组件将会“覆盖”链上更远的组件所提供的值。如果没有能通过 key 匹配到值，inject() 将返回 undefined，除非提供了一个默认值。

第二个参数是可选的，即在没有匹配到 key 时使用的默认值。它也可以是一个工厂函数，用来返回某些创建起来比较复杂的值。如果默认值本身就是一个函数，那么你必须将 false 作为第三个参数传入，表明这个函数就是默认值，而不是一个工厂函数。

与注册生命周期钩子的 API 类似，inject() 必须在组件的 setup() 阶段同步调用。

当使用 TypeScript 时，key 可以是一个类型为 InjectionKey 的 symbol。InjectionKey 是一个 Vue 提供的工具类型，继承自 Symbol，可以用来同步 provide() 和 inject() 之间值的类型。

示例：
父组件

<template>
  <div>
    <div>
      <div>父：{{count}}</div>
    </div>
    <ChidlView></ChidlView>
    <button @click="ClickBtnChange">修改</button>
  </div>
</template>
<script lang="ts"  setup>
import { reactive, ref, getCurrentInstance, provide } from 'vue'
import ChidlView from './ChildView.vue'
const count = ref(0)
// 提供静态值
provide('foo', count)
const ClickBtnChange = () => {
  const random = Math.floor(Math.random() * 10 + 1)
  count.value = random
}
</script>

子组件

<template>
  <div class="ChildView">
   子：{{count}}
  </div>
</template>
<script lang="ts" name="ChildView" setup>
import { ref, watch, inject } from 'vue'
const count = ref(inject('foo'))
</script>

加载全部内容