记录--9个封装Vue组件的小技巧

Posted 2023-05-12 林恒

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了记录--9个封装Vue组件的小技巧相关的知识，希望对你有一定的参考价值。

这里给大家分享我在网上总结出来的一些知识，希望对大家有所帮助

组件是前端框架的基本构建块。把它们设计得更好会使我们的应用程序更容易改变和理解。在这节课中，分享一下在过去几年中工作中学到的 9 个技巧。

1. 你可能不需要创建一个组件

在创建一个组件之前，看看它是为了可重用性和为某些UI添加一个状态，还是仅仅为了组织和划分代码。

如果是后者，那么你就不需要创建它，因为它只会增加更多不必要的工作，比如传递props和发射事件。

不仅如此，它还要求我们跳转到该文件以查看它所包含的内容，而不是直接在父组件中看到它，这就干净多了。

2. 使用插槽而不是 prop 来显示内容

假设有一个可重复使用的按钮组件，它通过props获取文本。

<BaseButton label="Delete Item"/>

如果想在其中显示一个图标，必须添加更多的道具，如<BaseButton label="Delete Item" icon="delete" />并更新组件以显示该图标。

但有了插槽，我们就可以在每次使用该组件时，以想要的方式显示标签：

<BaseButton>
  Delete Item <Icon name="delete" />
</BaseButton>

或者你只需要把某个单词加粗。对于插槽，可以直接在文本中使用<strong>标记，而不是在组件中解析它。

3. 将该组件与触发它的因素分组

有时有两个独立的组件在某种情况下一起使用。最好把它们放在一个新的组件中，这样重复使用和移动它们更容易。

一个常见的例子是 Modal 组件。我们通常在点击一个特定的按钮时显示Modal。与其在每次我们想重用它（或把它移到其他地方）时添加showModal状态和导入modal与它的按钮，不如有一个单一的组件来显示按钮，当用户点击时，它显示相关的modal。

<!-- CreateItemButton.vue -->
<template>
  <Modal v-if="showModal" @close="showModal = false" />
  <BaseButton @click="showModal = true">
    Create Item
  </BaseButton>
</template>

<script setup>
const showModal = false
</script>

4. 使用 teleport，从任何地方显示固定位置的元素

继续前面的例子，如果我们想正确地显示 modal ，我们需要确保模态使用正确的z-index，并且它在HTML代码中显示在正确的位置，所以它总是显示在页面上所有东西的上面。

我们可以通过直接将 modal 显示为<body>元素的一个子元素来轻松地避免这个问题，无论我们在组件结构中使用它。

Teleport组件使我们能够做到这一点。

我们所要做的就是用 <Teleport to="body"> 来包装 modal 组件。

<!-- BaseModal.vue -->
<template>
  <Teleport to="body">
    <div class="modal"></div>
  </Teleport>
</template>

这个组件是Vue 3内置组件的一部分。如果你使用的是Vue 2，请查看PortalVue。

5. 在一个对象中分组相关的 props

组件的 prop 列表是组件界面的一个主要部分。接口越清晰，就越容易使用和推理。

改进 prop 列表的一个方法是将相关的属性分组在一起。以这个组件为例:

<PostCard
  :title="post.title"
  :date="post.date"
  :layout="currentLayout"
  :image="post.imageUrl"
  <!-- more props -->
/>

我们需要花几秒钟时间来了解这里有哪些 props 与帖子(post )相关。但我们可以像这样把与帖子相关的 props 分组，使之更加清晰。

<PostCard :post="post" :layout="currentLayout" />

所以现在我们很快就知道，layout 不是 post 数据的一部分。

不仅如此，我们还通过这种方法使更新 props 变得更加容易。例如，添加或删除与帖子相关的props ，不需要我们更新组件的 props 列表。

6. 赋予每个循环item,赋予自己的状态

创建一个新的组件的一个很好的理由是给一块用户界面提供它自己的状态。我们需要这样做的一个常见的地方是在v-for循环中：

<template>
  <div>
    <div v-for="(item, index) in items" :key="item.id">
      <input type="checkbox" v-model="checkedItems[index]">
    </div>
  </div>
</template>
<script setup>
const checkedItems = ref(items.map(item => item.checked))
</script>

