Sequelize ORM 如何实现数据库和文件的联合存储

在前端开发中，我们经常需要将用户上传的文件存储到数据库中。而在实际的开发中，我们一般将文件存储在磁盘上，并在数据库中存储文件的信息（例如文件名、文件大小、文件类型等）。Sequelize 是 Node.js 中使用最广泛的 ORM 封装之一，它提供了非常方便的数据库功能。在本文中，我将介绍如何使用 Sequelize ORM 实现数据库和文件的联合存储，并给出详细的示例代码。

联合存储的需求

在实际的开发中，我们需要将用户上传的图片等媒体资源存储到数据库中。最常见的方法是将文件存储在磁盘上，并在数据库中存储文件的相关信息。但是，这种方法会导致以下问题：

• 磁盘上的文件可能会遗失或被删除，导致数据库中的数据损坏
• 在分布式环境下，多个服务器无法共享磁盘上的文件
• 对于大型文件，磁盘 IO 将成为系统瓶颈

为了解决这些问题，我们可以使用联合存储的方法。具体来说，我们将文件存储在对象存储等云服务中，并在数据库中存储文件在云服务中的地址以及其他相关信息。这样做有以下优点：

• 文件存储在云服务中，避免了文件丢失或被删除的问题
• 多个服务器均可访问云服务中的文件，避免了多个服务器间无法共享磁盘的问题
• 能够快速上传和下载大型文件，避免了磁盘 IO 的问题

在本文中，我们将使用 Sequelize ORM 实现数据库和文件的联合存储。

Sequelize ORM 简介

Sequelize 是一个使用 Promise 封装的 Node.js ORM。它支持 MySQL、PostgreSQL、SQLite 和 Microsoft SQL Server。Sequelize 的主要特点如下：

• 提供了易于使用和灵活的 API
• 支持事务、关联、范围查询等特性
• 使用 Promise 来管理异步操作，避免了回调地狱

如果你还不了解 Sequelize，请参考官方文档。下面我们将介绍如何使用 Sequelize 实现数据库和文件的联合存储。

实现联合存储

在 Sequelize 中，我们可以使用 blob 数据类型来存储二进制数据。但是，当文件较大时，使用 blob 数据类型会导致性能问题。因此，我们将使用云存储服务来存储文件，例如阿里云 OSS、腾讯云 COS、七牛云等。这里以阿里云 OSS 为例，介绍如何使用 Sequelize 实现联合存储。

1. 安装依赖

首先，我们需要安装 ali-oss、multer 和 uuid 等依赖。其中，ali-oss 是阿里云 OSS SDK，multer 可以实现文件上传，uuid 可以生成唯一的文件名。可以使用以下命令安装：

npm install ali-oss multer uuid

2. 配置阿里云 OSS 客户端

在阿里云 OSS 中，我们需要创建一个 Bucket，并配置好访问控制。具体来说，我们需要设置 Bucket 的读写权限。可以在 OSS 管理控制台中设置。然后，我们需要获取阿里云 OSS 的 AccessKey 和 SecretKey。在代码中，我们可以使用以下方法创建 OSS 客户端：

const ALY = require('aliyun-sdk');
const oss = new ALY.OSS({
  accessKeyId: '<Your AccessKeyId>',
  secretAccessKey: '<Your AccessKeySecret>',
  endpoint: '<Your endpoint>',
  apiVersion: '2013-10-15',
});

在创建 OSS 客户端时，需要传入 AccessKeyId、SecretAccessKey、Endpoint 和 API 版本。其中，Endpoint 是指 OSS 服务所在的地域的访问域名，具体可参考阿里云 OSS 官方文档。

3. 实现文件上传和删除

在服务器上，我们需要实现文件上传和删除的接口。这里，我们可以使用 multer 模块来实现文件上传。multer 可以将文件存储在临时目录中，并返回文件在磁盘上存储的路径。

为了避免文件名重复，我们可以使用 uuid 模块来生成唯一的文件名。具体来说，我们可以将文件名中的扩展名保留，并在文件名前添加一个 UUID。

上传文件完成后，我们可以使用阿里云 OSS SDK 将文件上传到阿里云 OSS 中。上传成功后，我们可以删除磁盘上的原文件。

最后，我们需要在数据库中存储文件信息，例如文件名、文件大小、文件类型、文件在阿里云 OSS 中的地址等。可以将这些信息作为一个 JSON 对象存储在数据库中。

以下是一个 Express 的上传文件的示例代码：

