Mongoose 中遇到验证错误信息未能正确捕获的解决方法

阅读时长 9 分钟读完

Mongoose 是一个优秀的 Node.js ORM 框架,它能够让我们以面向对象的方式来操作 MongoDB 数据库。在使用 Mongoose 进行开发时,我们经常需要定义模型,并对模型中的数据进行验证,以确保数据的正确性和完整性。然而,在实际开发中,我们有时会遇到验证错误信息未能正确捕获的情况,这会给我们带来很大的困扰。本文将介绍 Mongoose 中遇到验证错误信息未能正确捕获的解决方法,帮助大家更好地使用 Mongoose 进行开发。

问题描述

在使用 Mongoose 进行开发时,我们通常会定义模型,并对模型中的数据进行验证。例如,我们定义一个名为 User 的模型,并对其中的 email 字段进行验证:

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

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

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

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

在上面的代码中,我们使用了 Mongoose 内置的验证器对 email 字段进行验证,确保其符合电子邮件地址的格式。如果在保存 User 模型时,email 字段不符合要求,则会抛出 ValidationError 异常,其中包含了验证错误的详细信息。

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

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

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

在上面的代码中,我们创建了一个 email 字段为 "invalid_email" 的 User 对象,并尝试将其保存到数据库中。由于 email 字段不符合要求,save 方法会抛出 ValidationError 异常,其中包含了验证错误的详细信息。我们在 catch 块中捕获该异常,并输出了其中的 message 属性,即 "invalid_email is not a valid email address!"。

然而,在实际开发中,我们有时会遇到验证错误信息未能正确捕获的情况。例如,我们将上面的代码稍作修改:

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

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

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

在上面的代码中,我们使用了 Promise 的方式来保存 User 对象,并在 then 和 catch 块中分别处理成功和失败的情况。然而,当 email 字段不符合要求时,catch 块中输出的错误信息变得非常奇怪,包含了大量的 JSON 字符串和函数定义,难以阅读和理解。

解决方法

为了解决上述问题,我们需要对 Mongoose 进行一些配置。具体来说,我们需要对 Mongoose 的错误处理机制进行修改,使其能够正确地捕获和处理验证错误信息。

使用自定义错误处理器

Mongoose 提供了一个自定义错误处理器的机制,我们可以使用该机制来对 ValidationError 异常进行处理。具体来说,我们可以通过设置 mongoose.Error.messages 属性来自定义错误信息的格式。例如,我们可以将上面的代码修改为:

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

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

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

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

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

在上面的代码中,我们通过设置 mongoose.Error.messages 属性来自定义了验证错误信息的格式。具体来说,我们为 String 类型定义了一组错误信息的格式,包括 required、enum、match、minlength、maxlength 和 validate。这些格式中,PATH 代表字段的名称,VALUE 代表字段的值,MINLENGTH 和 MAXLENGTH 代表字段的最小长度和最大长度。

当我们在保存 User 对象时,如果 email 字段不符合要求,则会抛出 ValidationError 异常,其中包含了验证错误的详细信息。Mongoose 会根据我们定义的错误信息格式,将 ValidationError 异常转换为一个包含了所有错误信息的对象,并将其传递给 catch 块中的 err 参数。我们可以在 catch 块中对该对象进行处理,从而获取到所有的验证错误信息。

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

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

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

在上面的代码中,我们在 catch 块中对 err 对象进行了处理,从而获取到了所有的验证错误信息。具体来说,我们使用了 Object.values 方法将 err.errors 对象转换为一个数组,然后使用 map 方法将每个错误对象的 message 属性提取出来,最终得到了一个包含了所有错误信息的数组。我们可以将该数组输出到控制台上,从而查看所有的验证错误信息。

使用 async/await

除了使用自定义错误处理器外,我们还可以使用 ES2017 中的 async/await 语法来处理 Mongoose 中的验证错误信息。具体来说,我们可以将上面的代码修改为:

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

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

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

在上面的代码中,我们使用 async/await 语法来处理 Mongoose 中的验证错误信息。具体来说,我们将保存 User 对象的过程封装在一个名为 createUser 的异步函数中,并使用 try/catch 块来捕获可能抛出的 ValidationError 异常。如果保存成功,则输出 "User saved successfully!";如果保存失败,则提取出所有的验证错误信息,并输出到控制台上。

使用 async/await 语法能够让我们更加清晰地表达代码的逻辑,使代码更易于阅读和理解。同时,它也能够让我们更加方便地处理 Mongoose 中的验证错误信息,避免了使用 Promise 时可能出现的奇怪输出。

总结

本文介绍了 Mongoose 中遇到验证错误信息未能正确捕获的解决方法。具体来说,我们可以通过使用自定义错误处理器或 async/await 语法,来正确地捕获和处理 Mongoose 中的验证错误信息。这些技巧能够让我们更加高效地开发 Node.js 应用程序,提高代码的可读性和可维护性。

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

纠错
反馈