ElementUI 组件按需封装

前言

公司用了好几个年的核心业务系统今年升级重写,目前使用的版本是 V3 版本的xxx系统平台,简称 V3系统,升级大版本 V4, 前端技术架构也对应做了调整。

V3系统前端使用的是 Angular1.5 ,前后端不分离模式,后端是 .net。V4 要升级成前后端分离模式,前端使用 Vue2 结合 ElementUI 库,目前 Vue2 + ElementUI 技术栈相关的使用在公司内部项目里用的都是这个。

关于 ElementUI 组件按需封装, 由于业务需要,这次的升级前端架构设计需要后期支持前端库动态切换,例如动态切换成 Ant Design,代码开发实现使用 ElementUI, 这时前端架构层就需要对 ElementUI 库的所有组件进行封装,然后业务层调用封装好的对应的组件库,组件库里面封装的 ElementUI 组件,或者是 Ant Design 组件。

规范定义

由于需要把ElementUI所有的组件全部封装,而且时间有限,我们组三个前端都需要参与,在实际封装过程中,如果不预先定义对应的规范,不同人的组件命名,变量命名,封装规范等会出现不一样的情况,这时候需要前端小组内部及时统一相关规范,并输出对应的文档。

开始按需封装

我们用脚手架创建了一个 Vue2 的项目,定义好封装目录,把封装的UI组件全部放到 src/components 下面,然后在 App.vue 中引入,进行基本的功能测试。封装需要使用 $attrs $listeners <slot> 等 Vue.js API 的功能

$attrs

$attrs 用来绑定父组件传到子组件的属性,如 size value

包含了父作用域中不作为 prop 被识别 (且获取) 的 attribute 绑定 (classstyle 除外)。当一个组件没有声明任何 prop 时,这里会包含所有父作用域的绑定 (classstyle 除外),并且可以通过 v-bind="$attrs" 传入内部组件——在创建高级别的组件时非常有用。

https://cn.vuejs.org/v2/api/#vm-attrs

$listeners

$listeners 用来绑定父组件传到子组件的事件,如 click change

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

https://cn.vuejs.org/v2/api/#vm-listeners

slot

有些组件有自定义功能的实现,业务封装时需要用到,如 input 输入框 复合型输入框

Vue 实现了一套内容分发的 API,这套 API 的设计灵感源自 Web Components 规范草案,将 <slot> 元素作为承载分发内容的出口。

https://cn.vuejs.org/v2/guide/components.html#%E9%80%9A%E8%BF%87%E6%8F%92%E6%A7%BD%E5%88%86%E5%8F%91%E5%86%85%E5%AE%B9

https://cn.vuejs.org/v2/guide/components-slots.html

https://cn.vuejs.org/v2/api/#v-slot

Button 按钮 封装

方案一

封装的Button组件, 使用 $attrs 接收父组件(应用层)传递的属性参数,使用 $listeners 接收父组件(应用层)传递的事件,Button 按钮封装时实际用不上 $listeners

<template>

  <div>

    <el-button

      v-bind="$attrs"

      v-on="$listeners">

        {{ buttonContent }}

    </el-button>

  </div>

</template>



<script>

export default {

  name: 'Button',

  props: {

    buttonContent: {

      type: String,

      default: '按钮'

    }

  }

}

</script>

应用层调用


<template>

  <div id="app">

    <button

      type="success"

      size="mini"

      buttonContent="按钮2"

      @click="buttonClick">

    </button>

  </div>

</template>



<script>

import Button from './components/Button.vue';


export default {

  name: 'App',

  components: {

    Button

  },

  methods: {

    buttonClick() => {

      console.log('button click')

    }

  }

}

</script>

方案一优势

封装的组件代码更简洁,业务组件调用时按需传递对应的参数即可实现相应的功能

方案二

封装的Button组件, 使用 props 接收参数对象, <slot> 显示Button按钮文字

<template>

  <div>

    <el-button

      :size="buttonConfig.size"

      :type="buttonConfig.type"

      :plain="buttonConfig.plain"

      :round="buttonConfig.round"

      :circle="buttonConfig.circle"

      :loading="buttonConfig.loading"

      :disabled="buttonConfig.disabled"

      :icon="buttonConfig.icon"

      :autofocus="buttonConfig.autofocus"

      :native-type="buttonConfig.nativeType">

      <slot></slot>

    </el-button>

  </div>

</template>


<script>

export default {

  name: 'Button',

  props: {

    buttonConfig: {

      type: Object,

      default: () => {}

    }

  }

}

</script>

应用层调用

<template>

  <div id="app">

    <button

      :buttonConfig="button.buttonConfig">

      {{ button.buttonContent }}

    <button>

  </div>

</template>

<script>

import Button from './components/Button.vue';

export default {

  name: 'App',

  components: {

    Button,

  },

  data() {

    return {

      button: {

        buttonContent: '测试按钮1',

        buttonConfig: {

          size: 'small',

          type: 'success',

          icon: 'el-icon-search'

        }

      }

    }

  }

}

</script>
方案二优势

业务层的调用代码更简洁,直接传递一个对象即可,参数定义更灵活,这种方式还支持后期更换UI库,业务层代码不用动,直接更新组件封装层即可。

思考

Button 按钮这种组件封装相对简单一点,在实际业务中,有些组件会比较复杂,例如表格组件的封装使用,各种自定义能力需要支持,对于表格的自定义修改封装后期需要处理的内容会很多,可能也会面临一些取舍,目前小组内还没做到那里,后期会把表格的封装单独梳理出来。

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

推荐阅读更多精彩内容