如何在 Sequelize 中使用自定义字段名？

在 Sequelize 中，我们可以使用默认的字段名来映射数据库中的列名。但是，当我们需要使用自定义的列名时，该怎么处理呢？本文将详细介绍如何使用 Sequelize 中的自定义字段名。

什么是 Sequelize？

Sequelize 是一个流行的 Node.js ORM 库，用于与各种 SQL 数据库协作。Sequelize 具有强大的模型定义功能，并提供了丰富的数据类型支持，以供应用进行数据库操作。

自定义字段名的需求

默认情况下，在 Sequelize 中，字段名会与数据库表中的列名一一对应。但是，实际开发中，我们可能会遇到以下需求：

1. 数据库表中的列名需要使用一些与编程语言不同的命名方式；
2. 维护不同版本之间的兼容性，需要保证数据库表和应用程序代码中的命名方式一致；

这时，我们需要使用 Sequelize 中提供的自定义字段名功能。

使用 Sequelize 自定义字段名有两种方式，分别是通过 field 属性和 column 属性。

使用 field 属性

field 属性可以在模型定义中指定每个字段的名称，如下所示：

// javascriptcn.com 代码示例
const User = sequelize.define('user', {
  firstName: {
    type: DataTypes.STRING,
    field: 'first_name'
  },
  lastName: {
    type: DataTypes.STRING,
    field: 'last_name'
  }
});

在上面的例子中，我们将模型的 firstName 和 lastName 字段与数据库表中的 first_name 和 last_name 列相对应。

使用 column 属性

column 属性可以在查询时指定列的名称。例如，我们可以使用以下代码在查询用户时指定列名：

const users = await User.findAll({
  attributes: [
    ['first_name', 'firstName'],
    ['last_name', 'lastName']
  ]
});

在上面的例子中，我们使用了 findAll 方法来查询用户，同时使用 attributes 属性来指定需要返回的列。在这个属性的值中，我们可以使用一个包含两个元素的数组来指定列名。第一个元素是列名，第二个元素是我们想要使用的名称，即在模型定义中定义的名称。

案例演示

// javascriptcn.com 代码示例
const { Sequelize, Model, DataTypes } = require('sequelize');
const sequelize = new Sequelize({
  dialect: 'sqlite',
  storage: 'test.db'
});

class User extends Model {}
User.init({
  firstName: {
    type: DataTypes.STRING,
    field: 'first_name'
  },
  lastName: {
    type: DataTypes.STRING,
    field: 'last_name'
  }
}, { sequelize, modelName: 'user' });

(async function() {
  await sequelize.sync({ force: true });

  await User.create({
    firstName: 'John',
    lastName: 'Doe'
  });

  const users = await User.findAll({
    attributes: [
      ['first_name', 'firstName'],
      ['last_name', 'lastName']
    ]
  });
  
  console.log(users);

  await sequelize.close();
})();

在上面的例子中，我们定义了一个名为 User 的模型，并指定了 firstName 和 lastName 字段的自定义名称。我们在 createdAt 和 updatedAt 字段上没有使用自定义名称，因此它们使用默认的名称。

在调用 findAll 方法时，我们使用了 attributes 属性指定了需要返回的列名称。在这个属性的值中，我们使用一个包含两个元素的数组来指定列名。第一个元素是列名，第二个元素是我们想要使用的名称，即在模型定义中定义的名称。输出结果如下：

// javascriptcn.com 代码示例
[
  {
    firstName: 'John',
    lastName: 'Doe',
    createdAt: 2022-01-17T03:32:11.738Z,
    updatedAt: 2022-01-17T03:32:11.738Z,
    id: 1
  }
]

总结

在本文中，我们介绍了 Sequelize 中如何使用自定义字段名。对于那些需要使用不同命名方式的场景，使用自定义字段名可以方便地解决问题。使用 field 属性和 column 属性都可以实现自定义字段名。我们在实践中可以选择最适合场景的方式。希望本文能为读者提供实用的知识和指导。

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