GridFS 支持

MongoDB 支持在其文件系统 GridFS 中存储二进制文件。Spring Data MongoDB 提供了 GridFsOperationsReactiveGridFsOperations 接口以及相应的实现 GridFsTemplateReactiveGridFsTemplate,让您与文件系统进行交互。您可以通过传递 MongoDatabaseFactory/ReactiveMongoDatabaseFactoryMongoConverter 来设置模板实例,如下例所示

  • 命令式

  • 响应式

  • XML

class GridFsConfiguration extends AbstractMongoClientConfiguration {

  // … further configuration omitted

  @Bean
  public GridFsTemplate gridFsTemplate() {
    return new GridFsTemplate(mongoDbFactory(), mappingMongoConverter());
  }
}
class ReactiveGridFsConfiguration extends AbstractReactiveMongoConfiguration {

  // … further configuration omitted

  @Bean
  public ReactiveGridFsTemplate reactiveGridFsTemplate() {
    return new ReactiveGridFsTemplate(reactiveMongoDbFactory(), mappingMongoConverter());
  }
}
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:mongo="http://www.springframework.org/schema/data/mongo"
xsi:schemaLocation="http://www.springframework.org/schema/data/mongo
https://www.springframework.org/schema/data/mongo/spring-mongo.xsd
http://www.springframework.org/schema/beans
https://www.springframework.org/schema/beans/spring-beans.xsd">

  <mongo:db-factory id="mongoDbFactory" dbname="database" />
  <mongo:mapping-converter id="converter" />

  <bean class="org.springframework.data.mongodb.gridfs.GridFsTemplate">
    <constructor-arg ref="mongoDbFactory" />
    <constructor-arg ref="converter" />
  </bean>

</beans>

现在可以注入模板并使用它来执行存储和检索操作,如下例所示

使用 GridFS 存储文件
  • 命令式

  • 响应式

class GridFsClient {

  @Autowired
  GridFsOperations operations;

  @Test
  public void storeFileToGridFs() {

    FileMetadata metadata = new FileMetadata();
    // populate metadata
    Resource file = … // lookup File or Resource

    operations.store(file.getInputStream(), "filename.txt", metadata);
  }
}

store(…) 操作接受一个 InputStream、一个文件名以及(可选)有关要存储文件的元数据信息。元数据可以是任意对象,它将由配置了 GridFsTemplateMongoConverter 进行编组。或者,您也可以提供一个 Document

class ReactiveGridFsClient {

  @Autowired
  ReactiveGridFsTemplate operations;

  @Test
  public Mono<ObjectId> storeFileToGridFs() {

    FileMetadata metadata = new FileMetadata();
    // populate metadata
    Publisher<DataBuffer> file = … // lookup File or Resource

    return operations.store(file, "filename.txt", metadata);
  }
}

store(…) 操作接受一个 Publisher<DataBuffer>、一个文件名以及(可选)有关要存储文件的元数据信息。元数据可以是任意对象,它将由配置了 ReactiveGridFsTemplateMongoConverter 进行编组。或者,您也可以提供一个 Document

MongoDB 的驱动程序使用 AsyncInputStreamAsyncOutputStream 接口来交换二进制流。Spring Data MongoDB 将这些接口适配到 Publisher<DataBuffer>。有关 DataBuffer 的更多信息,请参阅 Spring 的参考文档

您可以通过 find(…)getResources(…) 方法从文件系统读取文件。让我们先看看 find(…) 方法。您可以找到单个文件或匹配 Query 的多个文件。您可以使用 GridFsCriteria 帮助程序类来定义查询。它提供静态工厂方法来封装默认元数据字段(例如 whereFilename()whereContentType())或通过 whereMetaData() 自定义元数据字段。以下示例展示了如何使用模板查询文件

使用 GridFsTemplate 查询文件
  • 命令式

  • 响应式

class GridFsClient {

  @Autowired
  GridFsOperations operations;

  @Test
  public void findFilesInGridFs() {
    GridFSFindIterable result = operations.find(query(whereFilename().is("filename.txt")));
  }
}
class ReactiveGridFsClient {

  @Autowired
  ReactiveGridFsTemplate operations;

  @Test
  public Flux<GridFSFile> findFilesInGridFs() {
    return operations.find(query(whereFilename().is("filename.txt")))
  }
}
目前,MongoDB 不支持在从 GridFS 检索文件时定义排序条件。因此,传递给 find(…) 方法的 Query 实例上定义的任何排序条件都会被忽略。

从 GridFs 读取文件的另一种选择是使用 ResourcePatternResolver 接口引入的方法。它们允许将 Ant 路径传递给方法,因此可以检索与给定模式匹配的文件。以下示例展示了如何使用 GridFsTemplate 读取文件

使用 GridFsTemplate 读取文件
  • 命令式

  • 响应式

class GridFsClient {

  @Autowired
  GridFsOperations operations;

  public GridFsResources[] readFilesFromGridFs() {
     return operations.getResources("*.txt");
  }
}
class ReactiveGridFsClient {

  @Autowired
  ReactiveGridFsOperations operations;

  public Flux<ReactiveGridFsResource> readFilesFromGridFs() {
     return operations.getResources("*.txt");
  }
}

GridFsOperations 扩展了 ResourcePatternResolver,并允许将 GridFsTemplate(例如)插入 ApplicationContext 以从 MongoDB 数据库读取 Spring 配置文件。

默认情况下,GridFsTemplate 在第一次与 GridFS 交互时获取 GridFSBucket。之后,模板实例会重用缓存的桶。要使用来自同一模板实例的不同桶,请使用接受 Supplier<GridFSBucket> 的构造函数。