如何使用 Spring Data MongoDB 通过 GridFS ObjectId 获取二进制流

Question

当我已经拥有正确的 ObjectId 时，我无法弄清楚如何使用 spring-data-mongodb 及其 GridFSTemplate 从 GridFS 流式传输二进制文件。

GridFSTemplate 返回GridFSResource (getResource()) 或GridFSFile (findX())。

我可以通过 ID 获得GridFSFile：

// no way to get the InputStream?
GridFSFile file = gridFsTemplate.findOne(Query.query(Criteria.where("_id").is(id)))

但没有明显的方法可以为该GridFSFile 获取InputStream。

只有GridFSResource 允许我获取对应的InputStream 和InputStreamResource#getInputstream。但获得GridFSResource 的唯一方法是通过filename。

// no way to get GridFSResource by ID?
GridFSResource resource = gridFsTemplate.getResource("test.jpeg");
return resource.getInputStream();

不知何故，GridFsTemplate API 暗示文件名是唯一的——它们不是。 GridFsTemplate 实现只返回第一个元素。

现在我正在使用本机 MongoDB API，一切都变得有意义了：

GridFS gridFs = new GridFs(mongo);
GridFSDBFile nativeFile = gridFs.find(blobId);
return nativeFile.getInputStream();

看起来我误解了 Spring Data Mongo GridFS 抽象背后的基本概念。我希望（至少）以下事情之一是可能的/真实的：

• 通过其 ID 获取 GridFSResource
• 获取GridFSResource 或InputStream 以获得GridFsFile 我已经拥有了

我错了还是 Spring Data MongoDB API 的这个特定部分有什么奇怪的地方？

Answer 1

我也偶然发现了这一点。事实上，GridFsTemplate 的设计是这样的，这让我感到非常震惊...... 无论如何，到目前为止，我对此的丑陋“解决方案”：

public GridFsResource download(String fileId) {
    GridFSFile file = gridFsTemplate.findOne(Query.query(Criteria.where("_id").is(fileId)));

    return new GridFsResource(file, getGridFs().openDownloadStream(file.getObjectId()));
}

private GridFSBucket getGridFs() {

    MongoDatabase db = mongoDbFactory.getDb();
    return GridFSBuckets.create(db);
}

注意：您必须注入 MongoDbFactory 才能使其工作...

Answer 2

这些类型有点乱：

• GridFSFile 是来自 MongoDB 驱动程序的类型
• GridFsResource 是 Spring 的类型
• ObjectId 是来自 BSON API 的类型

来自 Spring GridFsTemplate source：

public getResource(String location) {

    GridFSFile file = findOne(query(whereFilename().is(location)));
    return file != null ? new GridFsResource(file, getGridFs().openDownloadStream(location)) : null;
}

有一个丑陋的解决方案：

@Autowired
private GridFsTemplate template;

@Autowired
private GridFsOperations operations;

public InputStream loadResource(ObjectId id) throws IOException {
    GridFSFile file = template.findOne(query(where("_id").is(id)));
    GridFsResource resource = template.getResource(file.getFilename());

    GridFSFile file = operations.findOne(query(where("_id").is(id)));
    GridFsResource resource = operations.getResource(file.getFilename());
    return resource.getInputStream();
}

Answer 3

我发现了解决这个问题的方法！

只需将 GridFSFile 包装在 GridFsResource 中！这是为使用 GridFSFile 实例化而设计的。

public GridFsResource getUploadedFileResource(String id) {
    var file = this.gridFsTemplate.findOne(new Query(Criteria.where("_id").is(id)));
    return new GridFsResource(file);
}

@GetMapping("/{userId}/files/{id}")
public ResponseEntity<InputStreamResource> getUploadedFile(
    @PathVariable Long userId,
    @PathVariable String id
){
    var user = userService
        .getCurrentUser()
        .orElseThrow(EntityNotFoundException::new);

    var resource = userService.getUploadedFileResource(id);

    try {
        return ResponseEntity
            .ok()
            .contentType(MediaType.parseMediaType(resource.getContentType()))
            .contentLength(resource.contentLength())
            .body(resource);
    } catch (IOException e) {
        return new ResponseEntity<>(HttpStatus.INTERNAL_SERVER_ERROR);
    }


}

这样做的最大优点是，您可以直接将 GridFsResource 传递给 ResponseEntity，因为 GridFsResource 扩展了 InputStreamResource。

希望这会有所帮助！

问候 尼克拉斯

Answer 4

您是否考虑过使用 Spring Content for Mongo 作为您解决方案中的内容存储部分？

假设您使用的是 Spring Boot 以及 Spring Data Mongo，那么它可能如下所示：