为了跟踪检查过的 items，我们不得不创建一个数组，并用 items 的初始值来填充它。但是这段代码还不够强大。为了让它变得更好，我们必须让 items 通过它们的id而不是index 来访问，因为 index 是不可靠的，可以改变。例如，如果你添加一个支持通过拖放来重新排列items 的功能呢？

为了简化这段代码，我们可以引入一个新的组件，为每个 item 保存一个状态。像这样:

<template>
  <div>
    <Item v-for="item in items" :key="item.id" :item="item" />
  </div>
</template>

Item 组件内容如下：

<template>
  <div>
    <input type="checkbox" v-model="checked">
  </div>
</template>

<script setup>
const props = defineProps( item: Object )
const checked = ref(props.item.checked)
</script>

这种方法的另一个好处是，我们把所有 item 的相关数据、计算属性和方法都加在一个地方，便于理解和改变。

7. 尽可能地将加载数据移至其用户界面附近

无论你是用GraphQL还是其他API加载，最好把代码放在尽可能接近使用它的用户界面的地方。这有两个原因:

移动带有数据的UI组件变得更加容易。只需移动该组件，而无需寻找其依赖关系。
当所有的碎片被放在一个地方时，总是更容易理解代码--可以看到用户界面和它的数据来自哪里。

有时，有多个组件使用同一个获取的数据。在这种情况下，可以将获取的代码上移一级。因此，会有一个父组件，在那里获取数据，还有一个子组件，然后把数据传递给它。

但一定要确保它是一个单一的层次。如果不是，那就寻找一种方法来改进你的组件设计和它们之间的关系。

8. 纯粹的UI组件不应访问应用程序的状态

有两种类型的前端组件：纯UI组件和特定应用组件。

纯粹的UI组件是像按钮、输入框等。它们不应该知道关于应用程序的任何事情。它们的工作仅仅是为了显示UI--它们通过 props 获取数据。

特定于应用程序的组件是知道应用程序状态的组件，无论是本地状态还是全局状态(通过状态管理库，如Pinia)。

分离这些组件使得在应用程序的其他地方，甚至在其他应用程序中重用UI组件更加容易。

如果你正在构建自己的UI组件，这个技巧也适用。如果你使用的是外部库，如 Vuetify 或Quasar，那么你就不必担心这个问题--这些组件在设计时就考虑到了这一点。

9. 不要在组件中指定 width 或 margin

当创建一个组件时，你应该把它看作是一块UI，可以像其他本地元素一样使用。

让用户指定组件周围的空间是实现这一目标的好方法。

假设你的组件在其根元素上有一个顶部边距，而用户想把它显示在某个元素下面，但没有顶部边距。要做到这一点，用户必须设置一个与组件的margin相同的负margin，比如margin-top: -50px；更不用说在某些情况下，用户必须与选择器的特异性相匹配（或者可能使用!important）。

而宽度也是如此。如果用户想让该组件具有响应性，他们必须覆盖其宽度和最大宽度。

因此，通过不在组件内部设置宽度和边距，总是给用户这种控制是有意义的。

代码部署后可能存在的BUG没法实时知道，事后为了解决这些BUG，花了大量的时间进行log 调试，这边顺便给大家推荐一个好用的BUG监控工具 Fundebug。

来源：tahazsh.com/blog/vue-co…

本文转载于:

https://juejin.cn/post/7158969880362876964

如果对您有所帮助，欢迎您点个关注，我会定时更新技术文档，大家一起讨论学习，一起进步。

Vue 使用中的小技巧

在vue的使用过程中会遇到各种场景，当普通使用时觉得没什么，但是或许优化一下可以更高效更优美的进行开发。下面有一些我在日常开发的时候用到的小技巧，在下将不定期更新~

1、多图表resize事件去中心化

1.1 一般情况

有时候我们会遇到这样的场景，一个组件中有几个图表，在浏览器resize的时候我们希望图表也进行resize，因此我们会在父容器组件中写：

