vue封裝form表單元件拒絕重複寫form表單

2022-07-29 18:00:15

前言

在日常工作中，當需要處理的form表單很多時,我們沒有必要一遍又一遍地重複寫form表單，直接封裝一個元件去處理就好。其實很早之前就有涉獵通過使用類似設定json方法寫form表單的文章，雖然當時也沒怎麼認真看...我們前端組也是使用這種思想設定的。

然而，這個思想和方法很早就有出現過，並不怎麼新穎，還望不喜勿噴...在此我封裝了一個最最最基礎的form表單，離我們前端組封裝的元件差距還很大，有興趣朋友們的可以繼續往下完善。

核心思想：

通過設定js檔案的變數，使用vue的is屬性動態切換元件，預設顯示的元件為el-input
通過element的分欄和柵格屬性，對form表單進行響應式佈局
baseForm在元件初始化時，需要動態新增校驗規則、請求介面以及初始化form的部分值
正統思想是對element元件的各個元件進行二次封裝，然後通過is屬性切換二次封裝後的元件，在此不做過多描述，有興趣的朋友可以自行研究
更好的思想是將頁面請求、搜尋項、表格、分頁封裝到一起，形成一個整體，這也是我們前端小組目前的處理思路

實現重點：

任何標籤或者元件都可以通過vue的is屬性來動態切換元件。本元件中使用div，將它的寬度設定為100%，使得element元件能夠完全撐開。(使用vue內建元件component會與el-radio-group相沖突，因為它底層就是用component實現的)
表單上新增validate-on-rule-change="false"屬性，防止在表單初始化時就校驗表單
當為物件新增不存在的欄位屬性時，需要使用$set實現資料的響應式
如果form表單中只有一個輸入框，在輸入框中按下回車會提交表單，重新整理頁面。為了阻止這一預設行為，需要在el-form標籤上新增@submit.native.prevent
使用lodash中的get方法獲取物件的屬性值，如果屬性值不存在，可以給一個預設值
baseForm子元件中可以傳一個form物件給父元件，那麼新增或者編輯form物件，就都可以在父元件中進行。

表單雙向繫結的方式有兩種:

1.使用v-model進行雙向繫結

<div
  v-else
  clearable
  style="width: 100%"
  type="daterange"
  range-separator="至"
  start-placeholder="開始日期"
  end-placeholder="結束日期"
  v-model="form[column.prop]"
  :label-width="get(column, 'size', column || defaultFormSize)"
  :disabled="get(column, 'disabled', false)"
  :is="get(column, 'type', 'el-input')"
>

2.使用v-model的語法糖

(`:value以及@input`)進行雙向繫結

<div
  v-else
  clearable
  style="width: 100%"
  type="daterange"
  range-separator="至"
  start-placeholder="開始日期"
  end-placeholder="結束日期"
  :value="form[column.prop]"
  :label-width="get(column, 'size', column || defaultFormSize)"
  :disabled="get(column, 'disabled', false)"
  :is="get(column, 'type', 'el-input')"
  @input="input($event,column.prop)"
>
methods: {
    input(e,prop) {
      this.$set(this.form, prop, e)
    }
}

設定項

(本元件寫得比較基礎，目前僅支援element的五個常用元件)：

整體欄位：

formSize (表單中各element元件的整體大小)

column陣列中每一個物件對應的欄位(非請求介面)：

label (表單label的名稱)
span (這個表單項佔據的份數，一行為24，預設為12)
labelWidth (這個表單項的label寬度，預設為90px)
labelHeight (這個表單項佔據的高度，預設為50px)
slotName (插槽名)
prop (這個表單項繫結的屬性名稱)
size (這個表單項元件的大小，預設為small)
disabled (是否禁用這個表單項)
type (使用的element元件，預設為el-input)
dic (非介面請求的靜態表單資料,使用{label以及value欄位}表示的陣列形式)

column陣列中每一個物件對應的欄位(請求介面)：

url (介面的api地址)
requestParams (非必填項，需要額外傳入的傳參)
requestLabel (介面返回對應的id)
requestValue (介面返回對應的value)

效果瀏覽

原始碼放送

1. baseForm元件

<template>
  <el-form
    ref="form"
    :model="form"
    :rules="formRules"
    :size="get(option, 'formSize', defaultFormSize)"
    :validate-on-rule-change="false"
    @submit.native.prevent
  >
    <el-row :gutter="20" :span="24">
      <el-col 
        v-for="column in formColumn" 
        :key="column.label" 
        :md="column.span || 12" 
        :sm="12" 
        :xs="24"
      >
        <el-form-item
          :label="`${column.label}:`"
          :prop="column.prop"
          :label-width="get(column, 'labelWidth', column.labelWidth || defaultLabelWidth)"
          :style="{
            height: get(column, 'labelHeight', column.labelHeight || defaultLabelHeight)
          }"
        >
          <slot
            v-if="column.slotName"
            :name="column.slotName"
            :form="form"
            :prop="column.prop"
            :value="form[column.prop]"
          ></slot>
          <div
            v-else
            clearable
            style="width: 100%"
            type="daterange"
            range-separator="-"
            start-placeholder="開始日期"
            end-placeholder="結束日期"
            v-model="form[column.prop]"
            :placeholder="getPlaceholder(column.type, column.label)"
            :label-width="get(column, 'size', column || defaultFormSize)"
            :disabled="get(column, 'disabled', false)"
            :is="get(column, 'type', 'el-input')"
          >
            <template v-if="column.type == 'el-select'">
              <el-option 
                v-for="item in column.dic" 
                :key="item.value" 
                :label="item.label" 
                :value="item.value"
              >
              </el-option>
            </template>
            <template v-if="column.type == 'el-radio-group'">
              <el-radio 
                v-for="item in column.dic" 
                :key="item.value" 
                :label="item.label"
              >
                {{ item.value }}
              </el-radio>
            </template>
            <template v-if="column.type == 'el-checkbox-group'">
              <el-checkbox 
                v-for="item in column.dic" 
                :key="item.label" 
                :label="item.value"
              >
                {{ item.label }}
              </el-checkbox>
            </template>
          </div>
        </el-form-item>
      </el-col>
    </el-row>
  </el-form>
