Vue组件二次封装的一些实用技巧总结

更新时间：2022年04月29日 10:57:48 作者：口水鱼

我们在做项目经常会遇到组件功能不能满足业务需求的时候,这时候需要在原有的组件上进行二次封装,下面这篇文章主要给大家介绍了关于Vue组件二次封装的一些实用技巧,需要的朋友可以参考下

前言

在开发Vue项目我们一般使用第三方UI组件库进行开发，如element-plus, @arco-design/web-Vue, naive-ui等, 但是这些组件提供的接口并不一定满足我们的需求，这时我们可以通过对组件库组件的二次封装，来满足我们特殊的需求。

对于封装组件有一个大原则就是我们应该尽量保持原有组件的接口，除了我们需要封装的功能外，我们不应该改变原有组件的接口，即保持原有组件提供的接口如props,events,slots等不变。

为了实现这一原则我们就需要将新组件的接口与旧组件的接口一一对应, 当然我们可以通过在新组件中一一声明对应的接口来实现（或者只实现我们目前需要用到的接口）但这种办法虽然简单但看起来却极其很繁琐, 有没有一种方法可以实现props,events,slots的自动透传呢？

透传 Attribute

我们可以使用一个没有参数的 v-bind来实现props,events的透传，它会将一个对象的所有属性都作为 attribute 应用到目标元素或组件上, 这在官方文档中有着详细介绍。

<BaseButton v-bind="$attrs"/>

其中$attrs包含组件可以透传属性的对象, 透传属性包括props,events, class,style,id等。(不包含接收组件显式声明的 props、emits以及slots )

如下,是一个封装el-input的默认可清空的的组件，由于我们已经在defineProps声明过clearable, 所以此时我们需要显性传递clearable属性

<template>
  <div class="my-input">
    {{ label }}
    <el-input v-bind="$attrs" :clearable="clearable"></el-input>
  </div>
</template>

<script setup>
defineProps({
  label: String,
  clearable: {
    type: Boolean,
    default: true,
  },
});
</script>

如果我们不希望透传某些属性比如class, 我们可以通过useAttrs来实现

<template>
  <div class="my-input">
    {{ label }}
    <el-input v-bind="filteredAttrs" :clearable="clearable"></el-input>
  </div>
</template>

<script setup>
import { computed, useAttrs } from 'Vue';

defineProps({
  label: String,
  clearable: {
    type: Boolean,
    default: true,
  },
});

const attrs = useAttrs();
const filteredAttrs = computed(() => {
  return { ...attrs, class: undefined };
});
</script>

上述封装的组件还有个缺点, 就是我们将无法使用el-input本身提供的slot,下面我们就来实现一个可以透传 slot的组件

透传 slot

slot可以通过下面这种方式透传的

<!-- 在组件中创建新的对应名称的插槽 -->
<template #slotName>
<!-- 在插槽内部使用对应名称的插槽 -->
    <slot name="slotName" />
</template>

普通slot

如果透传的slot比较少，我们可以通过在封装组件内部定义并使用插槽<template v-slot:slotName><slot name="slotName" /></template>来透传插槽

<template #slotName>
    <slot name="slotName" />
</template>

动态插槽名

如果需要透传的slot不固定或者较多，我们可以通过动态插槽名称透传

<template #[slotName] v-for="(slot, slotName) in $slots" >
    <slot :name="slotName" />
</template>

如下是一个透传的slot的el-input组件

<template>
  <div class="my-input">
    {{ label }}
    <el-input v-bind="$attrs" :clearable="clearable">
      <template #[slotName] v-for="(slot, slotName) in $slots">
          <slot :name="slotName" />
      </template>
    </el-input>
  </div>
</template>

<script setup>
defineProps({
  label: String,
  clearable: {
    type: Boolean,
    default: true,
  },
});
</script>

作用域插槽

如果需要封装组件使用了作用域插槽，我们可以通过<template v-slot:slotName="slotProps"><slot name="slotName" v-bind="slotProps"/></template>来透传作用域插槽插槽。

<template #[slotName]="slotProps" v-for="(slot, slotName) in $slots" >
    <slot :name="slotName" v-bind="slotProps"/>
</template>

封装组件存在的问题

组件实例属性和方法的调用

封装后的组件我们无法按照之前的情况调用组件实例中的属性和方法，比如BaseButton有focus方法,在封装之前我们可以通过下面这种方式调用

// 调用BaseButton的组件父组件
// <BaseButton ref="button">
const button = ref();
button.value.focus()

对于封装后的组件，由于此时button指向我们的MyButton,并不指向BaseButton的实例，所以我们需要在包装的组件中声明并暴露BaseButton事例

//我们封装的组件
// MyButton.Vue
// <BaseButton ref="button">
const button = ref();

注意如果我们使用 <script setup>，是没办法访问实例中的属性的，详情参考vuejs.org/api/sfc-scr…

此时可以通过defineExpose显式公开ref属性

// 我们封装的组件
// MyButton.Vue
// <BaseButton ref="button">
const button = ref();
defineExpose({
  button
});

然后在父组件中我就可以通过实例链式调用封装的组件了

// <MyButton ref="button">
const button = ref();
button.value.button.focus()

总结

到此这篇关于Vue组件二次封装的一些实用技巧的文章就介绍到这了,更多相关Vue组件二次封装内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Vue axios和vue-axios的关系及使用区别
axios是基于promise的HTTP库，可以使用在浏览器和node.js中，它不是vue的第三方插件，vue-axios是axios集成到Vue.js的小包装器，可以像插件一样安装使用:Vue.use(VueAxios, axios)，本文给大家介绍Vue axios和vue-axios关系，感兴趣的朋友一起看看吧
2022-08-08
vue3.0报错Cannot find module‘worker_threads‘的解决办法
这篇文章介绍了vue3.0报错Cannot find module‘worker_threads‘的解决办法。对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2021-11-11
vue+高德地图实现地图搜索及点击定位操作
这篇文章主要介绍了vue+高德地图实现地图搜索及点击定位操作，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2020-09-09
解决vue v-for src 图片路径问题 404
今天小编就为大家分享一篇解决vue v-for src 图片路径问题 404，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2019-11-11
vue源码入口文件分析(推荐)
这篇文章主要介绍了vue源码入口文件分析(推荐)，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2018-01-01
vue单页应用中如何使用jquery的方法示例
最近在工作中遇到的一个需求，需要在vue-cli建立的应用中引入jquery的方式，通过查找相关的资料最终解决了，所以这篇文章主要给大家介绍了关于在vue单页应用中如何使用jquery的方法示例，需要的朋友可以参考借鉴，下面来一起看看吧。
2017-07-07
vue 监听是否切屏和开启小窗的实现过程
这篇文章主要介绍了vue 监听是否切屏和开启小窗的过程，本文通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2023-04-04
Vue3对比Vue2的优点总结
vue3解决了vue2的一些缺陷与弊端，学习新的技术是很有必要的，本文总结了一些vue3的优点，希望各位能尽快转入vue3的使用中
2021-06-06
前端自动化测试Vue中TDD和单元测试示例详解
这篇文章主要为大家介绍了前端自动化测试Vue中TDD和单元测试示例详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2023-02-02
vue使用require.context实现动态注册路由
这篇文章主要介绍了vue使用require.context实现动态注册路由的方法，帮助大家更好的理解和使用vue框架，感兴趣的朋友可以了解下
2020-12-12