Vue3 补充:\$attrs和\$listeners属性

Vue3 补充:$attrs和$listeners属性

这篇文章主要给大家介绍了关于Vue v2.4中新增的$attrs及$listeners属性的使用方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着我来一起学习学习吧。

1. 前言

多级组件嵌套需要传递数据时,通常使用的方法是通过vuex。如果仅仅是传递数据,而不做中间处理,使用 vuex 处理,未免有点杀鸡用牛刀。Vue 2.4 版本提供了另一种方法,使用 v-bind=”$attrs”, 将父组件中不被认为 props特性绑定的属性传入子组件中,通常配合 interitAttrs 选项一起使用。之所以要提到这两个属性,是因为两者的出现使得组件之间跨组件的通信在不依赖 vuex 和事件总线的情况下变得简洁,业务清晰。

首先分析以下应用场景:

Vue3 补充:\$attrs和\$listeners属性

2. A 组件与 B 组件之间的通信: (父子组件)

如上图所示,A、B、C三个组件依次嵌套,按照 Vue 的开发习惯,父子组件通信可以通过以下方式实现:

  • A to B 通过props的方式向子组件传递,B to A 通过在 B 组件中 $emit, A 组件中 v-on 的方式实现
  • 通过设置全局Vuex共享状态,通过 computed 计算属性和 commit mutation的方式实现数据的获取和更新,以达到父子组件通信的目的。
  • Vue Event Bus,使用Vue的实例,实现事件的监听和发布,实现组件之间的传递。

往往数据在不需要全局的情况而仅仅是父子组件通信时,使用第一种方式即可满足。

3. A 组件与 C 组件之间的通信: (跨多级的组件嵌套关系)

如上图,A 组件与 C 组件之间属于跨多级的组件嵌套关系,以往两者之间如需实现通信,往往通过以下方式实现:

  • 借助 B 组件的中转,从上到下props依次传递,从下至上,$emit事件的传递,达到跨级组件通信的效果
  • 借助Vuex的全局状态共享
  • Vue Event Bus,使用Vue的实例,实现事件的监听和发布,实现组件之间的传递。

很显然,第一种通过props和$emit的方式,使得组件之间的业务逻辑臃肿不堪,B组件在其中仅仅充当的是一个中转站的作用。如使用第二种 Vuex的方式,某些情况下似乎又有点大材小用的意味,(仅仅是想实现组件之间的一个数据传递,并非数据共享的概念)。第三种情况的使用在实际的项目操作中发现,如不能实现很好的事件监听与发布的管理,往往容易导致数据流的混乱,在多人协作的项目中,不利于项目的维护。

$attrs以及$listeners的出现解决的就是第一种情况的问题,B 组件在其中传递props以及事件的过程中,不必在写多余的代码,仅仅是将$attrs以及$listeners向上或者向下传递即可。

4. 示例代码

  • 父组件(Father.vue),给子组件关联数据,子组件如果不用props接收,那么这些数据就作为普通的HTML特性应用在子组件的根元素上

    <template>
      <div>
        <el-table :data='list'>
          <el-table-column
            prop="name"
            label="姓名"
          ></el-table-column>
          <el-table-column
            prop="study"
            label="学习科目"
          ></el-table-column>
          <el-table-column label="操作">
            <template slot-scope="scope">
              <el-button @click='transmitClick(scope.row)'>传递</el-button>
            </template>
          </el-table-column>
        </el-table>
        
        <!-- 儿子组件 -->
        <ChildView
          :is-show="isOpen"
          :row="row"
        >
        </ChildView>
      </div>
    </template>
    
    <script>
    import ChildView from './Child.vue'
    export default {
      components: { ChildView },
      data() {
        return {
          isOpen: false,
          row: {},
          list: [
            { name: '王丽', study: 'Java' },
            { name: '李克', study: 'Python' }
          ]
        }
      },
      methods: {
        // 传递事件
        transmitClick(row) {
          this.isOpen = true;
          this.row = row
        }
      }
    }
    </script>
    
  • 儿子组件(Child.vue),中间层,作为父组件和孙子组件的传递中介,在儿子组件中给孙子组件添加v-bind="$attrs",这样孙子组件才能接收到数据

    <template>
      <div class='child-view'>
        <p>儿子组件</p>
        <GrandChild v-bind="$attrs"></GrandChild>
      </div>
    </template>
    
    <script>
    import GrandChild from './GrandChild.vue'
    export default {
      // 继承所有父组件的内容
      inheritAttrs: true,
      components: { GrandChild },
      data() {
        return {
        }
      }
    }
    </script>
    
    <style lang="stylus">
    .child-view {
      margin: 20px
      border: 2px solid red
      padding: 20px
    }
    </style>
    
    
  • 孙子组件(GrandChild.vue),在孙子组件中一定要使用props接收从父组件传递过来的数据

    <template>
      <div class='grand-child-view'>
        <p>孙子组件</p>
        <p>传给孙子组件的数据:{{row.name}} {{row.name !== undefined? '学习' : ''}} {{row.study}}</p>
      </div>
    </template>
    
    <script>
    export default {
      // 不想继承所有父组件的内容,同时也不在组件根元素dom上显示属性
      inheritAttrs: false,
      // 在本组件中需要接收从父组件传递过来的数据,注意props里的参数名称不能改变,必须和父组件传递过来的是一样的
      props: {
        isShow: {
          type: Boolean,
          dedault: false
        },
        row: {
          type: Object,
          dedault: () => { }
        }
      }
    }
    </script>
    
    <style lang="stylus">
    .grand-child-view {
      border: 2px solid green
      padding: 20px
      margin: 20px
    }
    </style>
    
  • 结果:

    Vue3 补充:\$attrs和\$listeners属性

    在上面提过,如果给子组件传递的数据,子组件不使用props接收,那么这些数据将作为子组件的特性,这些特性绑定在组件的HTML根元素上,在vue2.40版本之后,可以通过inheritAttrs = false 来控制这些特性是否显示在dom元素上 如:案例中父组件给子组件传递的row和isShow,子组件没有使用props接收,这个2个数据直接作为HTML的特殊属性。子组件使用inheritAttrs = true,那么特性显示在dom上,如果设置为false,那么特性不显示在dom上

    Vue3 补充:\$attrs和\$listeners属性

5. 总结

$attrs

包含了父作用域中不被认为 (且不预期为) props 的特性绑定 (class 和 style 除外)。当一个组件没有声明任何 props 时,这里会包含所有父作用域的绑定 (class 和 style 除外),并且可以通过 v-bind=”$attrs” 传入内部组件——在创建更高层次的组件时非常有用。

$listeners

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

inheritAttrs

默认情况下父作用域的不被认作 props 的特性绑定 (attribute bindings) 将会“回退”且作为普通的 HTML 特性应用在子组件的根元素上。当撰写包裹一个目标元素或另一个组件的组件时,这可能不会总是符合预期行为。通过设置 inheritAttrs 到 false,这些默认行为将会被去掉。而通过 (同样是 2.4 新增的) 实例属性 $attrs 可以让这些特性生效,且可以通过 v-bind 显性的绑定到非根元素上。

上一篇:App 黑白化实现探索,有一行代码实现的方案吗,推荐学习


下一篇:vue中$attrs的用法