ng-dynamic-forms源码分析

在两个开源项目中,ng-dynamic-forms的源码相较于form.io,比较简单,所以我还勉强能看懂,下面就我自己的理解进行简单分析,若有不对的地方,请大家多多指正。

整体结构分析

ng-dynamic-forms的主要代码均分布在packages文件夹下,其中的Core是各种控件的抽象,其他的文件夹是各个UI框架的具体封装,每个文件夹都是一个可独立编译运行的项目。

Core文件夹内容分析

Core文件夹做的事情,基本上是对于各种组件、布局的抽象,说简单点,就是定义了,这个框架有哪些组件,这些组件都有哪些事件、哪些方法。接下来我们具体分析一下:

utils文件夹:

这个文件夹最不重要,是一些工具类的封装,无需多解释

component/dynamic-form-component文件:

这个文件定义了表单(<form></form>)的抽象类DynamicFormComponent,也就是一组表单控件的集合,将来每种UI库的都会有该类的子类,并根据需要重写其中的一些方法和属性。

它实现了一些基础的事件和属性。

事件:blur,change,focus,customerEvent

属性:formGroup、formModel、formLayout

component/dynamic-form-control.component文件:

这个文件定义了表单的表单元素的抽象类DynamicFormControlComponent,将来每个UI控件的具体类,都要继承自该类,并更新需要进行重写和扩展。

该类具有以下事件和属性:

事件:onControlValueChanges,onModelValueUpdates,onModelDisabledUpdates,onValueChange,onBlur,onFocus,onCustomEvent

属性:errorMessages,showHint,hasList,isInvalid,isValid,showErrorMessages,templateList

decorator/serializable.decorator文件:

定义了一个公共的装饰器,用于方便传入Key-Value形式的属性。

model文件夹:

model文件夹是整个Core文件夹中,比较重要的一块,他定义了动态表单所支持的表单元素的和一些表单包裹元素。

总体来说,ng-dynamic-forms将控件分为如下几类:

输入类:文本框,文本域,富文本编辑框

单值类:包含所有的输入类、选择类控件,另外还有颜色选择器、日期选择、文件选择组件、评分组件、滑动组件

选择类:复选框(CheckBox)、开关(Switch)

选项类:下拉框、单选框

日期类:日期选择组件、时间选择组件

文件类:文件上传组件

布局类:FormGroup、FormArrary

Service文件夹:

dynamic-form.service:

主要一些对FromGroup、FromArrary中表单元素动态增删改的操作,以及通过Json数据创建表单的操作

dynamic-form-layout.service:

表单布局的一些相关方法,方便表单元素找到他外层包裹的容器的样式、ID类的

dynamic-form-validation.service:

从名字就可以看出来,这个服务是用来做表单校验的

UI库实现分析

前面赘述了一堆,都是ng-dynamic-forms的抽象实现,那具体到每一种UI组件是如何套用的呢?让我们一起来看看吧~

我们以ui-bootstrap的实现为例:

文件夹结构

基本上每个UI库的大概结构都如上图所示,其中:

dynamic-bootstrap-form.component 中的DynamicBootstrapFormComponent类,是继承自Core中的 DynamicFormComponent,它的HTML模板中的代码如下:

<dynamic-bootstrap-form-control *ngFor="let model of formModel; trackBy: trackByFn"
[group]="formGroup"
[hasErrorMessaging]="model.hasErrorMessages"
[hidden]="model.hidden"
[layout]="formLayout"
[model]="model"
[ngClass]="[getClass(model,'element','host'), getClass(model,'grid','host')]"
[templates]="templates"
(dfBlur)="onEvent($event, 'blur')"
(dfChange)="onEvent($event, 'change')"
(dfFocus)="onEvent($event, 'focus')"></dynamic-bootstrap-form-control>

首先他有ngFor来循环各种表单控件,然后定义了一个FromGroup来包装这些组件,并且绑定了各种事件、样式等等,看到这里,应该稍微明白点了,这个东东,他是用来生成各种控件外面包裹的部分的。

接着往下看,文件夹中还会有一个dynamic-bootstrap-form-control.component文件,打开ts文件,里面貌似没有啥东西,然后再打开html文件,就会发现另一番天地了,里面N多的类似于下面的代码:

<!-- SELECT -->
<select *ngSwitchCase="7" class="form-control"
[dynamicId]="bindId && model.id"
[formControlName]="model.id"
[name]="model.name"
[ngClass]="getClass('element', 'control')"
[required]="model.required"
[tabindex]="model.tabIndex"
(blur)="onBlur($event)"
(change)="onValueChange($event)"
(focus)="onFocus($event)"> <option *ngFor="let option of model.options$ | async"
[disabled]="option.disabled"
[ngValue]="option.value">{{ option.label }}</option> </select>

从这个代码,我们可以分析出,这个部分,他是根据不同的type,来生成不同的控件的html,并且bootstrap的控件样式也是直接定义到这个文件中的。

总结

前面乱七八糟分析的一大堆,可能说的比较乱,我们来整体屡一下整体的思路:

首先,由Core中定义了控件的公共行为和属性,是所有控件库的一套抽象,主要包括三部分:

  1. 一部分是控件的布局用到的,即包裹表单控件的外层容器
  2. 另一部分是基础的控件,包括整个框架支持哪些控件,这些控件有拥有哪些属性,这些属性往往是不同UI库中该控件共同所有的部分
  3. 还有一部分是定义了表单控件的校验部分

