formVerify.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266
  1. "use strict";
  2. var __importDefault = (this && this.__importDefault) || function (mod) {
  3. return (mod && mod.__esModule) ? mod : { "default": mod };
  4. };
  5. Object.defineProperty(exports, "__esModule", { value: true });
  6. const fieldCheck_1 = __importDefault(require("./fieldCheck"));
  7. // import {formItemData, formObject, formOption, FormVerifyOption} from "./types/formVerify";
  8. let hasOwnProperty = Object.prototype.hasOwnProperty;
  9. function hasOwn(obj, key) {
  10. return hasOwnProperty.call(obj, key);
  11. }
  12. /**
  13. * @class FormItem 表单验证类
  14. * @description 表单项
  15. * @param {formObject} formObject 表单项数据
  16. * @param {FieldCheck} [fieldCheck] 字段验证对象
  17. * @param {object} [option] 配置项
  18. */
  19. class FormVerify {
  20. constructor(formObject, fieldCheck, option) {
  21. this.formData = null;
  22. this.defaultOption = {
  23. isMustMatchRule: false,
  24. };
  25. this.option = {
  26. isMustMatchRule: false,
  27. };
  28. this.formState_default = 0;
  29. this.formState_pass = 1;
  30. this.formState_notPass = 2;
  31. this.fieldCheck = fieldCheck || new fieldCheck_1.default();
  32. // 合并配置项
  33. this.option = Object.assign(this.defaultOption, option);
  34. let errMsg;
  35. // 拿出其中的每一项来构建对应的表单项
  36. for (let key in formObject) {
  37. // this.formData[key] = object[key];
  38. // 验证表单项是否符合要求,不符合要求则抛出错误
  39. errMsg = FormVerify.buildFormItem(formObject, key, formObject[key], this.fieldCheck, this.option.isMustMatchRule);
  40. if (errMsg) {
  41. throw new Error(`表单项${key}不符合要求,err:${errMsg}`);
  42. }
  43. }
  44. this.formData = formObject;
  45. }
  46. static isObject(obj) {
  47. return obj !== null && typeof obj === 'object';
  48. }
  49. /**
  50. * 检查表单项是否符合要求
  51. * @param object 表单项数据
  52. * @param field 字段名
  53. * @param formItemData 表单项数据
  54. * @param fieldCheck 字段验证对象
  55. * @param isMustMatchRule 表单字段是否必须匹配到验证规则
  56. * @returns errMsg 错误信息
  57. */
  58. static buildFormItem(object, field, formItemData, fieldCheck, isMustMatchRule) {
  59. if (!FormVerify.isObject(formItemData)) {
  60. return `form item ${field} must be object`;
  61. }
  62. // 是否需要从验证规则表中查找对应的验证规则
  63. let isNeedMatchRule = true;
  64. // 用于匹配的字段
  65. let checkFieldStr = field;
  66. let disables = formItemData.disables;
  67. // 设置默认值
  68. formItemData.val = formItemData.val || formItemData.init || '';
  69. // 设置默认提示词
  70. formItemData.msg = formItemData.msg || '';
  71. // 设置默认状态
  72. formItemData.state = formItemData.state || FormVerify.formState_default;
  73. // 设置默认显示文本
  74. formItemData.label = formItemData.label || '';
  75. // 判断是否有 options 选项有则判断是否有 init 选项,没有则设置第一个为 init
  76. if (formItemData.options) {
  77. if (!formItemData.options.length || !formItemData.options[0]) {
  78. return `form item ${field} options must be array and has item`;
  79. }
  80. if (!formItemData.init) {
  81. formItemData.init = formItemData.options[0].key;
  82. }
  83. // 判断 val 与 init 是否存在于 options 中
  84. let hasInit = false;
  85. for (let i = 0; i < formItemData.options.length; i++) {
  86. let option = formItemData.options[i];
  87. if (option.key === formItemData.init) {
  88. hasInit = true;
  89. }
  90. // 判断该options是否为禁用项
  91. if (disables && disables.indexOf(option.key) !== -1) {
  92. option.disabled = true;
  93. }
  94. }
  95. if (!hasInit) {
  96. return `form item ${field} init value must be in options`;
  97. }
  98. }
  99. // 判断是否有 depend 依赖字段 有依赖字段则依据依赖字段中的 option 中的 checkField 字段进行判断
  100. if (formItemData.depend && formItemData.reCheckField) {
  101. return `form item ${field} has depend and reCheckField, but depend and reCheckField can not exist at the same time`;
  102. }
  103. // 判断是否有 depend 依赖字段 有依赖字段则依据依赖字段中的 option 中的 checkField 字段进行判断
  104. if (formItemData.depend) {
  105. let hasCheckField = false;
  106. let dependStr = formItemData.depend;
  107. let dependOptions = [];
  108. // 判断object 是否为 formObject 并且不为undefined
  109. if (!object) {
  110. return `form item ${field} depend field ${dependStr} but the field not exist`;
  111. }
  112. // 设置 object 不为undefined
  113. object = object;
  114. // 判断依赖字段是否存在
  115. if (!object[dependStr]) {
  116. return `form item ${field} depend field ${dependStr} but the field not exist`;
  117. }
  118. // 判断依赖字段的 option 是否存在
  119. if (!object[dependStr].options) {
  120. return `form item ${field} depend field ${dependStr} has no options`;
  121. }
  122. // 判断依赖字段的 options 中是否有 checkField 字段
  123. dependOptions = object[dependStr].options;
  124. for (let i = 0; i < dependOptions.length; i++) {
  125. let option = object ? dependOptions[i] : null;
  126. if (option === null || option === void 0 ? void 0 : option.checkField) {
  127. hasCheckField = true;
  128. checkFieldStr = option.checkField;
  129. break;
  130. }
  131. }
  132. if (!hasCheckField) {
  133. return `form item ${field} depend field ${dependStr} has no checkField`;
  134. }
  135. }
  136. // 判断是否有 reCheckField 有则使用该字段的值进行规则验证
  137. if (formItemData.reCheckField) {
  138. checkFieldStr = formItemData.reCheckField;
  139. }
  140. // 判断是否有 rules 规则
  141. if (isMustMatchRule) {
  142. if (fieldCheck.getRuleItem(checkFieldStr)) {
  143. return `form item ${field} has no rules`;
  144. }
  145. }
  146. return '';
  147. }
  148. /**
  149. * 初始化表单项数据
  150. * @param { formObject } formObject 表单对象
  151. */
  152. static initFormItemData(formObject) {
  153. let keys = Object.keys(formObject);
  154. for (let i = 0; i < keys.length; i++) {
  155. let key = keys[i];
  156. formObject[key].val = formObject[key].init;
  157. formObject[key].msg = '';
  158. formObject[key].state = FormVerify.formState_default;
  159. formObject[key].showText = '';
  160. }
  161. }
  162. /**
  163. * 检查表单项是否符合要求
  164. * @param {formObject} form 表单对象
  165. * @param isMustMatch 是否必须全部匹配到验证规则
  166. * @returns {boolean}
  167. */
  168. checkForm(form, isMustMatch) {
  169. let r = true;
  170. let n_checkPass = 0, n_checkTotal = 0;
  171. let msg = '';
  172. for (const fieldKey in form) {
  173. let formItem = form[fieldKey];
  174. if (!formItem) {
  175. continue;
  176. }
  177. let depend = form[formItem.depend || ''];
  178. let checkField = fieldKey;
  179. let tmpInd = -1;
  180. n_checkTotal++;
  181. if (formItem.reCheckField) {
  182. checkField = formItem.reCheckField;
  183. }
  184. // 禁用值判断 array
  185. if (formItem.disables) {
  186. if (formItem.disables.indexOf(formItem.val || '') !== -1) {
  187. formItem.msg = '该项内容不合法';
  188. r = false;
  189. }
  190. }
  191. // 枚举值判断
  192. if (formItem.options) {
  193. // 有枚举字段,只判断是否在枚举中
  194. // console.log(`检测枚举字段:${checkField},值:${formItem.val}`);
  195. tmpInd = formItem.options.findIndex(item => item.value == formItem.val);
  196. if (tmpInd === -1) {
  197. console.log(`检测枚举字段:${checkField},值:${formItem.val}不在范围内`);
  198. formItem.msg = '选项不在范围内';
  199. formItem.state = 1;
  200. r = false;
  201. }
  202. else {
  203. // 判断值是否为禁用项
  204. if (formItem.options[tmpInd].disabled) {
  205. formItem.msg = '该选项已经被禁用';
  206. r = false;
  207. }
  208. }
  209. // 枚举值判断完毕,继续下一个字段
  210. n_checkPass++;
  211. continue;
  212. }
  213. // 依赖字段判断
  214. if (depend) {
  215. depend = depend;
  216. if (depend.options) {
  217. // 依赖的对象有枚举类型,检查该枚举类型是否有有检测值
  218. let optionItem = depend.options.find(item => item.value == formItem.val);
  219. if (!optionItem) {
  220. depend.msg = '选项不在范围内';
  221. formItem.msg = '该值依赖项输入异常';
  222. r = false;
  223. // continue;
  224. }
  225. optionItem = optionItem;
  226. if (optionItem.checkField) {
  227. // console.log(`采用依赖项的检测字段${optionItem.checkField}`)
  228. checkField = optionItem.checkField;
  229. }
  230. }
  231. else {
  232. r = false;
  233. }
  234. if (!r) {
  235. depend.msg = '该项依赖项输入异常';
  236. formItem.msg = '该值依赖项输入异常';
  237. }
  238. }
  239. // 使用验证规则进行
  240. formItem.msg = this.fieldCheck.verify({
  241. [checkField]: formItem.val,
  242. });
  243. if (formItem.msg)
  244. r = false;
  245. if (r) {
  246. n_checkPass++;
  247. formItem.state = this.formState_pass;
  248. }
  249. else {
  250. formItem.state = this.formState_notPass;
  251. }
  252. }
  253. msg = `检查表单项通过率:${n_checkPass}/${n_checkTotal}`;
  254. console.log(msg);
  255. return r;
  256. }
  257. /**
  258. * 验证当前的表单是否符合要求
  259. * @param [isMustMatch] 是否必须全部匹配到验证规则
  260. */
  261. check(isMustMatch = false) {
  262. return this.checkForm(this.formData, isMustMatch);
  263. }
  264. }
  265. exports.default = FormVerify;
  266. //# sourceMappingURL=formVerify.js.map