Skip to end of metadata
Go to start of metadata

概述

dorado7提供了完整的数据的校验机制:

  • 支持多种类型的数据校验,如:长度校验,中文字符校验,范围校验,正则表达式校验等等;
  • 支持多种数据校验级别,如:info, ok, warn, error等,且不同校验状态拥有自己的个性化的校验图标;
  • 校验器提供规范的属性配置,大多数场景无效编码;
  • 提供校验器关闭特性,便于支持草稿保存或临时数据保存的业务场景;

下图是一个有各种数据校验的界面效果:

范例地址: http://bsdn.org/projects/dorado7/deploy/sample-center/com.bstek.dorado.sample.Main.d#78850

不同的图标代表不同的含义:

图标

校验级别

ok

info

warn

error

校验是通过校验器实现的,目前提供的校验器有8种:

校验器说明详细说明
RequiredValidator非空数据校验器更多...
LengthValidator长度数据校验器更多...
CharLengthValidator字节长度数据校验器更多...
RangeValidator范围数据校验器更多...
EnumValidator枚举数据校验器更多...
RegExtValidator正则表达式数据校验器更多...
AjaxValidatorAjax数据校验器更多...
CustomValidator自定义数据校验器,当以上校验器都无法满足你的校验需求时,可以用自定义数据校验器更多...

由于Dorado中客户端的MVC开发模式,因此数据校验器被设计为针对数据模型的,而不是页面上可见的控件。

因此当我们期望对界面层的某一个控件添加数据校验逻辑的时候,就应该找到与之对应的数据模型定义(DataType下的PropertyDef),并在此对象上添加符合项目需求的数据校验器:

这样设计的好处是,当我们试图通过JS去修改数据对象的时候也会自动触发我们添加到数据模型对象上的数据校验器。从而提高数据的安全性。

手动触发数据校验的办法

如前所述,数据校验都和数据模型有关,如果我们希望通过自己的JS代码触发数据校验,可以先获得当前的数据对象,并通过Entity的validate()方法触发,如:

如果数据校验失败,返回的就是"invalid"的值,如:

如果我们仅仅想校验一个具体的属性,可以这么写:

关于validate()方法的更多说明参考JSDOC.

后文会再描述关于validate()方法的计算规则

validatorsDisabled特性(实现草稿保存)

场景说明:试想一个政府在线填报页面,200个编辑框,其中50个编辑框非空,通常而言我们都需要起码填写好这50个编辑框才能保存到数据库。能不能有一种机制,让我的业务数据即使非空字段没有填写情况下也可以临时保存一下,这样这个填报功能我就可以多次填写,方便工作。
利用dorado提供的校验器开关功能,我们可以较为方便的实现这种逻辑,我们在保存草稿的按钮代码中对当前要提交的Entity做如下控制:

下载:范例

其他一些高级属性说明

resultMessage

Validator数据校验失败会有系统默认的提示信息,如果你还想定制这个错误信息,则可以通过resultMessage属性定制:

注意

对于校验失败时系统默认提供的的提示信息,你可以通过修改系统默认的国际化资源来调整,详细说明参考:国际化资源

defaultResultState属性

每一个Validator的默认的校验级别(defaultResultState)为error,如下图:

如果希望调整校验级别,则在IDE中打开defaultResultState属性对应的下拉框选择:

defaultResultState修改后,这个PropertyDef的数据校验如果成功就是ok,如果校验失败,则校验结果就是defaultResultState的值。

修改defaultResultState的含义在于某些情况下你希望在数据校验未通过情况下依然可以提交数据的处理,这种数据校验是一种弱的数据校验,在很多场景下是希望借此规范用户输入数据的习惯。

defaultResultState的修改会影响最终数据提交的逻辑,这个与下面介绍DataType的acceptValidationState属性有关

acceptValidationState

之前我们介绍过Entity对象的validator()方法执行数据校验,

关于validate()方法的计算规则

对于一个Entity对象来说会有多个PropertyDef属性,并且每一个PropertyDef下可能有多个数据校验器,当我们执行Entity对象的validate()方法的时候会遍历内部所有的PropertyDef的所有数据校验器。那validate()方法如何决定最终校验的结果是ok还是invalid的呢?

为了方便这种计算,首先我们定义了一种规则,就是四种校验级别的顺序:info <ok < warn < error 

另外每一个数据校验器的校验结果的运输规则是:如果校验通过就返回ok,否则就是上面我们介绍到的defaultResultState属性值,默认是error。

如某一个属性定义了三个数据校验器:长度校验器,Enum校验器,正则表达式校验器。假设他们的校验结果为:

校验器校验结果
长度校验器成功,返回ok
Enum校验器失败,返回info
正则表达式校验器失败,返回warn

上述三个校验结果合并后,我们取级别最高的校验结果作为整个PropertyDef的数据校验结果,如本例最终数据校验结果为warn。

之后遍历Entity下每一个PropertyDef的校验结果,同样获取它们之间级别最高的那个最为整个Entity的最终数据校验结果,假设为warn。

最后再与DataType的acceptValidationState属性做比较:

如果我们将DataType的acceptValidationState的值设置为warn,而Entity的校验结果为warn,则最终Entity的validate()方法的返回值就是ok。

关于validate()的触发

通常情况下当我们在编辑框中输入数据的时候会自动触发数据校验。

但是当我们没有对一个数据对象的属性赋值时,是不会触发它的数据校验规则的。例如一个编辑框我们设置为长度必须大于5,小于10,但是我们没有对这个编辑框做过编辑工作,则默认不会触发这个编辑框所对应的PropertyDef的数据校验。这种情况下只有到最终数据提交的时候我们才需要通过Entity的validate()再次确认一下。

提示

但是在大部分场景下我们并不会直接接触到validate()方法。因为大部分场景我们都是通过UpdateAction去提交数据的,这个控件内部会自动触发validate()进行数据校验。并且根据以上validate()的计算规则计算,如果计算结果为ok,就允许提交,否则就不允许提交。

提示

在特殊情况下,如果你的数据不是通过UpdateAction的默认处理机制提交的,那么你就需要在提交数据之前通过JS调用Entity的validate()方法才会触发数据校验逻辑。你要根据运算结果再决定如何做下一步的逻辑处理,如:

revalidateOldValue 原始值校验机制

当我们将某个编辑框的值从A改为B时,这个时候触发的数据校验没有通过的情况下。用户又将值从B修改为A。这个时候会再次触发数据校验。但是在特殊情况下,如果你还不想再次触发数据校验,则你可以将对应数据校验器的revalidateOldValue的值设置为false就可以,默认为true。

提示

常见场景有:对应的数据校验器比较消耗系统资源或耗时比较长,会带来不良用户体验的时候,我们就应该将对应数据校验器的revalidateOldValue设置为false

 

runAt(暂未实现)

另外校验器默认只做JS的前台校验,如果你希望调整这个规则可以修改Validator的runAt属性:

runAt值说明
client客户端数据校验
server服务器端数据校验
both客户端和服务器端都做数据校验
Labels
  • No labels