WxValidate.js 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443
  1. /**
  2. * 表单验证
  3. *
  4. * @param {Object} rules 验证字段的规则
  5. * @param {Object} messages 验证字段的提示信息
  6. *
  7. */
  8. class WxValidate {
  9. constructor(rules = {}, messages = {}) {
  10. Object.assign(this, {
  11. data: {},
  12. rules,
  13. messages,
  14. })
  15. this.__init()
  16. }
  17. /**
  18. * __init
  19. */
  20. __init() {
  21. this.__initMethods()
  22. this.__initDefaults()
  23. this.__initData()
  24. }
  25. /**
  26. * 初始化数据
  27. */
  28. __initData() {
  29. this.form = {}
  30. this.errorList = []
  31. }
  32. /**
  33. * 初始化默认提示信息
  34. */
  35. __initDefaults() {
  36. this.defaults = {
  37. messages: {
  38. required: '这是必填字段。',
  39. email: '请输入有效的电子邮件地址。',
  40. tel: '请输入11位的手机号码。',
  41. phone: '请输入正确的电话号码。',
  42. url: '请输入有效的网址。',
  43. date: '请输入有效的日期。',
  44. dateISO: '请输入有效的日期(ISO),例如:2009-06-23,1998/01/22。',
  45. number: '请输入有效的数字。',
  46. digits: '只能输入数字。',
  47. idcard: '请输入18位的有效身份证。',
  48. equalTo: this.formatTpl('输入值必须和 {0} 相同。'),
  49. contains: this.formatTpl('输入值必须包含 {0}。'),
  50. minlength: this.formatTpl('最少要输入 {0} 个字符。'),
  51. maxlength: this.formatTpl('最多可以输入 {0} 个字符。'),
  52. rangelength: this.formatTpl('请输入长度在 {0} 到 {1} 之间的字符。'),
  53. min: this.formatTpl('请输入不小于 {0} 的数值。'),
  54. max: this.formatTpl('请输入不大于 {0} 的数值。'),
  55. range: this.formatTpl('请输入范围在 {0} 到 {1} 之间的数值。'),
  56. }
  57. }
  58. }
  59. /**
  60. * 初始化默认验证方法
  61. */
  62. __initMethods() {
  63. const that = this
  64. that.methods = {
  65. /**
  66. * 验证必填元素
  67. */
  68. required(value, param) {
  69. if (!that.depend(param)) {
  70. return 'dependency-mismatch'
  71. } else if (typeof value === 'number') {
  72. value = value.toString()
  73. } else if (typeof value === 'boolean') {
  74. return !0
  75. }
  76. return value.length > 0
  77. },
  78. /**
  79. * 验证电子邮箱格式
  80. */
  81. email(value) {
  82. return that.optional(value) || /^[a-zA-Z0-9.!#$%&'*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/.test(value)
  83. },
  84. /**
  85. * 验证手机格式
  86. */
  87. tel(value) {
  88. return that.optional(value) || /^1[345789]\d{9}$/.test(value)
  89. },
  90. /**
  91. * 验证手机格式
  92. */
  93. phone(value) {
  94. return that.optional(value) || /^0\d{2,3}-?\d{7,8}$/.test(value)
  95. },
  96. /**
  97. * 验证URL格式
  98. */
  99. url(value) {
  100. return that.optional(value) || /^(?:(?:(?:https?|ftp):)?\/\/)(?:\S+(?::\S*)?@)?(?:(?!(?:10|127)(?:\.\d{1,3}){3})(?!(?:169\.254|192\.168)(?:\.\d{1,3}){2})(?!172\.(?:1[6-9]|2\d|3[0-1])(?:\.\d{1,3}){2})(?:[1-9]\d?|1\d\d|2[01]\d|22[0-3])(?:\.(?:1?\d{1,2}|2[0-4]\d|25[0-5])){2}(?:\.(?:[1-9]\d?|1\d\d|2[0-4]\d|25[0-4]))|(?:(?:[a-z\u00a1-\uffff0-9]-*)*[a-z\u00a1-\uffff0-9]+)(?:\.(?:[a-z\u00a1-\uffff0-9]-*)*[a-z\u00a1-\uffff0-9]+)*(?:\.(?:[a-z\u00a1-\uffff]{2,})).?)(?::\d{2,5})?(?:[/?#]\S*)?$/i.test(value)
  101. },
  102. /**
  103. * 验证日期格式
  104. */
  105. date(value) {
  106. return that.optional(value) || !/Invalid|NaN/.test(new Date(value).toString())
  107. },
  108. /**
  109. * 验证ISO类型的日期格式
  110. */
  111. dateISO(value) {
  112. return that.optional(value) || /^\d{4}[\/\-](0?[1-9]|1[012])[\/\-](0?[1-9]|[12][0-9]|3[01])$/.test(value)
  113. },
  114. /**
  115. * 验证十进制数字
  116. */
  117. number(value) {
  118. return that.optional(value) || /^(?:-?\d+|-?\d{1,3}(?:,\d{3})+)?(?:\.\d+)?$/.test(value)
  119. },
  120. /**
  121. * 验证整数
  122. */
  123. digits(value) {
  124. return that.optional(value) || /^\d+$/.test(value)
  125. },
  126. /**
  127. * 验证身份证号码
  128. */
  129. idcard(value) {
  130. return that.optional(value) || /^[1-9]\d{5}[1-9]\d{3}((0\d)|(1[0-2]))(([0|1|2]\d)|3[0-1])\d{3}([0-9]|X)$/.test(value)
  131. },
  132. /**
  133. * 中文和英文
  134. */
  135. cnAndEg(value) {
  136. return that.optional(value) || /^[\u4e00-\u9fa5a-zA-Z]+$/.test(value)
  137. },
  138. /**
  139. * 数字和英文
  140. */
  141. egAndNumber(value) {
  142. return that.optional(value) || /^[0-9a-zA-Z]+$/.test(value)
  143. },
  144. /**
  145. * 小数点后两位
  146. * */
  147. fixedNumber() {
  148. return that.optional(value) || /^(\d?)+(\.\d{0,2})?$/.test(value)
  149. },
  150. /**
  151. * 验证两个输入框的内容是否相同
  152. */
  153. equalTo(value, param) {
  154. return that.optional(value) || value === that.data[param]
  155. },
  156. /**
  157. * 验证是否包含某个值
  158. */
  159. contains(value, param) {
  160. return that.optional(value) || value.indexOf(param) >= 0
  161. },
  162. /**
  163. * 验证最小长度
  164. */
  165. minlength(value, param) {
  166. return that.optional(value) || value.length >= param
  167. },
  168. /**
  169. * 验证最大长度
  170. */
  171. maxlength(value, param) {
  172. return that.optional(value) || value.length <= param
  173. },
  174. /**
  175. * 验证一个长度范围[min, max]
  176. */
  177. rangelength(value, param) {
  178. return that.optional(value) || (value.length >= param[0] && value.length <= param[1])
  179. },
  180. /**
  181. * 验证最小值
  182. */
  183. min(value, param) {
  184. return that.optional(value) || value >= param
  185. },
  186. /**
  187. * 验证最大值
  188. */
  189. max(value, param) {
  190. return that.optional(value) || value <= param
  191. },
  192. /**
  193. * 验证一个值范围[min, max]
  194. */
  195. range(value, param) {
  196. return that.optional(value) || (value >= param[0] && value <= param[1])
  197. },
  198. }
  199. }
  200. /**
  201. * 添加自定义验证方法
  202. * @param {String} name 方法名
  203. * @param {Function} method 函数体,接收两个参数(value, param),value表示元素的值,param表示参数
  204. * @param {String} message 提示信息
  205. */
  206. addMethod(name, method, message) {
  207. this.methods[name] = method
  208. this.defaults.messages[name] = message !== undefined ? message : this.defaults.messages[name]
  209. }
  210. /**
  211. * 判断验证方法是否存在
  212. */
  213. isValidMethod(value) {
  214. let methods = []
  215. for (let method in this.methods) {
  216. if (method && typeof this.methods[method] === 'function') {
  217. methods.push(method)
  218. }
  219. }
  220. return methods.indexOf(value) !== -1
  221. }
  222. /**
  223. * 格式化提示信息模板
  224. */
  225. formatTpl(source, params) {
  226. const that = this
  227. if (arguments.length === 1) {
  228. return function() {
  229. let args = Array.from(arguments)
  230. args.unshift(source)
  231. return that.formatTpl.apply(this, args)
  232. }
  233. }
  234. if (params === undefined) {
  235. return source
  236. }
  237. if (arguments.length > 2 && params.constructor !== Array) {
  238. params = Array.from(arguments).slice(1)
  239. }
  240. if (params.constructor !== Array) {
  241. params = [params]
  242. }
  243. params.forEach(function(n, i) {
  244. source = source.replace(new RegExp("\\{" + i + "\\}", "g"), function() {
  245. return n
  246. })
  247. })
  248. return source
  249. }
  250. /**
  251. * 判断规则依赖是否存在
  252. */
  253. depend(param) {
  254. switch (typeof param) {
  255. case 'boolean':
  256. param = param
  257. break
  258. case 'string':
  259. param = !!param.length
  260. break
  261. case 'function':
  262. param = param()
  263. default:
  264. param = !0
  265. }
  266. return param
  267. }
  268. /**
  269. * 判断输入值是否为空
  270. */
  271. optional(value) {
  272. return !this.methods.required(value) && 'dependency-mismatch'
  273. }
  274. /**
  275. * 获取自定义字段的提示信息
  276. * @param {String} param 字段名
  277. * @param {Object} rule 规则
  278. */
  279. customMessage(param, rule) {
  280. const params = this.messages[param]
  281. const isObject = typeof params === 'object'
  282. if (params && isObject) return params[rule.method]
  283. }
  284. /**
  285. * 获取某个指定字段的提示信息
  286. * @param {String} param 字段名
  287. * @param {Object} rule 规则
  288. */
  289. defaultMessage(param, rule) {
  290. let message = this.customMessage(param, rule) || this.defaults.messages[rule.method]
  291. let type = typeof message
  292. if (type === 'undefined') {
  293. message = `Warning: No message defined for ${rule.method}.`
  294. } else if (type === 'function') {
  295. message = message.call(this, rule.parameters)
  296. }
  297. return message
  298. }
  299. /**
  300. * 缓存错误信息
  301. * @param {String} param 字段名
  302. * @param {Object} rule 规则
  303. * @param {String} value 元素的值
  304. */
  305. formatTplAndAdd(param, rule, value) {
  306. let msg = this.defaultMessage(param, rule)
  307. this.errorList.push({
  308. param: param,
  309. msg: msg,
  310. value: value,
  311. })
  312. }
  313. /**
  314. * 验证某个指定字段的规则
  315. * @param {String} param 字段名
  316. * @param {Object} rules 规则
  317. * @param {Object} data 需要验证的数据对象
  318. */
  319. checkParam(param, rules, data) {
  320. // 缓存数据对象
  321. this.data = data
  322. // 缓存字段对应的值
  323. const value = data[param] !== null && data[param] !== undefined ? data[param] : ''
  324. // 遍历某个指定字段的所有规则,依次验证规则,否则缓存错误信息
  325. for (let method in rules) {
  326. // 判断验证方法是否存在
  327. if (this.isValidMethod(method)) {
  328. // 缓存规则的属性及值
  329. const rule = {
  330. method: method,
  331. parameters: rules[method]
  332. }
  333. // 调用验证方法
  334. const result = this.methods[method](value, rule.parameters)
  335. // 若result返回值为dependency-mismatch,则说明该字段的值为空或非必填字段
  336. if (result === 'dependency-mismatch') {
  337. continue
  338. }
  339. this.setValue(param, method, result, value)
  340. // 判断是否通过验证,否则缓存错误信息,跳出循环
  341. if (!result) {
  342. this.formatTplAndAdd(param, rule, value)
  343. break
  344. }
  345. }
  346. }
  347. }
  348. /**
  349. * 设置字段的默认验证值
  350. * @param {String} param 字段名
  351. */
  352. setView(param) {
  353. this.form[param] = {
  354. $name: param,
  355. $valid: true,
  356. $invalid: false,
  357. $error: {},
  358. $success: {},
  359. $viewValue: ``,
  360. }
  361. }
  362. /**
  363. * 设置字段的验证值
  364. * @param {String} param 字段名
  365. * @param {String} method 字段的方法
  366. * @param {Boolean} result 是否通过验证
  367. * @param {String} value 字段的值
  368. */
  369. setValue(param, method, result, value) {
  370. const params = this.form[param]
  371. params.$valid = result
  372. params.$invalid = !result
  373. params.$error[method] = !result
  374. params.$success[method] = result
  375. params.$viewValue = value
  376. }
  377. /**
  378. * 验证所有字段的规则,返回验证是否通过
  379. * @param {Object} data 需要验证数据对象
  380. */
  381. checkForm(data) {
  382. this.__initData()
  383. for (let param in this.rules) {
  384. this.setView(param)
  385. this.checkParam(param, this.rules[param], data)
  386. }
  387. return this.valid()
  388. }
  389. /**
  390. * 返回验证是否通过
  391. */
  392. valid() {
  393. return this.size() === 0
  394. }
  395. /**
  396. * 返回错误信息的个数
  397. */
  398. size() {
  399. return this.errorList.length
  400. }
  401. /**
  402. * 返回所有错误信息
  403. */
  404. validationErrors() {
  405. return this.errorList
  406. }
  407. }
  408. export default WxValidate