Vue下使用低代码表单——VForm快速生成表单

9,511 阅读2分钟

在前端开发的工作当中,表单的开发占据了很大的一部分。表单页面和报表页面是中后台业务的主要展现形式,但随着业务越来越复杂,表单开发和维护成为了前端工程师一个无法逃避的痛点。 目前的表单开发主要存在的问题有以下几点:

  1. 表单状态管理随业务复杂度增加变得越来越难以维护,需要引入状态管理库。
  2. 传统表单开发的数据结构往往都是扁平结构,没法很好的处理嵌套复杂数据的情况, 如果要处理,工作量会非常大。
  3. 当业务有动态输出表单的需求的时候,不得不自己开发一个基于某种数据协议的动态输出表单的组件。
  4. 当业务需要在可视化界面配置产出表单时,需要自己开发一个基于json的动态输出表单组件。

VFrom是什么

VForm全称为Variant Form,是一款基于Vue 2/Vue 3的低代码表单, 支持Element UIiView两种UI库,提供了丰富的组件属性设置、表单交互事件和API方法,为前端开发人员提供快速搭建表单、实现表单交互和数据收集的功能。

VForm由表单设计器VFormDesigner和表单渲染器VFormRender两部分构成,VFormDesigner通过拖拽组件方式生成JSON格式的表单对象,VFormRender负责将表单JSON渲染为Vue组件。

废话不多说,让我们进入正题吧

一、安装VForm

npm i vform-builds

二、使用VFormDesigner组件

VFormDesigner为VForm的表单设计器组件,用于生成表单JSON对象。

1. 引入并全局注册VForm组件

修改vue项目的main.js,如下所示(包含注释的6行代码):

import Vue from 'vue'
import App from './App.vue'

import ElementUI from 'element-ui'  //引入element-ui库
import VForm from 'vform-builds'  //引入VForm库

import 'element-ui/lib/theme-chalk/index.css'  //引入element-ui样式
import 'vform-builds/dist/VFormDesigner.css'  //引入VForm样式

Vue.config.productionTip = false

Vue.use(ElementUI)  //全局注册element-ui
Vue.use(VForm)  //全局注册VForm(同时注册了v-form-designe、v-form-render等组件)

new Vue({
  render: h => h(App),
}).$mount('#app')

2. 在Vue模板中使用组件

<template>
  <v-form-designer></v-form-designer>
</template>

<script>
  export default {
    data() {
      return {
      }
    }
  }
</script>

<style lang="scss">
body {
  margin: 0;  /* 如果页面出现垂直滚动条,则加入此行CSS以消除之 */
}
</style>

3. 添加Vue项目静态资源文件

为加速页面首次加载速度,富文本组件(Vue2Editor)采用了懒加载方式,即表单中包含富文本组件时由浏览器动态加载所需js文件,该文件为"node_modules\vform-builds\dist\VFormDesigner.umd.min.1.js"。

在开发阶段,需要将该文件复制到Vue项目的静态资源目录(通常为public目录),复制后路径为:

项目根目录\public\js\VFormDesigner.umd.min.1.js

4. 指定AceEditor的动态加载路径

代码编辑器组件AceEditor大量使用了动态按需加载js技术,仅当需要时才动态加载所需js、css文件,目前AceEditor库文件部署在VForm官方的CDN服务器上,如果你要在生产环境使用VForm,建议私有部署AceEditor。

私有部署方法:将node_modules\ace-builds\src-min-noconflict目录下的所有文件上传到web服务器或CDN。

image.png

私有部署AceEditor后,需要同步修改utils/config.js文件如下一行代码:

export const ACE_BASE_PATH = '部署后的ace打包库文件URL'

三、使用VFormRender组件

VFormRender为VForm的表单渲染器组件,用于将表单JSON对象渲染为Vue组件。

重要提示:如果表单json对象是通过后台接口异步获取到的,用form-json属性传值则会导致表单校验提示异常,需要调用setFormJson(xxx)方法,具体参见此处文档——《渲染表单》

1. 使用VFormRender


<template>
  <div>
    <v-form-render :form-json="formJson" :form-data="formData" :option-data="optionData" ref="vFormRef">
    </v-form-render>
    <el-button type="primary" @click="submitForm">Submit</el-button>
  </div>
</template>
<script>
  export default {
    data() {
      return {
        formJson: {"widgetList":[],"formConfig":{"labelWidth":80,"labelPosition":"left","size":"","labelAlign":"label-left-align","cssCode":"","customClass":"","functions":"","layoutType":"PC","onFormCreated":"","onFormMounted":"","onFormDataChange":""}},
        formData: {},
        optionData: {}
      }
    },
    methods: {
      submitForm() {
        this.$refs.vFormRef.getFormData().then(formData => {
          // Form Validation OK
          alert( JSON.stringify(formData) )
        }).catch(error => {
          // Form Validation failed
          this.$message.error(error)
        })
      }
    }
  }
</script>

2. 添加Vue项目静态资源文件

为加速页面首次加载速度,富文本组件(Vue2Editor)采用了懒加载方式,即表单中包含富文本组件时由浏览器动态加载所需js文件,该文件为"node_modules\vform-builds\dist\VFormRender.umd.min.1.js"。

在开发阶段,需要将该文件复制到Vue项目的静态资源目录(通常为public目录),复制后路径为:

项目根目录\public\js\VFormRender.umd.min.1.js