Vue 3 Composition API 在多个组件中重用

Question

我有这些文件

App.vue、Header.vue、search.js 和 Search.vue

App.vue是正常的，只是添加了不同的视图

Header.vue有一个输入框

<input type="text" v-model="searchPin" @keyup="searchResults" />
<div>{{searchPin}}</div>

和脚本：

import useSearch from "@/compositions/search";

export default {
  name: "Header",
  setup() {
    const { searchPin, searchResults } = useSearch();

    return {
      searchPin,
      searchResults
    };
  }
};

search.js 有可重复使用的代码

import { ref } from "vue";

export default function useSearch() {
  const searchPin = ref("");

  function searchResults() {
    return searchPin.value;
  }

  return {
    searchPin,
    searchResults
  };
}

现在，这运行良好。在输入框中添加内容后，它会显示在下面的 div 中。

我不明白的是如何将此代码用于第三个组件，如 Search.vue。

我有这个，但它不起作用。

<template>
  <div>
    <h1 class="mt-3">Search</h1>
    <div>{{ searchPin }}</div>
  </div>
</template>

<script>
  import useSearch from "@/compositions/search";

  export default {
    name: "Search",
    setup() {
      const { searchPin, searchResults } = useSearch();

      return {
        searchPin,
        searchResults
      };
    }
  };
</script>

我错过了什么？谢谢。

Answer 1

这个问题的修复非常简单

而不是

import { ref } from "vue";

export default function useSearch() {
  const searchPin = ref("");

  function searchResults() {
    return searchPin.value;
  }

  return {
    searchPin,
    searchResults
  };
}

使用

import { ref } from "vue";

const searchPin = ref("");

export default function useSearch() {  

  function searchResults() {
    return searchPin.value;
  }

  return {
    searchPin,
    searchResults
  };
}

问题是 searchPin 的作用域是函数，所以每次调用函数时，它都会得到一个新的 ref。在某些情况下这是一个理想的效果，但在您的情况下，您需要将其删除。

这是一个同时使用两者的示例，希望它能说明问题。

const {
  defineComponent,
  createApp,
  ref
} = Vue


const searchPin = ref("");

function useSearch() {
    const searchPinLoc = ref("");

  function searchResults() {
    return searchPin.value + "|" + searchPinLoc.value;
  }

  return {
    searchPin,
    searchPinLoc,
    searchResults
  };
}

const HeaderComponent = defineComponent({
  template: document.getElementById("Header").innerHTML,
  setup() {
    return useSearch();
  },
})


const SearchComponent = defineComponent({
  template: document.getElementById("Search").innerHTML,
  setup() {
    return useSearch();
  }
})

createApp({
  el: '#app',
  components: {
    HeaderComponent, SearchComponent
  },
  setup() {}
}).mount('#app')

<script src="https://unpkg.com/vue@3.0.0-rc.9/dist/vue.global.js"></script>
<div id="app">
  <header-component></header-component>
  <search-component></search-component>
</div>

<template id="Header">
  searchPin : <input type="text" v-model="searchPin" @keyup="searchResults" />
  searchPinLoc : <input type="text" v-model="searchPinLoc" @keyup="searchResults" />
  <div>both: {{searchResults()}}</div>
</template>

<template id="Search">
  <div>
    <h1 class="mt-3">Search</h1>
    <div>both: {{searchResults()}}</div>
  </div>
</template>

Answer 2

为@Daniel 的回答添加风味。这正是我在 ATM 最佳实践方面苦苦思索的问题，并得出了一些结论：

将 Ref 拉到组合 fn 之外可以解决您的问题，但如果您考虑一下，这就像共享在多个地方使用的数据属性的单个实例。你应该非常小心，因为 ref 对于任何拉动它的人来说都是可变的，并且很容易破坏单向数据流。例如在父组件和子组件之间共享一个 Ref 实例可以比作将它从父组件的数据传递到子组件的 props，而且我假设我们都知道我们应该避免直接改变 props

所以你的问题的经典答案是，将它移动到 Vuex 状态并从那里读取它。

但是如果你有一个小的应用程序，不想要状态管理器，或者只是想充分利用组合 API，那么我的建议是至少做一些这种模式

import { ref, computed } from "vue";

const _searchPin = ref(""); // Mutable persistant prop

const searchPin = computed(() => _searchPin.value); // Readonly computed prop to expose

export default function useSearch() {  

  function searchResults() {
    return searchPin.value;
  }

  return {
    searchPin,
    searchResults
  };
}

不超过一个组件应该改变持久性 Ref 而其他组件只能听取计算的 Ref。

如果您发现不止一个组件需要访问权限来更改 ref，那么这可能表明您应该找到另一种方法来实现它（Vuex、道具和事件等...）

正如我所说，我仍在尝试自己理解这一点，我也不确定这是否是一个足够好的模式，但它肯定比简单地公开实例要好。

代码安排的另一种选择是封装在 2 个不同的访问钩子中

import { ref, readonly } from "vue";

const searchPin = ref(""); // Mutable persistant prop

export const useSearchSharedLogic() {
  return readonly({
    searchPin
  })
}

const useSearchWriteLogic() {
  return {
    searchPin
  }
}

// ----------- In another file -----------

export default function useSearch() {  

  const { searchPin } = useSearchSharedLogic()

  function searchResults() {
    return searchPin.value;
  }

  return {
    searchPin,
    searchResults
  };
}

或类似的东西（甚至不确定这是否会像写的那样正常工作）。重点是，不要直接公开单个实例

另一点值得一提的是，这个答案采取措施来保持单向数据流模式。尽管这是多年来经过验证的基本模式，但它并非一成不变。随着组合模式在关闭时间变得更加清晰，IMO 我们可能会看到人们试图挑战这个概念并在某种意义上返回到 Angular 1 中的双向模式，这在当时造成了很多问题并且没有很好地实现

Vue 3 Composition API 在多个组件中重用

Vue 3 Composition API reuse in multiple components

components

vue.js

vuejs3

vue-composition-api