对于最新的稳定版本,请使用 Spring Data Elasticsearch 5.4.0! |
反应式 Elasticsearch 存储库
反应式 Elasticsearch 存储库支持建立在存储库利用通过反应式 REST 客户端执行的反应式 Elasticsearch作提供的作中解释的核心存储库支持之上。
Spring Data Elasticsearch 反应式存储库支持使用 Project Reactor 作为其选择的反应式组合库。
有 3 个主要接口可供使用:
-
ReactiveRepository
-
ReactiveCrudRepository
-
ReactiveSortingRepository
用法
要使用Repository
,只需为其创建一个接口即可。
在你真正继续做这件事之前,你需要一个实体。
示例 1.样本
Person
实体public class Person {
@Id
private String id;
private String firstname;
private String lastname;
private Address address;
// … getters and setters omitted
}
请注意,id property 的类型需要为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 | 等待输入的 Finder 方法Publisher 绑定 的参数值firstname . |
3 | Finder 方法按以下方式对匹配文档进行排序lastname . |
4 | Finder 方法按通过Sort 参数。 |
5 | 用Pageable 将 offset 和 sorting 参数传递给数据库。 |
6 | Finder 方法使用And / Or 关键字。 |
7 | 查找第一个匹配的实体。 |
8 | 该方法显示具有给定lastname 通过运行 Annotated@Query 给定
参数。 |
9 | 计算所有匹配firstname . |
10 | 检查是否至少有一个实体匹配firstname 存在。 |
11 | 删除所有具有匹配项的实体firstname . |
配置
对于 Java 配置,请使用@EnableReactiveElasticsearchRepositories
注解。如果未配置基础包,则
基础架构扫描带注释的 Configuration 类的软件包。
下面的清单显示了如何对存储库使用 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")));
// ...
}
}