对于最新的稳定版本,请使用 Spring Data MongoDB 4.4.0! |
GridFS 支持
MongoDB 支持将二进制文件存储在其文件系统 GridFS 中。
Spring Data MongoDB 提供了 GridFsOperations
和 ReactiveGridFsOperations
接口以及相应的实现和 ,以便您与文件系统进行交互。
您可以通过向其提供 / 和 模板实例来设置模板实例,如下例所示:GridFsTemplate
ReactiveGridFsTemplate
MongoDatabaseFactory
ReactiveMongoDatabaseFactory
MongoConverter
-
Imperative
-
Reactive
-
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>
现在可以注入模板并用于执行存储和检索操作,如下例所示:
-
Imperative
-
Reactive
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
MongoConverter
GridFsTemplate
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>
MongoConverter
ReactiveGridFsTemplate
Document
MongoDB 的驱动程序使用 和 接口来交换二进制流。
Spring Data MongoDB 将这些接口适应 。
在 Spring 的参考文档中阅读更多内容。AsyncInputStream
AsyncOutputStream
Publisher<DataBuffer>
DataBuffer
您可以通过 或 方法从文件系统中读取文件。
我们先来看看这些方法。
您可以找到单个文件,也可以找到多个与 .
您可以使用 helper 类来定义查询。
它提供静态工厂方法来封装默认元数据字段(如 和 )或通过自定义元数据字段。
以下示例演示如何使用模板查询文件:find(…)
getResources(…)
find(…)
Query
GridFsCriteria
whereFilename()
whereContentType()
whereMetaData()
-
Imperative
-
Reactive
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 检索文件时定义排序条件。因此,将忽略在移交给方法的实例上定义的任何排序标准。Query find(…) |
从 GridFs 读取文件的另一个选项是使用接口引入的方法。
它们允许将 Ant 路径传递到方法中,因此可以检索与给定模式匹配的文件。
以下示例演示如何使用 读取文件:ResourcePatternResolver
GridFsTemplate
-
Imperative
-
Reactive
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
扩展并允许(例如)将要插入到一个中,以便从 MongoDB 数据库中读取 Spring Config 文件。ResourcePatternResolver
GridFsTemplate
ApplicationContext
默认情况下,在第一次 GridFS 交互时获取一次。
之后,模板实例将重用缓存的存储桶。
要使用不同的存储桶,请从同一 Template 实例使用构造函数 accept 。GridFsTemplate GridFSBucket Supplier<GridFSBucket> |