需求背景
開(kāi)需求會(huì)了溃斋,產(chǎn)品說(shuō)這次需求的表單比較多,目前有19個(gè)吸申,后期的表單可能會(huì)有增加梗劫、修改。我作為這次的前端開(kāi)發(fā)呛谜,看到這樣的需求,心里知道要這樣搞不得把自己累死枪萄,首先表單居多隐岛,還會(huì)有變更,以后維護(hù)起來(lái)也讓人心力憔悴瓷翻。
于是我提議做動(dòng)態(tài)表單聚凹,做一個(gè)表單的配置系統(tǒng),在系統(tǒng)里配置表單類型齐帚、表單得字段妒牙、以及對(duì)表單得管理。后來(lái)重新評(píng)審了需求对妄,系統(tǒng)部分由后端自行開(kāi)發(fā)湘今,我要處理的部分是動(dòng)態(tài)生成表單,展現(xiàn)提交的表單剪菱,以及對(duì)表單的處理情況摩瞎。
數(shù)據(jù)接口設(shè)計(jì)
表單類型的接口就不用說(shuō)了,這個(gè)比較簡(jiǎn)單孝常。我跟后端約定了一個(gè)預(yù)備創(chuàng)建工單接口旗们,這個(gè)接口是后端告知前端,需要生成一個(gè)什么樣的表單构灸。
預(yù)備創(chuàng)建表單接口(其中字段解釋說(shuō)明):
-
id
表單字段的id -
name
表單字段的名稱(存數(shù)據(jù)庫(kù)的字段名) -
type
表單字段的類型(select_item下拉列表上渴、string單行文本、multiple多行文本喜颁、integer單行數(shù)字稠氮、images上傳圖片) -
title
表單字段的中文名(動(dòng)態(tài)表單的字段名稱) -
prompt_msg
表單字段的placeholder文案 -
selectObj
type類型為select_item的時(shí)候,selectObj有值半开,默認(rèn)為null
{
"code": 0,
"msg": "success",
"data": {
"list": [{
"id": 10,
"name": "check_type",
"type": "select_item",
"title": "審核類型",
"prompt_msg": "請(qǐng)?zhí)顚憣徍祟愋?,
"selectObj": [{
"id": 1,
"item": "預(yù)審核"
}, {
"id": 2,
"item": "患者審核"
}],
"val": null,
"rank": 0
}, {
"id": 16,
"name": "bank_branch_info",
"type": "string",
"title": "支行信息",
"prompt_msg": "請(qǐng)?zhí)顚懼行畔?,
"selectObj": null,
"val": null,
"rank": 0
}, {
"id": 19,
"name": "project_content",
"type": "multiple",
"title": "項(xiàng)目?jī)?nèi)容",
"prompt_msg": "請(qǐng)?zhí)顚戫?xiàng)目?jī)?nèi)容",
"selectObj": null,
"val": null,
"rank": 0
}, {
"id": 22,
"name": "project_extension_time",
"type": "integer",
"title": "項(xiàng)目延長(zhǎng)時(shí)間",
"prompt_msg": "請(qǐng)?zhí)顚戫?xiàng)目延長(zhǎng)時(shí)間",
"selectObj": null,
"val": null,
"rank": 0
}, {
"id": 24,
"name": "images",
"type": "images",
"title": "圖片",
"prompt_msg": "請(qǐng)上傳圖片",
"selectObj": null,
"val": null,
"rank": 0
}]
}
}
通過(guò)Vue動(dòng)態(tài)組件渲染表單
現(xiàn)在預(yù)備創(chuàng)建表單接口文檔都了括袒,該怎么渲染動(dòng)態(tài)表單呢?動(dòng)態(tài)表單的元素類型有5類稿茉,按照這個(gè)類別創(chuàng)建五個(gè)元素組件锹锰。
1. 上傳圖片組件
上傳圖片組件這里使用了 Uploader
組件芥炭。
<template>
<div class="default images">
<div class="lable">{{ item.title }}</div>
<div v-if="item.val === null" class="content">
<Uploader
:max-num="8"
:user-imgs="project_image"
@change="onUploadProject"
/>
</div>
<div v-else class="img-wrap">
<img v-for="(it, idx) in item.val" :src="it" :key="idx" @click="preview(idx, item.val)">
</div>
</div>
</template>
2. 多行輸入框組件
默認(rèn)多行輸入框?yàn)?行
<template>
<div v-if="item" class="default multiple">
<div class="lable">{{ item.title }}</div>
<template>
<textarea
rows="3"
:placeholder="item.prompt_msg"
v-model="value"
:value="it.item">
</template>
</div>
</template>
3. 下拉選擇框組件
使用了element-ui的 el-select
<template>
<div v-if="item" class="default select_item">
<div class="lable select-lable">{{ item.title }}</div>
<div class="content">
<el-select
v-model="value"
placeholder="請(qǐng)選擇類型"
class="el-select-wrap"
size="mini"
@change="onChangeFirstValue"
>
<el-option
v-for="it in item.selectObj"
:key="it.id"
:label="it.item"
:value="it.item">
</el-option>
</el-select>
</div>
</div>
</template>
其它兩個(gè)數(shù)字單行輸入框組件、文本單輸入框組件跟多行輸入框組件類似恃慧。
組件都創(chuàng)建好了园蝠,為了方便統(tǒng)一管理這些自定義組件。將組件們引入再導(dǎo)出痢士,通過(guò)export default復(fù)合的形式彪薛。
// 單行文本輸入框組件
export { default as String } from './string.vue'
// 單行數(shù)字輸入框組件
export { default as Integer } from './integer.vue'
// 多行文本輸入框組件
export { default as Multiple } from './multiple.vue'
// 下拉列表選擇器組件
export { default as Select_item } from './select_item.vue'
// 上傳圖片組件
export { default as Images } from './images.vue'
再動(dòng)態(tài)表單頁(yè)面統(tǒng)一引入,以Vue動(dòng)態(tài)組件的形式進(jìn)行渲染怠蹂,is
屬性為動(dòng)態(tài)組件名善延。
<template>
<div class="g-container">
<component
v-for="(item, number) in freedomConfig"
:key="item.name"
:is="item.type"
:item="item"
:number="number"
@changeComponent="changeComponentHandle"
></component>
</div>
</template>
<script>
import * as itemElements from '../../components/itemElement'
export default {
components: itemElements,
}
</script>
上面完成后,動(dòng)態(tài)表單展現(xiàn)出來(lái)了城侧。表單是動(dòng)態(tài)生成的易遣,如何進(jìn)行表單驗(yàn)證,和表單數(shù)據(jù)的匯總呢嫌佑?
表單數(shù)據(jù)匯總
再動(dòng)態(tài)渲染組件的豆茫,傳入了 number
參數(shù),這個(gè)參數(shù)用來(lái)標(biāo)識(shí)當(dāng)前組件位于動(dòng)態(tài)表單的第幾個(gè)屋摇,方便后期填入數(shù)據(jù)后揩魂,進(jìn)行數(shù)據(jù)保存。
默認(rèn)value屬性值為空炮温,對(duì)value進(jìn)行監(jiān)聽(tīng)火脉,當(dāng)value變動(dòng)的時(shí)
候進(jìn)行emit,告訴父組件數(shù)據(jù)變更了柒啤,請(qǐng)保存忘分。
data() {
return {
value: ''
}
},
watch: {
value(v, o) {
this.throttleHandle(() => {
this.$emit('changeComponent', {
number: this.number,
value: this.$data.value
})
})
}
},
但是數(shù)據(jù)保存到哪里?怎么保存呢白修?
讓后端給一個(gè)表單全部字段的接口妒峦,取到數(shù)據(jù)存到data中,每次數(shù)據(jù)更新就去查找是否存在這個(gè)字段兵睛,有的話就賦值保存起來(lái)肯骇。后面提交的時(shí)候,就提交這個(gè)對(duì)象祖很。
表單校驗(yàn)
提交的時(shí)候笛丙,希望用戶能夠把表單填完再調(diào)用提交接口,需要前端校驗(yàn)是否填完沒(méi)有的話假颇,就給響應(yīng)的toast請(qǐng)?zhí)崾九哐欤柚贡韱翁峤弧?/p>
this.checkFrom(freedomConfig, preWordorderData).then(canSubmit => {
canSubmit && postSubmitWorkorder(preWordorderData).then(res => {
if (res.code === 0) {
showLoading()
this.$router.push(`/detail/${res.data.id}`)
}
})
})
checkFrom
為我們的校驗(yàn)方法,循環(huán)遍歷預(yù)創(chuàng)建表單笨鸡,從data里查看該字段是否有值姜钳,沒(méi)有的話就給于toast提示坦冠。并返回一個(gè)promise,resolve(false)
哥桥。如果都校驗(yàn)通過(guò)返回 resolve(true)
辙浑。這樣就可以使checkFrom成為一個(gè)異步函數(shù)。
其中需要注意的是下拉框選擇后的值為大于0的數(shù)字拟糕、上傳圖片的屬性值是數(shù)組判呕。
一個(gè)動(dòng)態(tài)表單的創(chuàng)建、校驗(yàn)送滞、數(shù)據(jù)整合就完成了侠草。很多時(shí)候需要寫大量代碼的場(chǎng)景思路上很簡(jiǎn)單,反倒是抽象一個(gè)組件需要考慮的更多犁嗅。