使用 Fastify 和 Mongoose 进行模型验证的最佳实践-JavaScript中文网-JavaScript教程资源分享门户

在现代 Web 开发中，数据验证是至关重要的一步。它可以确保我们的应用程序在处理用户输入时能够保持一致性和正确性。在前端开发中，我们通常使用表单验证来确保数据的有效性。但是，在后端开发中，我们需要更加严格的验证。本文将介绍如何使用 Fastify 和 Mongoose 进行模型验证的最佳实践。

快速入门

在开始本文之前，需要确保您已经安装了 Node.js 和 NPM。如果您还没有安装，请访问 Node.js 官网进行下载和安装。

首先，我们需要创建一个新的 Node.js 项目。在终端中输入以下命令：

mkdir fastify-mongoose-validation
cd fastify-mongoose-validation
npm init -y

接下来，我们需要安装 Fastify 和 Mongoose。在终端中输入以下命令：

npm install fastify mongoose --save

现在，我们已经准备好开始编写代码了。在项目根目录下创建一个 app.js 文件，并输入以下内容：

// javascriptcn.com 代码示例
const fastify = require('fastify')()
const mongoose = require('mongoose')

// 连接 MongoDB 数据库
mongoose.connect('mongodb://localhost/test', {
  useNewUrlParser: true,
  useUnifiedTopology: true,
  useCreateIndex: true,
  useFindAndModify: false
})

// 定义模型
const User = mongoose.model('User', {
  name: {
    type: String,
    required: true
  },
  email: {
    type: String,
    required: true,
    unique: true
  },
  age: {
    type: Number,
    required: true,
    min: 18
  }
})

// 创建用户
fastify.post('/users', async (request, reply) => {
  try {
    const user = new User(request.body)
    await user.save()
    reply.send(user)
  } catch (error) {
    reply.status(400).send(error)
  }
})

// 启动服务器
fastify.listen(3000, (error) => {
  if (error) {
    console.error(error)
    process.exit(1)
  }
  console.log('Server listening on port 3000')
})

在上面的代码中，我们首先连接了 MongoDB 数据库。然后，我们定义了一个名为 User 的模型，它有三个字段：name、email 和 age。其中，name 和 email 是必填字段，email 还必须是唯一的，age 必须大于等于 18。最后，我们创建了一个 /users 的路由，用于创建用户。如果用户创建成功，将返回用户对象；否则，将返回错误信息。

现在，我们已经完成了一个简单的 Fastify 和 Mongoose 应用程序。让我们来测试一下它是否正常工作。在终端中输入以下命令：

node app.js

然后，在浏览器或 Postman 中访问 http://localhost:3000/users，并发送一个 POST 请求，包含如下 JSON 数据：

{
  "name": "张三",
  "email": "zhangsan@example.com",
  "age": 20
}

如果一切顺利，您应该会收到如下响应：

{
  "_id": "60c2d1dcb5d5d5c7f8c9c9d7",
  "name": "张三",
  "email": "zhangsan@example.com",
  "age": 20,
  "__v": 0
}

模型验证

在上面的例子中，我们使用了 Mongoose 的内置验证器来验证模型的字段。但是，Mongoose 的内置验证器并不够灵活，不能满足我们所有的需求。因此，我们需要使用自定义验证器。

在 Mongoose 中，我们可以使用 Schema 的 validate 方法来添加自定义验证器。例如，以下代码将为 User 模型添加一个自定义验证器，用于验证密码是否符合规范：

// javascriptcn.com 代码示例
const UserSchema = new mongoose.Schema({
  name: {
    type: String,
    required: true
  },
  email: {
    type: String,
    required: true,
    unique: true
  },
  age: {
    type: Number,
    required: true,
    min: 18
  },
  password: {
    type: String,
    required: true,
    validate: {
      validator: function (value) {
        return /^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)[a-zA-Z\d]{8,}$/.test(value)
      },
      message: '密码必须包含大写字母、小写字母和数字，且长度至少为 8'
    }
  }
})

在上面的代码中，我们为 password 字段添加了一个自定义验证器。验证器使用正则表达式来验证密码是否符合规范。如果验证失败，将返回一个错误信息。

现在，我们已经了解了如何使用自定义验证器。但是，在实际开发中，我们可能需要更加复杂的验证逻辑。例如，我们需要验证某个字段是否存在于另一个表中，或者需要验证多个字段的组合是否唯一。这时，我们可以使用插件来扩展 Mongoose 的验证功能。

插件

Mongoose 的插件是一组预定义的模型方法和验证器。它们可以用于添加自定义验证逻辑，或者扩展模型的功能。以下是一些常用的 Mongoose 插件：

mongoose-unique-validator：用于验证唯一性约束。
mongoose-geojson-schema：用于处理地理位置数据。
mongoose-autopopulate：用于自动填充关联文档。

在本文中，我们将使用 mongoose-unique-validator 插件来验证唯一性约束。首先，我们需要安装该插件。在终端中输入以下命令：

npm install mongoose-unique-validator --save

然后，在 User 模型中添加以下代码：

// javascriptcn.com 代码示例
const uniqueValidator = require('mongoose-unique-validator')

const UserSchema = new mongoose.Schema({
  name: {
    type: String,
    required: true
  },
  email: {
    type: String,
    required: true,
    unique: true
  },
  age: {
    type: Number,
    required: true,
    min: 18
  }
})

UserSchema.plugin(uniqueValidator, {
  message: '{PATH} 必须唯一'
})

在上面的代码中，我们首先导入了 mongoose-unique-validator 插件。然后，我们为 UserSchema 添加了一个 unique 约束。最后，我们使用 UserSchema.plugin 方法来添加插件。插件的第二个参数是一个选项对象，其中的 message 字段用于指定错误消息模板。

现在，我们已经完成了 User 模型的唯一性约束验证。让我们来测试一下它是否正常工作。在浏览器或 Postman 中访问 http://localhost:3000/users，并发送一个 POST 请求，包含如下 JSON 数据：

{
  "name": "李四",
  "email": "zhangsan@example.com",
  "age": 20
}

注意，这里的 email 字段与之前创建的用户相同。如果一切顺利，您应该会收到如下错误信息：

// javascriptcn.com 代码示例
{
  "errors": {
    "email": {
      "message": "email 必须唯一",
      "name": "ValidatorError",
      "properties": {
        "message": "email 必须唯一",
        "type": "unique",
        "path": "email",
        "value": "zhangsan@example.com"
      },
      "kind": "unique",
      "path": "email",
      "value": "zhangsan@example.com"
    }
  },
  "_message": "User validation failed",
  "message": "User validation failed: email: email 必须唯一",
  "name": "ValidationError"
}

总结

在本文中，我们介绍了如何使用 Fastify 和 Mongoose 进行模型验证的最佳实践。我们首先创建了一个简单的 Fastify 和 Mongoose 应用程序，然后介绍了如何使用自定义验证器和插件来扩展 Mongoose 的验证功能。最后，我们使用 mongoose-unique-validator 插件来验证唯一性约束。希望本文能够对您有所帮助。

来源：JavaScript中文网，转载请注明来源本文地址：https://www.javascriptcn.com/post/657bc00dd2f5e1655d6679f3