响应式 Elasticsearch 仓库
响应式 Elasticsearch 仓库支持基于 仓库 中解释的核心仓库支持构建,利用 响应式 Elasticsearch 操作 提供的操作,由 响应式 REST 客户端 执行。
Spring Data Elasticsearch 响应式仓库支持使用 Project Reactor 作为其首选的响应式组合库。
有 3 个主要接口可供使用
-
ReactiveRepository
-
ReactiveCrudRepository
-
ReactiveSortingRepository
用法
要使用 Repository
访问存储在 Elasticsearch 中的域对象,只需为其创建一个接口。在您实际执行此操作之前,您需要一个实体。
示例 1. 示例
Person
实体public class Person {
@Id
private String id;
private String firstname;
private String lastname;
private Address address;
// … getters and setters omitted
}
请注意,id 属性需要是 String 类型。 |
示例 2. 用于持久化 Person 实体的基本仓库接口
interface ReactivePersonRepository extends ReactiveSortingRepository<Person, String> {
Flux<Person> findByFirstname(String firstname); (1)
Flux<Person> findByFirstname(Publisher<String> firstname); (2)
Flux<Person> findByFirstnameOrderByLastname(String firstname); (3)
Flux<Person> findByFirstname(String firstname, Sort sort); (4)
Flux<Person> findByFirstname(String firstname, Pageable page); (5)
Mono<Person> findByFirstnameAndLastname(String firstname, String lastname); (6)
Mono<Person> findFirstByLastname(String lastname); (7)
@Query("{ \"bool\" : { \"must\" : { \"term\" : { \"lastname\" : \"?0\" } } } }")
Flux<Person> findByLastname(String lastname); (8)
Mono<Long> countByFirstname(String firstname) (9)
Mono<Boolean> existsByFirstname(String firstname) (10)
Mono<Long> deleteByFirstname(String firstname) (11)
}
1 | 该方法展示了查询所有给定 lastname 的人的方法。 |
2 | 等待来自 Publisher 的输入以绑定 firstname 参数值的查找方法。 |
3 | 根据 lastname 对匹配文档进行排序的查找方法。 |
4 | 根据通过 Sort 参数定义的表达式对匹配文档进行排序的查找方法。 |
5 | 使用 Pageable 向数据库传递偏移量和排序参数。 |
6 | 使用 And / Or 关键词连接条件的查找方法。 |
7 | 查找第一个匹配的实体。 |
8 | 该方法展示了通过运行带有给定参数的注解 @Query 来查找所有给定 lastname 的人的查询。 |
9 | 计算所有匹配 firstname 的实体数量。 |
10 | 检查是否存在至少一个匹配 firstname 的实体。 |
11 | 删除所有匹配 firstname 的实体。 |
配置
对于 Java 配置,使用 @EnableReactiveElasticsearchRepositories
注解。如果未配置基本包,基础设施将扫描注解配置类的包。
以下清单展示了如何使用 Java 配置进行仓库配置
示例 3. 仓库的 Java 配置
@Configuration
@EnableReactiveElasticsearchRepositories
public class Config extends AbstractReactiveElasticsearchConfiguration {
@Override
public ReactiveElasticsearchClient reactiveElasticsearchClient() {
return ReactiveRestClients.create(ClientConfiguration.localhost());
}
}
由于前一个示例中的仓库扩展了 ReactiveSortingRepository
,因此所有 CRUD 操作以及对实体进行排序访问的方法都可用。使用仓库实例只需将其依赖注入到客户端中,如下例所示
示例 4. 对 Person 实体的排序访问
public class PersonRepositoryTests {
@Autowired ReactivePersonRepository repository;
@Test
public void sortsElementsCorrectly() {
Flux<Person> persons = repository.findAll(Sort.by(new Order(ASC, "lastname")));
// ...
}
}