mounted() {

  setTimeout(() => window.onresize = () => {

    this.$refs.chart1.chartWrapperDom.resize()

    this.$refs.chart2.chartWrapperDom.resize()

    // ...

  }, 200)

destroyed() { window.onresize = null }

这样子图表组件如果跟父容器组件不在一个页面，子组件的状态就被放到父组件进行管理，为了维护方便，我们自然希望子组件的事件和状态由自己来维护，这样在添加删除组件的时候就不需要去父组件挨个修改

1.2 优化

这里使用了lodash的节流throttle函数，也可以自己实现，这篇文章也有节流的实现可以参考一下。以Echarts为例，在每个图表组件中：

computed: {

  /**

   * 图表DOM

   */

  chartWrapperDom() {

    const dom = document.getElementById(‘consume-analy-chart-wrapper‘)

    return dom && Echarts.init(dom)

  },

  /**

   * 图表resize节流，这里使用了lodash，也可以自己使用setTimout实现节流

   */

  chartResize() {

    return _.throttle(() => this.chartWrapperDom && this.chartWrapperDom.resize(), 400)

  }

},

mounted() {

  window.addEventListener(‘resize‘, this.chartResize)

},

destroyed() {

  window.removeEventListener(‘resize‘, this.chartResize)

}

1.3 再次优化

感谢 @JserWang 的提醒，这里因为多个 chart 实例都使用同一套初始化逻辑，可以使用 extends 来考虑复用，因此我想到了 Vue 提供的 Mixins，所以我在这里做了点优化，可以让每个同类型的 chart 组件更优雅一点：新建一个 mixin.js 文件：

import Echarts from ‘echarts‘

import _ from ‘lodash‘

export default {

  computed: {

    /* 图表DOM */

    $_chartMixin_chartWrapperDom() {

      const dom = document.getElementById(this.thisDomId)

      return dom && Echarts.init(dom)

    },

    

    /** 图表resize节流，这里使用了lodash，也可以自己使用setTimout实现节流 */

    $_chartMixin_chartResize() {

      return _.throttle(() => this.$_chartMixin_chartWrapperDom.resize(), 400)

    }

  },

  methods: {

    /* 图表初始化 */

    $_chartMixin_initChart() {

      this.$_chartMixin_chartWrapperDom.setOption({ /* options */ }

  },

  

  mounted() {

    this.$_chartMixin_initChart()

    window.addEventListener(‘resize‘, this.$_chartMixin_chartResize)

  },

  destroyed() {

    window.removeEventListener(‘resize‘, this.$_chartMixin_chartResize)

  }

}

然后在每个 chart 组件中：

<script type=‘text/javascript‘>

import ChartMixin from ‘./mixin‘

export default {

  mixins: [ChartMixin],

  data() {

    return {

      thisDomId: ‘consume-analy-chart-wrapper‘

    }

  }

}

</script>

这样就可以在每个图表组件中混入之前在 mixin.js 中定义的 resize 事件逻辑，且自动初始化，并在 destroyed 的时候自动销毁事件~

2、全局过滤器注册

2.1 一般情况

官方注册过滤器的方式：

export default {

  data () { return {} },

  filters:{

    orderBy (){

      // doSomething

    },

    uppercase () {

      // doSomething

    }

  }

}

但是我们做项目来说，大部分的过滤器是要全局使用的，不会每每用到就在组件里面去写，抽成全局的会更好些。官方注册全局的方式：

// 注册

Vue.filter(‘my-filter‘, function (value) {

  // 返回处理后的值

})

// getter，返回已注册的过滤器

var myFilter = Vue.filter(‘my-filter‘)

但是分散写的话不美观，因此可以抽出成单独文件。

2.2 优化

我们可以抽出到独立文件，然后使用Object.keys在main.js入口统一注册

/src/common/filters.js

let dateServer = value => value.replace(/(d{4})(d{2})(d{2})/g, ‘$1-$2-$3‘)

 

export { dateServer }

/src/main.js

import * as custom from ‘./common/filters/custom‘

Object.keys(custom).forEach(key => Vue.filter(key, custom[key]))

然后在其他的.vue 文件中就可愉快地使用这些我们定义好的全局过滤器了

<template>

  <section class="content">

    <p>{{ time | dateServer }}</p> <!-- 2016-01-01 -->

  </section>

</template>

<script>

  export default {

    data () {

      return {

        time: 20160101

      }

    }

  }

</script>

3、全局组件注册

3.1 一般情况

需要使用组件的场景：

<template>

    <BaseInput  v-model="searchText"  @keydown.enter="search"/>

    <BaseButton @click="search">

        <BaseIcon name="search"/>

    </BaseButton>

</template>

<script>

    import BaseButton from ‘./baseButton‘

    import BaseIcon from ‘./baseIcon‘

    import BaseInput from ‘./baseInput‘

    export default {

      components: { BaseButton, BaseIcon, BaseInput }

    }

</script>

我们写了一堆基础UI组件，然后每次我们需要使用这些组件的时候，都得先import，然后声明components，很繁琐，这里可以使用统一注册的形式

3.2 优化

我们需要借助一下神器webpack，使用 require.context() 方法来创建自己的模块上下文，从而实现自动动态require组件。这个方法需要3个参数：要搜索的文件夹目录、是否还应该搜索它的子目录、以及一个匹配文件的正则表达式。我们在components文件夹添加一个叫componentRegister.js的文件，在这个文件里借助webpack动态将需要的基础组件统统打包进来。

/src/components/componentRegister.js

import Vue from ‘vue‘

 

/**

* 首字母大写

* @param str 字符串

* @example heheHaha

* <a href="http://www.jobbole.com/members/wx1409399284">@return</a> {string} HeheHaha

*/

function capitalizeFirstLetter(str) {

  return str.charAt(0).toUpperCase() + str.slice(1)

}

 

/**

* 对符合‘xx/xx.vue‘组件格式的组件取组件名

* @param str fileName

* @example abc/bcd/def/basicTable.vue

* <a href="http://www.jobbole.com/members/wx1409399284">@return</a> {string} BasicTable

*/

function validateFileName(str) {

  return /^S+.vue$/.test(str) &&

    str.replace(/^S+/(w+).vue$/, (rs, $1) => capitalizeFirstLetter($1))

}

 

const requireComponent = require.context(‘./‘, true, /.vue$/)

 

// 找到组件文件夹下以.vue命名的文件，如果文件名为index，那么取组件中的name作为注册的组件名

requireComponent.keys().forEach(filePath => {

  const componentConfig = requireComponent(filePath)

  const fileName = validateFileName(filePath)

  const componentName = fileName.toLowerCase() === ‘index‘

    ? capitalizeFirstLetter(componentConfig.default.name)

    : fileName

  Vue.component(componentName, componentConfig.default || componentConfig)

})

这里文件夹结构：

components

│ componentRegister.js

├─BasicTable

│ BasicTable.vue

├─MultiCondition

│ index.vue

这里对组件名做了判断，如果是index的话就取组件中的name属性处理后作为注册组件名，所以最后注册的组件为：multi-condition、basic-table 最后我们在main.js中import ‘components/componentRegister.js’，然后我们就可以随时随地使用这些基础组件，无需手动引入了~

4、不同路由的组件复用

4.1 场景还原

当某个场景中vue-router从/post-page/a，跳转到/post-page/b。然后我们惊人的发现，页面跳转后数据竟然没更新？！原因是vue-router”智能地”发现这是同一个组件，然后它就决定要复用这个组件，所以你在created函数里写的方法压根就没执行。通常的解决方案是监听$route的变化来初始化数据，如下：

data() {

  return {

    loading: false,

    error: null,

    post: null

  }

},

watch: {

  ‘$route‘: {        // 使用watch来监控是否是同一个路由

    handler: ‘resetData‘,

    immediate: true

  }

},

methods: {

  resetData() {

    this.loading = false

    this.error = null

    this.post = null

    this.getPost(this.$route.params.id)

  },

  getPost(id){ }

}

4.2 优化

为了实现这样的效果可以给router-view添加一个不同的key，这样即使是公用组件，只要url变化了，就一定会重新创建这个组件。

<router-view :key="$route.fullpath"></router-view>

还可以在其后加+ +new Date()时间戳，保证独一无二

感谢网友 @rolitter 的提醒，如果组件被放在<keep-alive>中的话，可以把获取新数据的方法放在activated钩子，代替原来在created、mounted钩子中获取数据的任务。

5、组件事件属性穿透

5.1 一般情况

// 父组件

<BaseInput :value="value"

           label="密码"

           placeholder="请填写密码"

           @input="handleInput"

           @focus="handleFocus">

</BaseInput>

 

// 子组件

<template>

  <label>

    {{ label }}

    <input :value=" value"

           :placeholder="placeholder"

           @focus="$emit(‘focus‘, $event)"

           @input="$emit(‘input‘, $event.target.value)">

  </label>

</template>

5.2 优化

vue的组件实例中的$props、$attrs给我们提供了很大的便利，特别是父子组件传值的时候。 1、每一个从父组件传到子组件的props,我们都得在子组件的Props中显式的声明才能使用。这样一来，我们的子组件每次都需要申明一大堆props，这里我们知道v-bind 是可以传对象的，可以在 vm.$props 中拿到所有父组件props的值 v-bind="$props"

<input  v-bind="$props"

       @input="$emit(‘input‘, $event.target.value)">

2、类似placeholer这种dom原生的property可以使用$attrs直接从父传到子，无需声明。方法如下：

<input :value="value"

       v-bind="$attrs"

       @input="$emit(‘input‘, $event.target.value)">

$attrs包含了父作用域中不作为 prop 被识别 (且获取) 的特性绑定 (class 和 style 除外)。当一个组件没有声明任何 prop 时，这里会包含所有父作用域的绑定，并且可以通过 v-bind="$attrs" 传入内部组件。

3、注意到子组件的@focus="$emit(‘focus‘, $event)"其实什么都没做，只是把event传回给父组件而已，那其实和上面类似，完全没必要显式地申明：

<input :value="value"

       v-bind="$attrs"

       v-on="listeners"/>

 

computed: {

  listeners() {

    return {

      ...this.$listeners,

      input: event =>

        this.$emit(‘input‘, event.target.value)

    }

  }

}

$listeners包含了父作用域中的 (不含 .native 修饰器的) v-on 事件监听器。它可以通过 v-on="$listeners" 传入内部组件——在创建更高层次的组件时非常有用。

需要注意的是，由于我们input并不是BaseInput这个组件的根节点，而默认情况下父作用域的不被认作 props 的特性绑定将会“回退”且作为普通的 HTML 特性应用在子组件的根元素上。所以我们需要设置 inheritAttrs: false，这些默认行为将会被去掉，上面优化才能成功。

6、路由根据开发状态懒加载

6.1 一般情况

一般我们在路由中加载组件的时候：

import Login from ‘@/views/login.vue‘

 

export default new Router({

  routes: [{ path: ‘/login‘, name: ‘登陆‘, component: Login}]

})

当你需要懒加载 lazy-loading 的时候，需要一个个把routes的component改为() => import(‘@/views/login.vue‘)，甚为麻烦。

当你的项目页面越来越多之后，在开发环境之中使用 lazy-loading 会变得不太合适，每次更改代码触发热更新都会变得非常的慢。所以建议只在生成环境之中使用路由懒加载功能。

6.2 优化

根据Vue的异步组件和Webpack的代码分割功能可以轻松实现组件的懒加载，如：

const Foo = () => import(‘./Foo.vue‘)

在区分开发环境与生产环境时，可以在路由文件夹下分别新建两个文件：

_import_production.js

module.exports = file => () => import(‘@/views/‘ + file + ‘.vue‘)

_import_development.js (这种写法vue-loader版本至少v13.0.0以上)

module.exports = file => require(‘@/views/‘ + file + ‘.vue‘).default

而在设置路由的router/index.js文件中：

const _import = require(‘./_import_‘ + process.env.NODE_ENV)

 

export default new Router({

  routes: [{ path: ‘/login‘, name: ‘登陆‘, component: _import(‘login/index‘) }]

})

这样组件在开发环境下就是非懒加载，生产环境下就是懒加载的了

7 、vue-loader小技巧

vue-loader 是处理 *.vue 文件的 webpack loader。它本身提供了丰富的 API，有些 API 很实用但很少被人熟知。例如接下来要介绍的 preserveWhitespace 和 transformToRequire

7.1 用 preserveWhitespace 减少文件体积

有些时候我们在写模板时不想让元素和元素之间有空格，可能会写成这样：

<ul>

  <li>1111</li><li>2222</li><li>333</li>

</ul>

当然还有其他方式，比如设置字体的font-size: 0，然后给需要的内容单独设置字体大小，目的是为了去掉元素间的空格。其实我们完全可以通过配置 vue-loader 实现这一需求。

{

  vue: {

    preserveWhitespace: false

  }

}

它的作用是阻止元素间生成空白内容，在 Vue 模板编译后使用 _v(" ") 表示。如果项目中模板内容多的话，它们还是会占用一些文件体积的。例如 Element 配置该属性后，未压缩情况下文件体积减少了近 30Kb。

7.2 使用 transformToRequire 再也不用把图片写成变量了

以前在写 Vue 的时候经常会写到这样的代码：把图片提前 require 传给一个变量再传给组件。

<template>

  <div>

    <avatar :default-src="DEFAULT_AVATAR"></avatar>

  </div>

</template>

<script>

  export default {

    created () {

      this.DEFAULT_AVATAR = require(‘./assets/default-avatar.png‘)

    }

  }

</script>

其实通过配置 transformToRequire 后，就可以直接配置，这样vue-loader会把对应的属性自动 require 之后传给组件

{

  vue: {

    transformToRequire: {

      avatar: [‘default-src‘]

    }

  }

}

于是我们代码就可以简化不少

<template>

  <div>

    <avatar default-src="./assets/default-avatar.png"></avatar>

  </div>

</template>

在 vue-cli 的 webpack 模板下，默认配置是：

transformToRequire: {

  video: [‘src‘, ‘poster‘],

  source: ‘src‘,

  img: ‘src‘,

  image: ‘xlink:href‘

}

可以举一反三进行一下类似的配置

vue-loader 还有很多实用的 API 例如最近加入的自定义块，感兴趣的各位可以去文档里找找看。

8、 render 函数

在某些场景下你可能需要 render 渲染函数带来的完全编程能力来解决不太容易解决的问题，特别是要动态选择生成标签和组件类型的场景。

8.1 动态标签

1. 一般情况

比如根据props来生成标签的场景

<template>

  <div>

    <div v-if="level === 1"> <slot></slot> </div>

    <p v-else-if="level === 2"> <slot></slot> </p>

    <h1 v-else-if="level === 3"> <slot></slot> </h1>

    <h2 v-else-if="level === 4"> <slot></slot> </h2>

    <strong v-else-if="level === 5"> <slot></slot> </stong>

    <textarea v-else-if="level === 6"> <slot></slot> </textarea>

  </div>

</template>

其中level是data中的变量，可以看到这里有大量重复代码，如果逻辑复杂点，加上一些绑定和判断就更复杂了，这里可以利用 render 函数来对要生成的标签加以判断。

2. 优化

使用 render 方法根据参数来生成对应标签可以避免上面的情况。

<template>

  <div>

    <child :level="level">Hello world!</child>

  </div>

</template>

 

<script type=‘text/javascript‘>

  import Vue from ‘vue‘

  Vue.component(‘child‘, {

    render(h) {

      const tag = [‘div‘, ‘p‘, ‘strong‘, ‘h1‘, ‘h2‘, ‘textarea‘][this.level]

      return h(tag, this.$slots.default)

    },

    props: {

      level: {  type: Number,  required: true  }

    }

  })  

  export default {

    name: ‘hehe‘,

    data() { return { level: 3 } }

  }

</script>

示例可以查看 CodePen（https://codepen.io/SHERlocked93/pen/mLEJPE）

8.2 动态组件

当然render函数还有很多用法，比如要使用动态组件，除了使用 :is 之外也可以使用render函数

<template>

  <div>

    <button @click=‘level = 0‘>嘻嘻</button>

    <button @click=‘level = 1‘>哈哈</button>

    <hr>

    <child :level="level"></child>

  </div>

</template>

 

<script type=‘text/javascript‘>

  import Vue from ‘vue‘

  import Xixi from ‘./Xixi‘

  import Haha from ‘./Haha‘

  Vue.component(‘child‘, {

    render(h) {

      const tag = [‘xixi‘, ‘haha‘][this.level]

      return h(tag, this.$slots.default)

    },

    props: { level: { type: Number, required: true } },

    components: { Xixi, Haha }

  })

  export default {

    name: ‘hehe‘,

    data() { return { level: 0 } }

  }

</script>

以上是关于记录--9个封装Vue组件的小技巧的主要内容，如果未能解决你的问题，请参考以下文章