pom.xml

<dependency>
    <groupId>com.github.paulcwarren</groupId>
    <artifactId>spring-content-mongo-boot-starter</artifactId>
    <version>0.0.10</version>
</dependency>
<dependency>
    <groupId>com.github.paulcwarren</groupId>
    <artifactId>spring-content-rest-boot-starter</artifactId>
    <version>0.0.10</version>
</dependency>

使用以下属性更新您的 Spring Data Mongo 实体：

@ContentId
private String contentId;

@ContentLength 
private long contentLength = 0L;

@MimeType
private String mimeType;

添加商店界面：

@StoreRestResource(path="content")
public interface MongoContentStore extends ContentStore<YourEntity, String> {
}

这就是你所需要的。当您的应用程序启动时，Spring Content 将看到 Spring Content Mongo/REST 模块的依赖关系，它将为 GridFs 注入 MongonContenStore 存储的实现以及支持完整 CRUD 功能并将这些操作映射下来的控制器的实现到底层商店界面。 REST 端点将在/content 下可用。

即

curl -X PUT /content/{entityId} 将创建或更新实体的图像

curl -X GET /content/{entityId} 将获取实体的图像

curl -X DELETE /content/{entityId} 将删除实体的图像

有一些入门指南here。他们将 Spring Content 用于文件系统，但模块是可互换的。 Mongo 参考指南是here。还有教程视频here。

HTH

Answer 5

将 GridFSFile 包装在 GridFsResource 中或使用它

GridFSFile file = gridFsTemplate.findOne(Query.query(Criteria.where("_id").is(fileId)));
GridFsResource resource = gridFsTemplate.getResource(file);
return resource.getInputStream();

Answer 6

GridFsTemplate 的getResource(com.mongodb.client.gridfs.model.GridFSFile file) 函数返回GridFSFile 的GridFsResource。

GridFSFile gridfsFile= gridFsTemplate.findOne(new 
Query(Criteria.where("filename").is(fileName)));
GridFsResource gridFSResource= gridFsTemplate.getResource(gridfsFile);
InputStream inputStream= gridFSResource.getInputStream();

如果上述方法在某些更高版本的 Spring boot 中不起作用，请使用以下方法：

GridFSFile gridfsFile= gridFsTemplate.findOne(new 
Query(Criteria.where("filename").is(fileName)));
//or
GridFSFile  gridfsFile = 
gridFsOperations.findOne(Query.query(Criteria.where("filename").is(fileName)));
 return ResponseEntity.ok()
                .contentLength(gridFsdbFile.getLength())
                .contentType(MediaType.valueOf("image/png"))
                .body(gridFsOperations.getResource(gridFsdbFile));

Answer 7

@RequestMapping(value = "/api ")
public class AttachmentController {

private final GridFsOperations gridFsOperations;

@Autowired
public AttachmentController(GridFsOperations gridFsOperations) {
    this.gridFsOperations = gridFsOperations;
}

@GetMapping("/file/{fileId}")
public ResponseEntity<Resource> getFile(@PathVariable String fileId) {
GridFSFile file = 
gridFsOperations.findOne(Query.query(Criteria.where("_id").is(fileId)));

    return ResponseEntity.ok()
            .contentLength(file.getLength())
            .body(gridFsOperations.getResource(file));
}

Answer 8

我知道的老问题，但尝试在 2019 年使用 WebFlux 执行此操作，我必须执行以下操作

  public Mono<GridFsResource> getImageFromDatabase(final String id) {

    return Mono.fromCallable(
        () ->
            this.gridFsTemplate.getResource(
                Objects.requireNonNull(
                        this.gridFsTemplate.findOne(new Query(Criteria.where("_id").is(id))))
                    .getFilename()));
  }

这会给你一个Mono，它可以在控制器中返回。不过，我确信有更好的解决方案。

Answer 9

Spring Data 2.1.0 向GridFsTemplate 添加了getResource() 的重载，它返回给定GridFsFile 的GridFsResource。 GridFsResource 有一个获取InputStream 的方法。因此，如果您至少使用此版本的 Spring Data，则可以通过两次调用 GridFsTemplate 来获取 InputStream：

GridFSFile file = gridFsTemplate.findOne(Query.query(Criteria.where("_id").is(id)));

// In real code, make sure you perform any necessary null checks if the file doesn't exist

GridFsResource resource = gridFsTemplate.getResource(gridFsFile);
InputStream inputStream = resource.getInputStream();

Answer 10

GridFSDBFile file = ... 
ByteArrayOutputStream baos = new ByteArrayOutputStream();
file.writeTo(baos);
byte[] ba = baos.toByteArray()