Mongoose 模型 schema 的 underscored 属性解释-JavaScript中文网-JavaScript教程资源分享门户

在使用 Mongoose 进行 Node.js 后端开发时，Mongoose 模型 schema 是不可或缺的一部分。其中，有一个 underscored 属性，它可以对模型的字段进行下划线转换，从而方便数据库的操作。本文将详细介绍 underscored 属性的含义、使用方法和注意事项，以及如何在实际开发中使用它。

什么是 underscored 属性

underscored 属性是 Mongoose 模型 schema 中的一个选项，它用于控制模型的字段名是否进行下划线转换。当 underscored 属性设置为 true 时，模型中的字段名将会被转换为下划线格式，例如：

// javascriptcn.com 代码示例
const userSchema = new mongoose.Schema({
  firstName: String,
  lastName: String,
}, {
  underscored: true,
});

// 转换后的字段名
// {
//   first_name: String,
//   last_name: String,
// }

这样，在数据库中存储时，字段名就会变成下划线格式。这样做的好处是可以更好地与其他数据库进行兼容，例如 PostgreSQL 和 MySQL 等数据库都采用下划线格式的字段名。

如何使用 underscored 属性

在 Mongoose 模型 schema 中使用 underscored 属性非常简单，只需要在创建 schema 时将 underscored 属性设置为 true 即可：

const userSchema = new mongoose.Schema({
  firstName: String,
  lastName: String,
}, {
  underscored: true,
});

在这个例子中，我们创建了一个名为 userSchema 的 schema，其中包含 firstName 和 lastName 两个字段。由于 underscored 属性设置为 true，所以这两个字段的名称会被转换为 first_name 和 last_name。

注意事项

在使用 underscored 属性时，需要注意以下几点：

underscored 属性只会在模型的字段名上起作用，而不会影响模型的方法或属性名。
如果模型的字段名本身已经是下划线格式，那么 underscored 属性将不会再次对其进行转换。
如果在查询数据库时使用了原始的字段名，而不是转换后的字段名，那么查询将会失败。

实际应用

下面是一个使用 underscored 属性的实际应用例子，我们将创建一个名为 User 的模型，其中包含 firstName 和 lastName 两个字段：

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

const userSchema = new Schema({
  firstName: String,
  lastName: String,
}, {
  underscored: true,
});

const User = mongoose.model('User', userSchema);

module.exports = User;

在这个例子中，我们创建了一个名为 User 的模型，其中包含 firstName 和 lastName 两个字段。由于 underscored 属性设置为 true，所以这两个字段的名称会被转换为 first_name 和 last_name。

接下来，我们可以使用以下代码来创建一个新的用户并将其保存到数据库中：

// javascriptcn.com 代码示例
const User = require('./models/user');

const newUser = new User({
  firstName: 'John',
  lastName: 'Doe',
});

newUser.save((err, user) => {
  if (err) {
    console.error(err);
  } else {
    console.log(user);
  }
});

在保存用户时，Mongoose 会将 firstName 和 lastName 转换为 first_name 和 last_name，并将它们保存到数据库中。

当我们从数据库中查询用户时，也需要使用转换后的字段名，例如：

User.findOne({ first_name: 'John' }, (err, user) => {
  if (err) {
    console.error(err);
  } else {
    console.log(user);
  }
});

在这个例子中，我们使用了转换后的字段名 first_name 来查询用户。如果我们使用原始的字段名 firstName 来查询，那么查询将会失败。

总结

在使用 Mongoose 进行 Node.js 后端开发时，underscored 属性是一个非常有用的选项。它可以帮助我们更好地与其他数据库进行兼容，并且可以使模型的字段名更加易读。在使用 underscored 属性时，需要注意转换后的字段名，并且需要使用转换后的字段名来查询数据库。

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