MongoDB Node.js 驱动中的 GridFS 使用指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00903/article/details/148416196

MongoDB Node.js 驱动中的 GridFS 使用指南

node-mongodb-native The Official MongoDB Node.js Driver 项目地址: https://gitcode.com/gh_mirrors/no/node-mongodb-native

什么是 GridFS？

GridFS 是 MongoDB 提供的一种用于存储和检索大型文件的规范。由于 MongoDB 单个文档大小限制为 16MB，当需要存储超过这个限制的文件时，GridFS 就派上用场了。GridFS 会自动将大文件分割成多个小块（chunks）存储，并在读取时重新组合。

在 Node.js MongoDB 驱动中，GridStore 类提供了对 GridFS 文件的操作接口。

GridStore 基本操作

1. 创建和打开 GridStore

要操作 GridFS 中的文件，首先需要创建 GridStore 实例：

var mongodb = require('mongodb');
var gs = new mongodb.GridStore(db, filename, mode[, options]);

参数说明：

db: 数据库连接对象
filename: 文件名
mode: 操作模式
- "r": 只读模式
- "w": 写入模式（会覆盖已有文件）
- "w+": 追加模式
options: 可选参数，可设置：
- content_type: 文件类型（如 "image/png"）
- metadata: 元数据
- chunk_size: 分块大小（默认 255KB）

示例：

var gs = new mongodb.GridStore(db, "sample.pdf", "w", {
  content_type: "application/pdf",
  metadata: { author: "张三" }
});

创建后需要调用 open 方法打开：

gs.open(function(err, gs) {
  if(err) throw err;
  // 文件已打开，可以操作
});

2. 写入数据

写入数据有两种方式：

直接写入数据

gs.write(data, function(err, result) {
  // 回调处理
});

data 可以是 Buffer 或字符串。

写入整个文件

gs.writeFile(filePath, function(err, gs) {
  // 回调处理
});

filePath 可以是文件路径或文件描述符。

3. 读取数据

读取数据使用 read 方法：

gs.read([size], function(err, data) {
  // data 是二进制数据
});

size 参数可选，指定要读取的字节数。

4. 流式操作

对于大文件，可以使用流式处理：

var stream = gs.stream();
stream.on('data', function(chunk) {
  // 处理数据块
});
stream.on('end', function() {
  // 读取完成
});

5. 文件管理

检查文件是否存在

mongodb.GridStore.exist(db, filename, function(err, result) {
  // result 为布尔值
});

删除文件

mongodb.GridStore.unlink(db, filename, function(err, result) {
  // 回调处理
});

可以传入数组删除多个文件。

关闭 GridStore

操作完成后必须关闭：

gs.close(function(err, result) {
  // 回调处理
});

实际应用示例

上传文件到 GridFS

var fs = require('fs');
var mongodb = require('mongodb');

// 连接数据库
mongodb.MongoClient.connect('mongodb://localhost:27017/test', function(err, db) {
  if(err) throw err;
  
  // 创建 GridStore
  var gs = new mongodb.GridStore(db, 'uploaded_file.txt', 'w');
  
  // 打开并写入文件
  gs.open(function(err, gs) {
    if(err) throw err;
    
    // 读取本地文件并写入 GridFS
    var fileStream = fs.createReadStream('./local_file.txt');
    fileStream.pipe(gs.stream());
    
    fileStream.on('end', function() {
      gs.close(function(err) {
        if(err) throw err;
        console.log('文件上传完成');
        db.close();
      });
    });
  });
});

从 GridFS 下载文件

var fs = require('fs');
var mongodb = require('mongodb');

mongodb.MongoClient.connect('mongodb://localhost:27017/test', function(err, db) {
  if(err) throw err;
  
  // 以只读模式打开文件
  mongodb.GridStore.read(db, 'uploaded_file.txt', function(err, fileData) {
    if(err) throw err;
    
    // 将文件写入本地
    fs.writeFile('./downloaded_file.txt', fileData, function(err) {
      if(err) throw err;
      console.log('文件下载完成');
      db.close();
    });
  });
});