// javascriptcn.com 代码示例
const multer = require('multer');
const uuid = require('uuid/v4');

const storage = multer.diskStorage({
  destination(req, file, cb) {
    cb(null, '/tmp');
  },
  filename(req, file, cb) {
    const ext = file.originalname.split('.').pop();
    const filename = uuid();
    cb(null, `${filename}.${ext}`);
  }
});

const upload = multer({ storage });

// 上传文件的接口
app.post('/upload', upload.single('file'), async (req, res, next) => {
  try {
    // 将文件上传到阿里云 OSS 中
    const { buffer, mimetype } = req.file;
    const { name, size } = req.file.originalname;
    const filename = `${uuid()}.${mimetype.split('/').pop()}`;
    const result = await ctx.oss.put(filename, buffer);
    // 删除磁盘上的原文件
    await fs.unlink(req.file.path);
    // 在数据库中存储文件信息
    await File.create({
      name,
      size,
      type: mimetype,
      oss_key: result.name,
      url: result.url,
    });
    res.json({ success: true });
  } catch (err) {
    console.log(err);
    next(err);
  }
});

// 删除文件的接口
app.delete('/files/:id', async (req, res, next) => {
  try {
    const file = await File.findByPk(req.params.id);
    if (!file) {
      return res.status(404).json({ error: 'File not found' });
    }
    // 从阿里云 OSS 中删除文件
    await ctx.oss.delete(file.oss_key);
    // 从数据库中删除文件
    await file.destroy();
    res.json({ success: true });
  } catch (err) {
    console.log(err);
    next(err);
  }
});

4. 在模型中使用阿里云 OSS

在 Sequelize 中，我们可以通过定义 getter 和 setter，来让模型字段与阿里云 OSS 的文件 URL 自动同步。具体来说，我们可以通过 getter 和 setter，将模型字段与阿里云 OSS 上的文件 URL 进行映射。

以下是一个 File 模型的示例代码：

// javascriptcn.com 代码示例
const File = sequelize.define('file', {
  name: Sequelize.STRING,
  size: Sequelize.INTEGER,
  type: Sequelize.STRING,
  oss_key: Sequelize.STRING,
  url: Sequelize.STRING,

  // 使用 getter 和 setter，将 url 与阿里云 OSS 上的文件 URL 进行映射
  oss_url: {
    type: Sequelize.VIRTUAL,
    get() {
      if (this.oss_key) {
        return `https://${config.oss.bucket}.${config.oss.endpoint}/${this.oss_key}`;
      }
      return null;
    },
    set() {
      throw new Error('Cannot set oss_url');
    },
  },
});

在上面的示例代码中，我们使用了一个虚拟字段 oss_url，并在 getter 中返回文件在阿里云 OSS 中的 URL。在 setter 中，我们抛出了一个错误，以防止设置 oss_url。这样，我们就可以使用 File.oss_url 来获取与阿里云 OSS 同步的文件 URL 了。

5. 文件下载

在前端页面上，我们需要实现文件的下载功能。这里，我们可以使用如下的示例代码：

// javascriptcn.com 代码示例
const downloadFile = async (fileId) => {
  const res = await fetch(`/files/${fileId}`);
  const data = await res.json();
  if (!data.success) {
    throw new Error(data.error);
  }
  const { url } = data.file;
  const a = window.document.createElement('a');
  a.href = url;
  a.target = '_blank';
  window.document.body.appendChild(a);
  a.click();
  window.document.body.removeChild(a);
};

在上面的示例代码中，我们使用 fetch 方法向服务器发送请求，获取文件在阿里云 OSS 上的 URL。然后，我们创建一个 <a> 标签，并设置它的 href 属性为文件在阿里云 OSS 上的 URL。最后，我们触发 <a> 标签的 click 事件，实现了文件的下载。

总结

在本文中，我们介绍了如何使用 Sequelize ORM 实现数据库和文件的联合存储。具体来说，我们使用阿里云 OSS 来存储文件，并在数据库中存储文件的相关信息。通过这种方式，我们可以避免了磁盘 IO 的问题，同时也能够防止文件丢失或被删除的情况。此外，我们还使用了 multer 和 uuid 模块实现了上传和删除文件的功能，在模型中使用了 getter 和 setter 来自动同步文件 URL。

希望这篇文章能够帮助你理解如何使用 Sequelize ORM 实现数据库和文件的联合存储。如果你有任何问题或建议，请在评论区留言。

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