MongoDB 自定义（用户友好的）验证器错误消息

在本文中，我们将介绍如何在 MongoDB 中自定义验证器错误消息，以提供更好的用户体验和错误处理。

MongoDB 验证器

MongoDB 是一种流行的 NoSQL 数据库，它支持各种数据类型和验证器以确保数据的完整性和一致性。验证器可以在插入或更新文档时对字段的值进行验证，如果值不符合指定的规则，就会触发验证器错误。

MongoDB 内置了一些常用的验证器，如 $gt（大于）、$ lt（小于）、$in（包含）等。通过使用这些验证器，可以检查字段的值是否满足特定的条件。但是，默认情况下，当验证失败时，MongoDB 只返回一个通用的错误消息，无法提供具体的错误原因和位置信息。

为了提供更好的错误处理和用户体验，我们可以自定义验证器错误消息。

自定义验证器错误消息

在 MongoDB 中，可以通过 validate() 方法和 $jsonSchema 来定义文档的验证规则，并使用 validatorError 错误条件来捕获验证器错误。我们可以使用自定义的验证错误消息来替换默认的错误消息。

下面是一个示例，展示了如何定义自定义验证器错误消息：

db.createCollection("users", {
   validator: {
      $jsonSchema: {
         bsonType: "object",
         required: ["name"],
         properties: {
            name: {
               bsonType: "string",
               description: "必须是字符串类型"
            },
            age: {
               bsonType: "int",
               description: "必须是整数类型"
            }
         }
      }
   },
   validationAction: "error"
})

在上面的示例中，我们创建了一个名为 “users” 的集合，并定义了一个验证器。该验证器要求文档必须具有一个名为 “name” 的字符串类型字段，并且也可以包含一个名为 “age” 的整数类型字段。

使用 “description” 属性，我们为每个字段指定了自定义的错误消息。当验证失败时，将会返回这些自定义的错误消息，从而提供更友好和具体的错误信息。

示例说明

假设我们向 “users” 集合插入一个名为 “John” 的文档，但是没有提供 “age” 字段，那么验证将会失败，并返回以下错误消息：

{
   "ok" : 0,
   "errmsg" : "Document failed validation",
   "code" : 121,
   "codeName" : "ValidationFailed",
   "result" : {
      "errorLabels" : [ "TransientTransactionError" ],
      "validationErrors" : [
         {
            "field" : "name",
            "message" : "必须是字符串类型"
         },
         {
            "field" : "age",
            "message" : "必须是整数类型"
         }
      ]
   }
}

从上述错误消息中，我们可以清楚地看到具体的错误原因和位置信息。这对于开发人员和终端用户来说都是非常有价值的，因为他们可以快速定位和修复问题。