</template>
<script>
import get from 'lodash/get'
import request from '@/service/request'
export default {
  props: {
    option: {
      type: Object,
      default: () => {}
    },
    form: {
      type: Object,
      default: () => {}
    }
  },
  data() {
    return {
      formRules: {},
      defaultFormSize: 'small',
      defaultLabelWidth: '90px',
      defaultLabelHeight: '50px'
    }
  },
  computed: {
    formColumn() {
      return this.option.column
    }
  },
  created() {
    this.initRules()
    this.initRequest()
    this.initValue()
  },
  methods: {
    get,
    getPlaceholder(type, label) {
      return type == 'el-select' ? `請選擇${label}` : `請輸入${label}`
    },
    initRequest() {
      if (!Array.isArray(this.formColumn)) return
      // 根據實際請求介面地址的字首來判斷
      const urls = this.formColumn?.filter((item) => item.url && item.url.indexOf('/emes') == 0) || []
      urls.forEach(async (item) => {
        const data = { page: { pageIndex: 1, pageSize: 0 }, ...item.requestParams }
        const { detail } = await request({
          url: item.url,
          method: 'post',
          data
        }) || []
        const finalResult = detail.map((result) => ({
          label: result[item.requestLabel],
          value: result[item.requestValue]
        }))
        this.$set(item, 'dic', finalResult)
      })
    },
    initRules() {
      if (!Array.isArray(this.formColumn)) return
      this.formColumn?.forEach((item) => {
        if (item.rules) {
          item.rules.map((rule, index) => {
            if (rule.required) {
              item.rules.splice(index, 1, {
                message: ['el-radio-group', 'el-checkbox-group'].includes(item.type) ? `${item.label}必選` : `${item.label}必填`,
                ...rule
              })
            }
          })
          this.$set(this.formRules, item.prop, item.rules)
        }
      })
    },
    initValue() {
      const selectList = this.formColumn.filter((item) => ['el-radio-group', 'el-checkbox-group'].includes(item.type))
      selectList.forEach((item) => {
        this.$set(this.form, item.prop, item.type == 'el-radio-group' ? item.dic[0].label : [item.dic[0].value])
      })
    }
  }
}
</script>

2. 父元件

<template>
  <div class="app-container">
    <myForm :option="option" :form="form">
      <template #usageSlot="{form, prop}">
        <el-input 
          size="small" 
          placeholder="請輸入插槽使用" 
          v-model="form[prop]" 
          clearable
        >
        </el-input>
      </template>
    </myForm>
  </div>
</template>
<script>
import { option } from './const.js'
export default {
  data() {
    return {
      option,
      form: {}
    }
  }
}
</script>

3. 設定項

export const option = {
  column: [
    {
      label: '姓名',
      prop: 'name',
      span: 8,
      rules: [
        {
          required: true
        }
      ]
    },
    {
      label: '職業',
      prop: 'job',
      type: 'el-select',
      span: 8,
      dic: [
        {
          label: '教師',
          value: 0
        },
        {
          label: '程式猿',
          value: 1
        },
        {
          label: '作家',
          value: 2
        }
      ],
      rules: [
        {
          required: true
        }
      ]
    },
    {
      label: '性別',
      prop: 'sex',
      span: 8,
      type: 'el-radio-group',
      dic: [
        {
          label: 0,
          value: '男'
        },
        {
          label: 1,
          value: '女'
        }
      ],
      rules: [
        {
          required: true
        }
      ]
    },
    {
      label: '城市',
      prop: 'city',
      type: 'el-checkbox-group',
      span: 8,
      dic: [
        {
          label: '仙桃',
          value: 0
        },
        {
          label: '泉州',
          value: 1
        },
        {
          label: '武漢',
          value: 2
        }
      ],
      rules: [
        {
          required: true
        }
      ]
    },
    {
      label: '出生日期',
      prop: 'data',
      type: 'el-date-picker',
      span: 8,
      rules: [
        {
          required: true
        }
      ]
    },
    {
      label: '測試',
      prop: 'test',
      type: 'el-select',
      span: 8,
      url:'/emes/factoryOrderService/warehouse/list',
      requestLabel: 'warehouseName',
      requestValue: 'id',
      rules: [
        {
          required: true
        }
      ]
    },
    {
      label: '插槽使用',
      prop: 'usage',
      slotName: 'usageSlot',
      span: 8,
      rules: [
        {
          required: true
        }
      ]
    }
  ]
}