耀极客论坛

 找回密码
 立即注册
查看: 356|回复: 0

使用 render 函数封装高扩展的组件

[复制链接]

336

主题

318

帖子

22万

积分

管理员

Rank: 9Rank: 9Rank: 9

积分
220555
发表于 2022-5-7 01:15:55 | 显示全部楼层 |阅读模式
  这篇文章主要介绍了使用 render 函数封装高扩展的组件,vue 官网给出的 render 函数的例子只能体现 render 函数的优雅的一方面,却不能看出其扩展性,今天就来封装一个体现其扩展性的组件,需要的朋友可以参考一下
  需求:
  后台管理中常常有如下布局的数据展示需求:

  像表格又不是表格,像表单又不是表单,实际上样子像表格,呈现的数据是一个对象,和 form 的绑定的值一样,我将其称为表单式表格。
  样式深的列是标题,浅的列是标题对应的取值,数据往往是服务器返回的,标题往往是定宽的,取值可能各种各样,比如显示一张图片,值为 01,需要显示是与否,有时候需要添加一个修改按钮,让用户能修改某些值,还需要设置某一列跨越几列。
  先来看看一个基于 element ui 的实现
  不好的实现:
  在接手的项目看到一个实现,先看使用方式
  1. ‹FormTable :data="lessonPackageArr" :fleldsInfo="lessonPackageInfo" :maxColumn="3" label-width="120px">
  2.   ‹template #presentedHours="{ data }">
  3.     ‹div class="flex-box between">
  4.       ‹span>
  5.         {{ data.presentedHours }}
  6.       ‹/span>
  7.       ‹span class="column-btn" @click="editPresentedHours(data)">修改‹/span>
  8.     ‹/div>
  9.   ‹/template>
  10.   ‹template #gifts="{ data }">
  11.     ‹div class="flex-box between">
  12.       ‹span>
  13.         {{ data.gifts }}
  14.       ‹/span>
  15.       ‹span class="column-btn" @click="editPresentedHours(data)">修改‹/span>
  16.     ‹/div>
  17.   ‹/template>
  18. ‹/FormTable>
复制代码
  lessonPackageInfo 对象如下结构:
  1. // 一个对象,用于配置标题列和标题列对应的字段
  2. // type 指定值的类型,现在组件内部设置可能显示哪些类型的值了
  3. // 对于服务其返回 1 0 需要显示 是否的数,提供一个 map_data 来映射
  4. // column 属性设置跨列
  5. // 需要自定义显示内容 提供 slot
  6. lessonPackageInfo: {
  7.     orderType: { type: 'option', desc: '课时包类别', map_data: { 1: '首单', 2: '续费', 5: '赠课' } },
  8.     combo: { type: 'text', desc: '套餐名称' },
  9.     presentedHours: { type: 'text', desc: '赠送课时', slot: true },
  10.     price: { type: 'text', desc: '标准价格' },
  11.     gifts: { type: 'text', desc: '赠送礼物', column: 3, slot: true },
  12.   }
复制代码

  • props 不够直观,配置项多
  • 不是完全数据驱动
  为何组件的配置项多不好?
  对于这种需求很固定,组件的输入即 props 应该要最小化,组件功能要最大化,尽量给 props 提供默认值,这样才能提高团队的开发效率。
  为何不是完全的数据驱动不好?
  这个组件不是完全数据驱动的,需要自定义显示列是,需要编写模板。
  如果需要自定义的列很多,就要写很多模板代码,想要再提取,只能再次封装组件,不提取,模板代码可能会膨胀,你可能经常看到动辄 500 行一行的 template ?而膨胀的模板代码,让组件维护变得困难,需要 template 和 js 代码之间来回切换。再者,增加一列自定义的数据,起码要修改两个地方。
  为何需要完全的数据驱动?
  虽然有 slot 来扩展组件,但是我们在写业务组件时候应该少用,而是尽量使用数据驱动模板。因为数据是 js 代码,当组件代码膨胀时,很容易把 js 代码提取成单独的文件, 而想要提取 slot 的代码,只能再封装组件。
  1. 三大前端框架的设计理念都是数据驱动模板,这是它们区别于 jQuery 的重要特征,也是我们封装业务组件时优先遵循的原则。
