Vue2+ElementUI表单、Form组件的封装

Vue2+ElementUI表单、Form组件的封装 ：引言

在 Vue2 项目中，ElementUI 的 el-form 组件是常用的表单组件。它提供了丰富的功能和样式，可以满足各种需求。但是，在实际开发中，我们经常会遇到一些重复性的需求，比如：

• 需要对表单进行校验
• 需要对表单数据进行重置
• 需要在表单中添加额外的功能，比如动态添加表单项等

为了提高开发效率，我们可以对 el-form 组件进行封装，将这些重复性的需求抽象成通用的功能。这样，在后续的项目中，我们就可以直接使用封装好的组件，而无需重复开发。

预期效果

预期效果如下。

创建表单组件

先把架子搭起来,组件名为H3yunFormCompV1,这个是随便取的哈。然后随便在哪个地方用上，方便测试。

<template>
  <div>
    <el-form>
      
    el-form>
  div>
template>

<script>
export default {
  name: "H3yunFormCompV1",
  data() {
    return {}
  },
  props: {},
  mounted() {
  },
  methods: {}
}
script>

<style scoped>

style>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

父组件传递表单数据，子组件遍历数据

把formData数据传递过去。formData是一个列表，每个对象的结果如下{label: null, value: null}非常的简单。

 <H3yunFormCompV1 :formData="formData">H3yunFormCompV1>

data() {
    return {
formData: []
}
}
1
2
3
4
5
6
7

子组件如下：使用v-for遍历formData，并把label和value取出来。

<template>
  <div>
    <el-form ref="form" :model="form" :inline="true">
      <el-form-item v-for="(item,key) in formData" :key="key" :label="item.label">
        <el-input v-model="item.value">el-input>
      el-form-item>
    el-form>
  div>
template>

<script>
export default {
  name: "H3yunFormCompV1",
  data() {
    return {
      form: {
        name: '',
        region: '',
        date1: '',
        date2: '',
        delivery: false,
        type: [],
        resource: '',
        desc: ''
      }
    }
  },
  props: {
    formData: Array
  },
  mounted() {
  },
  methods: {}
}
script>

<style scoped>

style>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

添加disabled属性

子组件的完整代码

<template>
  <div>
    <el-row>
      <el-form
          ref="form"
          :model="form"
          label-position="top"
          size="small"
      >
        <el-col :span="6" v-for="(item,key) in formData" :key="key">
          <div class="box">
            <el-form-item :label="item.label">
              <el-input v-model="item.value" :disabled="item.disabled">el-input>
            el-form-item>
          div>
        el-col>
      el-form>
    el-row>
  div>
template>

<script>
export default {
  name: "H3yunFormCompV1",
  data() {
    return {
      form: {
        name: '',
        region: '',
        date1: '',
        date2: '',
        delivery: false,
        type: [],
        resource: '',
        desc: ''
      }
    }
  },
  props: {
    formData: Array
  },
  mounted() {
  },
  methods: {}
}
script>

<style>
.box {
  font-size: 14px;
  padding: 6px 12px;
  color: #304265;
  background: #f8fafc;
  border-radius: 4px;
  min-height: 22px;
  box-sizing: content-box;
  font-family: PingFangSC-Regular, PingFang SC;
  font-weight: 400;
}

.box .el-form-item__label {
  position: relative;
  font-size: 14px;
  font-family: PingFangSC-Regular, PingFang SC;
  font-weight: 400;
  color: #304265;
  font-weight: 400 !important;
}
style>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

效果如下：

适配JSON数据

先看效果，下面是销量预测的json数据。

代码如下：主要是把json数据解析为了一个个表单项。

<template>
  <div>
    <el-row>
      <el-form
          ref="form"
          :model="form"
          label-position="top"
          size="small"
      >
        <el-col :span="6" v-for="(item,key) in formStructure" :key="key">
          <div class="box">
            <el-form-item :label="item.label">
              <el-input v-model="item.value" :disabled="item.disabled">el-input>
            el-form-item>
          div>
        el-col>
      el-form>
    el-row>
  div>
template>

<script>
export default {
  name: "H3yunFormCompV1",
  data() {
    return {
      form: {},
      formStructure: []
    }
  },
  props: {
    formData: Array
  },
  watch: {
    // 监控父组件的表单数据
    formData: {
      handler(newFormData) {
        // 当 formData 变化时执行的操作
        // 解析新表单结构
        this.parseFormStructure(newFormData);
      },
      deep: true, // 深度监听，用于监听数组或对象内部的变化
    },
  },
  mounted() {
    // 解析新表单结构 - 第一次点击时执行
    this.parseFormStructure()
  },
  methods: {
    // 解析表单结构
    parseFormStructure() {
      // 清除表单结构和表单数据
      this.formStructure = []
      this.form = {}
      const formStructure = []
      // column的数据类型：{ label: null, value: null, prop: null, disabled: null, dataType: null}
      this.formData.forEach(column => {
        if (column.dataType == undefined) {
          column.dataType = 'text'
        }
        // 如果数据是json,需要把JSON数据装为column的结构
        if (column.dataType == 'json') {
          const label = column.label
          const prop = column.prop
          const jsonValue = column.value
          const disabled = column.disabled
          const jsonObj = JSON.parse(jsonValue)
          // 构建column对象
          Object.keys(jsonObj).forEach(key => {
            const childLabel = `${label}.${key}`
            const childProp = `${prop}.${key}`
            const childValue = jsonObj[key]
            const childDisabled = disabled
            const childColumn = {
              label: childLabel,
              value: childValue,
              prop: childProp,
              disabled: childDisabled,
              dataType: 'text'
            }
            formStructure.push(childColumn)
          })
        } else {
          formStructure.push(column)
        }
      })
      this.formStructure = formStructure
    }
  }
}
script>

<style>
.box {
  font-size: 14px;
  padding: 6px 12px;
  color: #304265;
  background: #f8fafc;
  border-radius: 4px;
  min-height: 22px;
  box-sizing: content-box;
  font-family: PingFangSC-Regular, PingFang SC;
  font-weight: 400;
}

.box .el-form-item__label {
  position: relative;
  font-size: 14px;
  font-family: PingFangSC-Regular, PingFang SC;
  font-weight: 400;
  color: #304265;
  font-weight: 400 !important;
}
style>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

表单提交

首先写个提交按钮，并添加个change表单提交事件。

 <el-button type="primary" size="small" @change="submitForm">提交el-button>
1

提交逻辑如下

// 提交的数据在this.form里面，表单验证通过后可以使用axios把表单数据提交到服务器。
submitForm() {
      // 使用 this.$refs.form.validate() 进行表单验证
      this.$refs.form.validate((valid) => {
        if (valid) {
          // 表单验证通过，执行提交操作
          // 在这里你可以使用 Axios 或其他方式提交数据到后端
          // 示例：假设有一个名为 submitData 的方法用于提交数据
          this.submitData();
        } else {
          // 表单验证失败，可以做一些处理，如提示用户
          this.$message.error('表单验证失败，请检查输入信息。');
        }
      });
    },
    submitData() {
      // 在这里执行提交数据的操作
      // 可以使用 Axios 或其他方式发送数据到后端
      // 示例：假设有一个名为 postData 的方法用于发送数据
      // postData(this.form)
      this.$message.success('表单提交成功！');
    }
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22