npm 包 @up24/joi 使用教程

阅读时长 5 分钟读完

前言

在前端开发中,表单验证是必不可少的一部分。@up24/joi 是一个强大的 Node.js 通用验证库,它可以帮助开发者实现简单、可扩展的表单验证。本文将会介绍如何使用 @up24/joi 完成常用的表单验证功能。

安装

使用 npm 安装 @up24/joi:

基本使用

在使用 @up24/joi 之前,我们需要引入该库:

验证一个字符串

我们可以使用 Joi.string() 验证一个字符串,例如验证用户名是否合法:

上面的代码中,我们定义一个 Joi 对象,通过调用 Joi.string() 方法,指定了验证规则:字符串必须为字母和数字组成,长度在3到30个字符,且不能为空。然后,我们使用 schema.validate() 方法验证输入的字符串,如果验证通过,result 将会是一个空对象,否则它会包含错误信息。

验证一个数字

我们还可以使用 Joi.number() 验证数字类型:

上面的代码中,我们定义了 age 字段必须为整数类型,且在0到99之间,且不能为空。

验证一个数组

Joi.array() 用于验证数组类型:

上面的代码中,我们定义了 tags 字段必须为字符串类型的数组,且不能为空。

验证对象

我们可以使用 Joi.object() 验证对象类型:

上面的代码中,我们定义了 user 字段必须为对象类型,且包含 firstname 和 lastname 两个字段,这两个字段的验证规则与上面的例子相同。

复杂验证规则

@up24/joi 还支持更复杂的验证规则,例如验证邮箱地址、URL 等:

上面的代码中,我们验证了 email 字段必须为合法的邮箱地址,url 字段必须为合法的 URL。

配置选项

我们可以通过传递一些选项来修改默认的行为:

-- -------------------- ---- -------
----- ------ - ------------
  --------- -------------------------------------------------
---

----- ------- - -
  ----------- ------
  -------- ------
  ------------- ----
--

----- ------ - ----------------- --------- ------------ -- ---------

上面的代码中,我们定义了三个选项:

  • abortEarly:如果设置为 false,则在验证失败时,Joi 不会停止验证并返回所有错误消息,默认为 true
  • convert:如果设置为 true,则将数据转换为相应的类型,否则不转换。默认为 true
  • allowUnknown:如果设置为 true,则允许包含未知字段,默认为 false

自定义错误信息

@up24/joi 也支持自定义错误信息:

-- -------------------- ---- -------
----- ------ - ------------
  --------- ------------------------------------------------------------
    ---------------------- --------- ---- ---- ------- ------- ------ -------
  --
---

----- ------ - ----------------- --------- ------------- ---

---------------------------------------------  -- -------- ---- ---- ------- ------- ------ ------

可以看到,我们将字符串只能包含字母和数字的规则的错误信息修改为了自定义信息。

总结

本文介绍了如何使用 @up24/joi 完成常用的表单验证功能,包括验证字符串、数字、数组、对象,以及更复杂的验证规则,同时还讲解了如何修改配置选项和自定义错误信息。相信通过本文的学习,读者可以更好地运用 @up24/joi 实现表单验证,提高前端开发的效率和质量。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600672693660cf7123b3673a

纠错
反馈