复制代码
  看了组件使用的问题,再看组件的代码:
  1. ‹template>
  2.   ‹div v-if="tableData.length" class="form-table">
  3.     ‹div v-for="(data, _) in tableData" :key="_" class="table-border">
  4.       ‹el-row v-for="(row, index) in rows" :key="index">
  5.         ‹el-col v-for="(field, key) in row" :key="key" :span="getSpan(field.column)">
  6.           ‹div v-if="(field.disabled && data[key]) || !field.disabled" class="column-content flex-box between">
  7.             ‹div class="label" :style="'width:' + labelWidth">
  8.               ‹span v-if="field.required" class="required">*‹/span>
  9.               {{ field.desc }}
  10.             ‹/div>
  11.             ‹div class="text flex-item" :title="data[key]">
  12.               ‹template v-if="key === 'minAge'">
  13.                 ‹span>{{ data[key] }}‹/span>
  14.                 -
  15.                 ‹span>{{ data['maxAge'] }}‹/span>
  16.               ‹/template>
  17.               ‹template v-else-if="key === 'status'">
  18.                 ‹template v-if="field.statusList">
  19.                   ‹span v-if="data[key] == 0" :class="field.statusList[2]">{{ field.map_data[data[key]] }}‹/span>
  20.                   ‹span v-else-if="data[key] == 10 || data[key] == 34" :class="field.statusList[1]">
  21.                     {{ field.map_data[data[key]] }}
  22.                   ‹/span>
  23.                   ‹span v-else :class="field.statusList[0]">{{ field.map_data[data[key]] }}‹/span>
  24.                 ‹/template>
  25.                 ‹span v-else>{{ field.map_data[data[key]] }}‹/span>
  26.               ‹/template>
  27.               ‹slot v-else :name="key" v-bind:data="data">
  28.                 ‹TableColContent
  29.                   :dataType="field.type"
  30.                   :metaData="data[key]"
  31.                   :mapData="field.map_data"
  32.                   :text="field.text"
  33.                 />
  34.               ‹/slot>
  35.             ‹/div>
  36.           ‹/div>
  37.         ‹/el-col>
  38.       ‹/el-row>
  39.     ‹/div>
  40.   ‹/div>
  41.   ‹div v-else class="form-table empty">暂无数据‹/div>
  42. ‹/template>
  43. ‹script>
  44.   import TableColContent from '@/components/TableColContent'
  45.   export default {
  46.     name: 'FormTable',
  47.     components: {
  48.       TableColContent,
  49.     },
  50.     props: {
  51.       // 数据
  52.       data: {
  53.         required: true,
  54.         type: [Object, Array, null],
  55.       },
  56.       // 字段信息
  57.       fleldsInfo: {
  58.         required: true,
  59.         type: Object,
  60.         // className: { type: "text", desc: "班级名称", column: 3 },
  61.       },
  62.       // 最多显示列数
  63.       maxColumn: {
  64.         required: false,
  65.         type: Number,
  66.         default: 2,
  67.       },
  68.       labelWidth: {
  69.         required: false,
  70.         type: String,
  71.         default: '90px',
  72.       },
  73.     },
  74.     data() {
  75.       return {}
  76.     },
  77.     computed: {
  78.       tableData() {
  79.         if (!this.data) {
  80.           return []
  81.         }
  82.         if (this.data instanceof Array) {
  83.           return this.data
  84.         } else {
  85.           return [this.data]
  86.         }
  87.       },
  88.       rows() {
  89.         const returnArray = []
  90.         let total = 0
  91.         let item = {}
  92.         for (const key in this.fleldsInfo) {
  93.           const nextTotal = total + this.fleldsInfo[key].column || 1
  94.           if (nextTotal > this.maxColumn) {
  95.             returnArray.push(item)
  96.             item = {}
  97.             total = 0
  98.           }
  99.           total += this.fleldsInfo[key].column || 1
  100.           item[key] = this.fleldsInfo[key]
  101.           if (total === this.maxColumn) {
  102.             returnArray.push(item)
  103.             item = {}
  104.             total = 0
  105.           }
  106.         }
  107.         if (total) {
  108.           returnArray.push(item)
  109.         }
  110.         return returnArray
  111.       },
  112.     },
  113.     methods: {
  114.       getSpan(column) {
  115.         if (!column) {
  116.           column = 1
  117.         }
  118.         return column * (24 / this.maxColumn)
  119.       },
  120.     },
  121.   }
  122. ‹/script>
复制代码
  有哪些问题?

  • 模板有太多的条件判断,不优雅
  • 自定义显示列,还需要在引入 TableColContent,增加了组件复杂性
  TableColContent 内部还是对配置项的 type 进行条件判断
  部分代码:
  1. ‹span v-else-if="dataType === 'image' || dataType === 'cropper'" :class="className">
  2.   ‹el-popover placement="right" title="" trigger="hover">
  3.     ‹img :src="metaData" />
  4.     ‹img slot="reference" :src="metaData" :alt="metaData" width="44" class="column-pic" />
  5.   ‹/el-popover>
  6. ‹/span>
复制代码
  分析完以上实现的问题,看看好的实现:
  好的实现:
  先看使用方式:
  1. ‹template>
  2.   ‹ZmFormTable :titleList="titleList" :data="data" />
  3. ‹/template>
  4. ‹script>
  5.   export default {
  6.     name: 'Test',
  7.     data() {
  8.       return {
  9.         data: {}, // 从服务器获取
  10.         titleList: [
  11.           { title: '姓名', prop: 'name', span: 3 },
  12.           {
  13.             title: '课堂作品',
  14.             prop: (h, data) => {
  15.               const img =
  16.                 (data.workPic && (
  17.                   ‹ElImage
  18.                     style='width: 100px; height: 100px;'
  19.                     src={data.workPic}
  20.                     preview-src-list={[data.workPic]}
  21.                   >‹/ElImage>
  22.                 )) ||
  23.                 ''
  24.               return img
  25.             },
  26.             span: 3,
  27.           },
  28.           { title: '作品点评', prop: 'workComment', span: 3 },
  29.         ],
  30.       }
  31.     },
  32.   }
  33. ‹/script>
