【vue3】聊一聊组件的二次封装

背景

对组件的二次封装应该每个人都有做过,但在进行二次封装的时候都会遇到三个问题,下面针对这三个问题简单实现一下组件的二次封装。以下内容将以封装 Element UI 的el-input组件为示例。

第一个问题:属性绑定

在对组件封装的时候遇到的第一个问题就是绑定属性了,简单说就是将二次封装的组件属性绑定到el-input组件上。
可能有些小伙伴做的时候会将el-input的属性全部写到封装组件 props 里面,然后再将这些属性绑定到el-input组件上。这样做不是不行,但是太鸡肋了,而且浪费时间。那该如何做呢?

在 vue 实例中有一个属性$attrs,这个属性包含了组件所有透传attributes的对象。是指由父组件传入,且没有被子组件声明为 props 或是组件自定义事件的 attributes 和事件处理函数。
那我们就可以直接将$attrsv-bind动态绑定到el-input组件上就可以解决第一个问题了。

<template>
  <el-input ref="refInput" v-bind="$attrs"></el-input>
</template>

<script>
export default {
}
</script>

第二个问题:插槽

第二个问题就是插槽的绑定了,可以和属性绑定一样,将所有的插槽全部写出来,然后再一个一个写到el-input组件上,如果插槽不多,也没有什么影响,但是如果插槽很多呢,如果二次封装的是有可能会修改的组件呢?那这个二次封装的组件也要同步修改,很麻烦!那又该如何做呢?

我们可以通过另一个属性$slots,这个属性表示父组件所传入插槽的对象。每一个插槽都在$slots上暴露为一个函数,返回一个 vnode 数组,同时 key 名对应着插槽名。
那我们就可以遍历$slots动态绑定到el-input组件上就可以解决第二个问题了。

<template>
  <el-input ref="refInput" v-bind="$attrs">
    <template v-for="(value, name) in $slots" #[name]>
      <slot :name="name" />
    </template>
  </el-input>
</template>

<script>
export default {
}
</script>

但如果再考虑得深一点,你会发现有的时候这个组件会向这个插槽传递一些数据,就是作用域插槽了。

<template>
  <el-input ref="refInput" v-bind="$attrs">
    <template v-for="(_value, name) in $slots" #[name]="slotData">
      <slot :name="name" v-bind="slotData || {}" />
    </template>
  </el-input>
</template>

<script>
export default {
}
</script>

第三个比较恶心的问题: ref

我们使用组件的时候保不齐就会使用ref调用组件里面暴露的方法。我们可以通过这么几种方式实现:

  • 暴露el-inputref,然后通过this.$ref[二次封装组件的ref][el-input的ref].focus()的方式调用。
  • 在组件内重新写el-input的方法并绑定到el-input组件上,然后暴露出去。

以上这两种方式都可以是现实,但是我们实际开发过程中如果组件被修改了,那所有使用该组件的地方都需要进行调整,而且咱们都不希望写这么多无聊的代码。就出现了以下主要介绍方式:

我们换一种思路,我们要做的无非就是将el-input的方法提取到我们封装的组件上暴露给使用组件的地方使用。那我们就可以将el-input的方法通过ref的方式获取到然后放到封装组件的实例里面去。

在进行组合式API封装前先介绍一个属性expose,用于声明当组件实例被父组件通过模板引用访问时暴露的公共属性。默认情况下,当通过 $parent$root 或模板引用访问时,组件实例将向父组件暴露所有的实例属性。

选项式

<template>
  <el-input ref="refInput" v-bind="$attrs">
    <template v-for="(_value, name) in $slots" #[name]="slotData">
      <slot :name="name" v-bind="slotData || {}" />
    </template>
  </el-input>
</template>

<script>
export default {
  data() {
    return {}
  },
  mounted() {
    const entries = Object.entries(this.$refs.refInput)
    for(const [key, value] of entries) {
      this[key] = value
    }
  }
}
</script>

组合式

在组合式setup函数中我们需要先通过getCurrentInstance方法获取当前组件实例,然后将提取el-input组件暴露的方法暴露出去。需要注意的是我们在使用setup方法的时候会在最后将需要使用到的属性或者方法return出去使用。但是在setup函数它在beforeCreate之前发生,所以我们获取不到el-input组件的实例,所以就需要在onMounted的时候将el-input组件暴露的方法加到当前组件实例的expose属性中,但是没有主动声明暴露的时候expose属性是null,所以我们需要先主动声明暴露,在onMounted的时候将el-input组件暴露的方法添加到expose中。

<template>
  <el-input ref="refInput" v-bind="$attrs">
    <template v-for="(_value, name) in $slots" #[name]="slotData">
      <slot :name="name" v-bind="slotData || {}" />
    </template>
  </el-input>
</template>

<script>
import { ref, onMounted, getCurrentInstance }  from 'vue'
export default {
  setup(props, context) {
    const instance = getCurrentInstance()

    const refInput = ref()
    
    onMounted(() => {
      const entries = Object.entries(refInput.value.$.exposed)
      for (const [key, value] of entries) {
        instance.exposed[key] = value
      }
    })

    context.expose()
    return {
      refInput
    }
  }
}
</script>

setup标签

setup标签写法与组合式封装方法相似。不同的是在setup标签中当前组件实例的expose不为null,所以不需要主动声明暴露。

<template>
  <el-input ref="refInput" v-bind="$attrs">
    <template v-for="(_value, name) in $slots" #[name]="slotData">
      <slot :name="name" v-bind="slotData || {}" />
    </template>
  </el-input>
</template>

<script setup>
import { ref, onMounted, getCurrentInstance }  from 'vue'

const instance = getCurrentInstance()

const refInput = ref()

onMounted(() => {
  const entries = Object.entries(refInput.value.$.exposed)
  for (const [key, value] of entries) {
    instance.exposed[key] = value
  }
})
</script>

以上就是Vue3组件二次封装的内容,附上源码

感谢看官看到这里,如果觉得文章不错的话,可以给小生的几个开源项目点个Star⭐!

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,911评论 5 460
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 82,014评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 142,129评论 0 320
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,283评论 1 264
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,159评论 4 357
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,161评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,565评论 3 382
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,251评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,531评论 1 292
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,619评论 2 310
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,383评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,255评论 3 313
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,624评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,916评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,199评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,553评论 2 342
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,756评论 2 335

推荐阅读更多精彩内容