其次,该项目中实现众多市面上常见的UI库,这部分主要干了两个事儿:

  1. 通过实现Core中定义的抽象,将各种属性和UI库中的控件中对应的属性绑定起来
  2. 另一方面,将最终使用时动态的控件定义,按照UI库的样式、结构生成HTML

就是通过这样一种模式,该框架将一个个控件的对象,最终转换成UI中展示的HTML。

Angular动态表单生成(二)的更多相关文章

  1. Angular动态表单生成(八)

    动态表单生成之拖拽生成表单(下) 我们的动态表单,最终要实现的效果与Form.io的在线生成表单的效果类似,可以参考它的demo地址:https://codepen.io/travist/full/x ...

  2. Angular动态表单生成(七)

    动态表单生成之拖拽生成表单(上) 这个功能就比较吊炸天了,之前的六篇,都是ng-dynamic-forms自带的功能,可能很多的说明官方的文档都已经写了,我只是个搬运工,而在这篇文章中,我将化身一个工 ...

  3. Angular动态表单生成(一)

    好久不写博客了,手都生了,趁着最近老大让我研究动态表单生成的时机,撸一发博客~~ 开源项目比较 老大丢给我了两个比较不错的开源的动态表单生成工具,这两个项目在github上的star数量基本持平: h ...

  4. Angular动态表单生成(五)

    动态表单生成之布局 到上面的篇章为止,我们已经把表单比较完整的生成出来了,也实现了一些验证功能,可以说,我们截止这里,就已经可以满足我们的大部分表单生成需求了~ 但是: 目前来说,我们对于表单的布局只 ...

  5. Angular动态表单生成(六)

    动态表单之根据Json生成表单 我们在实际的使用中,动态表单往往是由服务器端的一系列配置,然后返回数据给客户端,最后客户端根据数据来动态的生成表单.那么怎么像我们上面所描述的这样,生成一个可以让我们的 ...

  6. Angular动态表单生成(三)

    ng-dynamic-forms实践篇(上) 定个小目标 先来定个小目标吧,我们要实现的效果: 动态生成一个表单,里面的字段如下: 字段名称 字段类型 验证 备注 姓名 text 必填,长度小于15 ...

  7. Angular动态表单生成(四)

    ng-dynamic-forms实践篇(下) 我们接着上篇,先把小目标中的所有字段都定义出来 这部分就是苦力活儿了,把KendoUiComponent中的formModel完善即可: formMode ...

  8. form-create 3.0 版本发布,好用的Vue3版本动态表单生成组件

    form-create 是一个可以通过 JSON 生成具有动态渲染.数据收集.验证和提交功能的表单生成组件.支持2个UI框架,并且支持生成任何 Vue 组件.内置20种常用表单组件和自定义组件,再复杂 ...

  9. Vue+Element的动态表单,动态表格(后端发送配置,前端动态生成)

    Vue+Element的动态表单,动态表格(后端发送配置,前端动态生成) 动态表单生成 ElementUI官网引导 Element表单生成 Element动态增减表单,在线代码 关键配置 templa ...

随机推荐

  1. Java的文档注释之生成帮助文档

    示例: /** * Title: Person类<br/> * Description:通过Person类说明Java中的文档注释<br/> * Company: *** * ...

  2. Mac(OS X)中Git安装与GitHub基本使用

    GitHub是一个面向开源及私有软件项目的托管平台.开源代码库以及版本控制系统,因为只支持 Git 作为唯一的版本库格式进行托管,故名 GitHub.通常在Windows下使用GitHub的教程是非常 ...

  3. [翻译]Review——How JavaScript works:The building blocks of Web Workers

    原文地址:https://blog.sessionstack.com/how-javascript-works-the-building-blocks-of-web-workers-5-cases-w ...

  4. 简单Json序列化和反序列化

    序列化是什么: 序列化就是将一个对象的状态(各个属性量)保存起来,然后在适当的时候再获得.序列化分为两大部分:序列化和反序列化.序列化是这个过程的第一部分,将数据分解成字节流,以便存储在文件中或在网络 ...

  5. WC前的颓废——带花树

    QAQ现在很不想写题解博客那就来写个算法吧QAQ... 带花树 题目 来看个题... UOJ79. 某机房里有\(n\)个OIer,其中有\(n\)个男生,\(0\)个女生.现在他们要两两配对. 有\ ...

  6. 使用WampServer搭建本地PHP环境,绑定域名,配置伪静态

    倡萌之前介绍过 USBWebserver 快速搭建本地PHP环境 ,推荐USBWebserver的原因在于它是绿色的,不需要安装,想使用就手动运行下即可.但是 USBWebserver 也有自身的弱点 ...

  7. MathQuill.js

    MathQuill.js通过html.css.javascript实现数学公式 <p>Type math here: <span id="math-field"& ...

  8. RGB与INT类型的转换

    开发时遇到的问题,设置图层样式时颜色的返回值是uint,一时不知改怎么转换为C#常用的RGB值了. 一番百度,结果如下: RGB = R + G * 256 + B * 256 * 256 因此可得到 ...

  9. change grayscale to pseudo colouring using colormap in Matlab

    change grayscale to pseudo colouring using colormap in Matlab In matlab you can view a grayscale ima ...

  10. 对WebSocket技术的学习与探索(一)

    WebSocket 简要介绍 WebSocket protocol 是HTML5一种新的协议. 它实现了浏览器与服务器全双工通信(full-duple). 一开始的握手需要借助HTTP请求完成. We ...