复制代码
  组件说明: titleList是组件的列配置,一个数组,元素 title 属性是标题,prop 指定从 data 里取值的字段,span 指定这列值跨越的行数。
  prop 支持 string ,还支持函数,这是实现自定义显示的方式,当这个函数很大时,可提取到独立的 js 文件中,也可以把整个 titleList 提取单独的 js 文件中。
  参数 h 和 data 是如何传递进来的?或者 这函数在哪调用呢?
  h 是 createElement 函数,data 是从组件内部的 data,和父组件传入的 data 是同一个值。
  当普通函数的第一个参数是 h 是,它就是一个 render 函数。
  这种方式使用起来简单多了。
  看看内部实现:
  1. ‹template>
  2.   ‹div class="form-table">
  3.     ‹ul v-if="titleList.length">
  4.       ‹!-- titleInfo 是经过转化的titleList-->
  5.       ‹li
  6.         v-for="(item, index) in titleInfo"
  7.         :key="index"
  8.         :style="{ width: ((item.span || 1) / titleNumPreRow) * 100 + '%' }"
  9.       >
  10.         ‹div class="form-table-title" :style="`width: ${titleWidth}px;`">
  11.           ‹Container v-if="typeof item.title === 'function'" :renderContainer="item.title" :data="data" />
  12.           ‹span v-else>
  13.             {{ item.title }}
  14.           ‹/span>
  15.         ‹/div>
  16.         ‹div class="form-table-key" :style="`width:calc(100% - ${titleWidth}px);`">
  17.           ‹Container v-if="typeof item.prop === 'function'" :renderContainer="item.prop" :data="data" />
  18.           ‹span v-else>
  19.             {{ ![null, void 0].includes(data[item.prop] && data[item.prop]) || '' }}
  20.           ‹/span>
  21.         ‹/div>
  22.       ‹/li>
  23.     ‹/ul>
  24.     ‹div v-else class="form-table-no-data">暂无数据‹/div>
  25.   ‹/div>
  26. ‹/template>
  27. ‹script>
  28.   import Container from './container.js'
  29.   export default {
  30.     name: 'FormTable',
  31.     components: {
  32.       Container,
  33.     },
  34.     props: {
  35.       titleWidth: {
  36.         type: Number,
  37.         default: 120,
  38.       },
  39.       titleNumPreRow: {
  40.         type: Number,
  41.         default: 3,
  42.         validator: value => {
  43.           const validate = [1, 2, 3, 4, 5, 6].includes(value)
  44.           if (!validate) {
  45.             console.error('titleNumPreRow 表示一行有标题字段对,只能时 1 -- 6 的偶数,默认 3')
  46.           }
  47.           return validate
  48.         },
  49.       },
  50.       titleList: {
  51.         type: Array,
  52.         default: () => {
  53.           return []
  54.         },
  55.         validator: value => {
  56.           const validate = value.every(item => {
  57.             const { title, prop } = item
  58.             return title && prop
  59.           })
  60.           if (!validate) {
  61.             console.log('传入的 titleList 属性的元素必须包含 title  和 prop 属性')
  62.           }
  63.           return validate
  64.         },
  65.       },
  66.       data: {
  67.         type: Object,
  68.         default: () => {
  69.           return {}
  70.         },
  71.       },
  72.     },
  73.   }
  74. ‹/script>
  75. ‹!-- 样式不是关键,省略 -->
复制代码
  实现自定义显示的方式,没有使用动态插槽,而是用一个函数组件Container,该组件接收一个 render 函数作为 prop。
  1. export default {
  2.   name: 'Container',
  3.   functional: true,
  4.   render(h, { props }) {
  5.     return props.renderContainer(h, props.data)
  6.   },
  7. }
复制代码
  在 Container 内部调用 titleList 传入的函数。
  总结:

  • 封装组件时优先考虑数据驱动
  • 普通函数的第一个参数是 h,就是渲染函数
  • 可能有一些人不习惯写 JSX, 可兼容两种写法
  到此这篇关于使用 render 函数封装高扩展的组件的文章就介绍到这了,更多相关 render 函数封装高扩展组件内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!


回复

使用道具 举报

您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

Archiver|手机版|小黑屋|耀极客论坛 ( 粤ICP备2022052845号-2 )|网站地图

GMT+8, 2022-12-10 04:36 , Processed in 0.068075 second(s), 20 queries .

Powered by Discuz! X3.4

Copyright © 2001-2020, Tencent Cloud.

快速回复 返回顶部 返回列表