Spring/spring-data-examples
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

#497 - Add reactive Spring Data Elasticsearch example.

Browse Source
This commit is contained in:
Christoph Strobl
2019-04-24 10:28:03 +02:00
committed by Oliver Drotbohm
parent 50fadd566e
commit 97a4574e84
12 changed files with 491 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@@ -59,6 +59,7 @@ We have separate folders for the samples of individual modules:
## Spring Data Elasticsearch
* `example` - Example how to use basic text search, geo-spatial search and facets.
* `reactive` - Example how to use reactive client, template and repository features.
## Spring Data Neo4j

5
elasticsearch/pom.xml
View File

@@ -17,6 +17,7 @@
<modules>
<module>example</module>
<module>reactive</module>
</modules>
<dependencies>
@@ -30,13 +31,13 @@
<profile>
<id>spring-data-next-releasetrain</id>
<properties>
<elasticsearch.version>6.6.0</elasticsearch.version>
<elasticsearch.version>6.6.1</elasticsearch.version>
</properties>
</profile>
<profile>
<id>spring-data-next-releasetrain-released</id>
<properties>
<elasticsearch.version>6.6.0</elasticsearch.version>
<elasticsearch.version>6.6.1</elasticsearch.version>
</properties>
</profile>
</profiles>

13
elasticsearch/reactive/.gitignore vendored Normal file
View File

@@ -0,0 +1,13 @@
.project
.classpath
.springBeans
.settings/
target/
#IntelliJ Stuff
.idea
*.iml
##ignore local node data files for unit tests
/data
/.DS_Store

58
elasticsearch/reactive/README.md Normal file
View File

@@ -0,0 +1,58 @@
# Spring Data Elasticsearch - Reactive Examples
The `ReactiveElasticsearchClient` is a non official driver based on `WebClient`.
It uses the request/response objects provided by the Elasticsearch core project.
Calls are directly operated on the reactive stack, not wrapping async (thread pool bound) responses into reactive types.
````java
class ApplicationConfiguration extends AbstractReactiveElasticsearchConfiguration {
@Bean
@Override
public ReactiveElasticsearchClient reactiveElasticsearchClient() {
return ReactiveRestClients.create(ClientConfiguration.localhost());
}
}
````
The `ReactiveElasticsearchClient` can be used with the `ReactiveElasticsearchOperations` and `ReactiveElasticsearchRepository`.
```java
@Autowired ReactiveElasticsearchOperations operations;
// ...
CriteriaQuery query = new CriteriaQuery("keywords").contains("java");
Flux<Conference> result = operations.find(query, Conference.class);
```
```java
interface ConferenceRepository extends ReactiveCrudRepository<Conference, String> {
Flux<Conference> findAllByKeywordsContains(String keyword);
}
// ...
@Autowired ConferenceRepository repository;
// ...
Flux<Conference> result = repository.findAllByKeywordsContains("java");
```
**Requirements:**
* [Maven](http://maven.apache.org/download.cgi)
* [Elasticsearch](https://www.elastic.co/de/downloads/elasticsearch)
**Running Elasticsearch**
```bash
$ cd elasticsearch
$ ./bin/elasticsearch
```

38
elasticsearch/reactive/pom.xml Normal file
View File

@@ -0,0 +1,38 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.springframework</groupId>
<artifactId>spring-data-elasticsearch-reactive-example</artifactId>
<name>Spring Data Elasticsearch - Reactive Example</name>
<description>Sample projects for Reactive Spring Data Elasticsearch</description>
<url>https://github.com/spring-projects/spring-data-elasticsearch</url>
<parent>
<groupId>org.springframework.data.examples</groupId>
<artifactId>spring-data-elasticsearch-examples</artifactId>
<version>2.0.0.BUILD-SNAPSHOT</version>
</parent>
<dependencies>
<dependency>
<groupId>io.projectreactor</groupId>
<artifactId>reactor-test</artifactId>
</dependency>
<dependency>
<groupId>io.projectreactor</groupId>
<artifactId>reactor-test</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-webflux</artifactId>
</dependency>
</dependencies>
</project>

88
elasticsearch/reactive/src/main/java/example/springdata/elasticsearch/conference/ApplicationConfiguration.java Normal file
View File

@@ -0,0 +1,88 @@
/*
* Copyright 2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package example.springdata.elasticsearch.conference;
import javax.annotation.PostConstruct;
import java.io.IOException;
import java.util.Arrays;
import org.elasticsearch.ElasticsearchStatusException;
import org.elasticsearch.action.admin.indices.create.CreateIndexRequest;
import org.elasticsearch.client.RequestOptions;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.convert.support.DefaultConversionService;
import org.springframework.data.elasticsearch.client.ClientConfiguration;
import org.springframework.data.elasticsearch.client.RestClients;
import org.springframework.data.elasticsearch.client.reactive.ReactiveElasticsearchClient;
import org.springframework.data.elasticsearch.client.reactive.ReactiveRestClients;
import org.springframework.data.elasticsearch.config.AbstractReactiveElasticsearchConfiguration;
import org.springframework.data.elasticsearch.core.ElasticsearchEntityMapper;
import org.springframework.data.elasticsearch.core.EntityMapper;
import org.springframework.data.elasticsearch.core.ReactiveElasticsearchOperations;
import org.springframework.data.elasticsearch.core.geo.GeoPoint;
import org.springframework.data.elasticsearch.repository.config.EnableReactiveElasticsearchRepositories;
import reactor.test.StepVerifier;
/**
* @author Christoph Strobl
*/
@Configuration
@EnableReactiveElasticsearchRepositories
class ApplicationConfiguration extends AbstractReactiveElasticsearchConfiguration {
@Autowired ReactiveElasticsearchOperations operations;
@Autowired ConferenceRepository repository;
@Bean
@Override
public ReactiveElasticsearchClient reactiveElasticsearchClient() {
return ReactiveRestClients.create(ClientConfiguration.localhost());
}
@Override
public EntityMapper entityMapper() {
return new ElasticsearchEntityMapper(elasticsearchMappingContext(),
new DefaultConversionService());
}
@PostConstruct
public void insertDataSample() {
try {
RestClients.create(ClientConfiguration.localhost()).rest().indices().create(new CreateIndexRequest("conference-index"), RequestOptions.DEFAULT);
} catch (IOException | ElasticsearchStatusException e) {
// just ignore it
}
// Remove all documents
repository.deleteAll().subscribe();
// Save data sample
repository.save(Conference.builder().date("2014-11-06").name("Spring eXchange 2014 - London")
.keywords(Arrays.asList("java", "spring")).location(new GeoPoint(51.500152D, -0.126236D)).build()).then().as(StepVerifier::create).verifyComplete();
repository.save(Conference.builder().date("2014-12-07").name("Scala eXchange 2014 - London")
.keywords(Arrays.asList("scala", "play", "java")).location(new GeoPoint(51.500152D, -0.126236D)).build()).then().as(StepVerifier::create).verifyComplete();
repository.save(Conference.builder().date("2014-11-20").name("Elasticsearch 2014 - Berlin")
.keywords(Arrays.asList("java", "elasticsearch", "kibana")).location(new GeoPoint(52.5234051D, 13.4113999))
.build()).then().as(StepVerifier::create).verifyComplete();
repository.save(Conference.builder().date("2014-11-12").name("AWS London 2014")
.keywords(Arrays.asList("cloud", "aws")).location(new GeoPoint(51.500152D, -0.126236D)).build()).then().as(StepVerifier::create).verifyComplete();
repository.save(Conference.builder().date("2014-10-04").name("JDD14 - Cracow")
.keywords(Arrays.asList("java", "spring")).location(new GeoPoint(50.0646501D, 19.9449799)).build()).then().as(StepVerifier::create).verifyComplete();
}
}

43
elasticsearch/reactive/src/main/java/example/springdata/elasticsearch/conference/Conference.java Normal file
View File

@@ -0,0 +1,43 @@
/*
* Copyright 2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package example.springdata.elasticsearch.conference;
import static org.springframework.data.elasticsearch.annotations.FieldType.*;
import java.util.List;
import lombok.Builder;
import lombok.Data;
import org.springframework.data.annotation.Id;
import org.springframework.data.elasticsearch.annotations.Document;
import org.springframework.data.elasticsearch.annotations.Field;
import org.springframework.data.elasticsearch.core.geo.GeoPoint;
/**
* @auhtor Christoph Strobl
*/
@Data
@Builder
@Document(indexName = "conference-index", type = "geo-class-point-type", shards = 1, replicas = 0,
refreshInterval = "-1")
public class Conference {
private @Id String id;
private String name;
private @Field(type = Date) String date;
private GeoPoint location;
private List<String> keywords;
}

27
elasticsearch/reactive/src/main/java/example/springdata/elasticsearch/conference/ConferenceRepository.java Normal file
View File

@@ -0,0 +1,27 @@
/*
* Copyright 2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package example.springdata.elasticsearch.conference;
import org.springframework.data.repository.reactive.ReactiveCrudRepository;
import reactor.core.publisher.Flux;
/**
* @author Christoph Strobl
*/
interface ConferenceRepository extends ReactiveCrudRepository<Conference, String> {
Flux<Conference> findAllByKeywordsContainsAndDateAfter(String keyword, String Date);
}

3
elasticsearch/reactive/src/main/resources/application.properties Normal file
View File

@@ -0,0 +1,3 @@
# Uncomment both entries to connect with local elasticsearch cluster
#spring.data.elasticsearch.clusterName=elasticsearch
#spring.data.elasticsearch.clusterNodes=localhost:9300

76
elasticsearch/reactive/src/test/java/example/springdata/elasticsearch/conference/ReactiveElasticsearchOperationsTest.java Normal file
View File

@@ -0,0 +1,76 @@
/*
* Copyright 2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package example.springdata.elasticsearch.conference;
import static org.assertj.core.api.Assertions.*;
import example.springdata.elasticsearch.util.ElasticsearchAvailable;
import reactor.test.StepVerifier;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import org.junit.ClassRule;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.data.elasticsearch.core.ReactiveElasticsearchOperations;
import org.springframework.data.elasticsearch.core.query.Criteria;
import org.springframework.data.elasticsearch.core.query.CriteriaQuery;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
/**
* Test case to show Spring Data Elasticsearch functionality.
*
* @author Christoph Strobl
*/
@RunWith(SpringJUnit4ClassRunner.class)
@SpringBootTest(classes = ApplicationConfiguration.class)
public class ReactiveElasticsearchOperationsTest {
public static @ClassRule ElasticsearchAvailable elasticsearchAvailable = ElasticsearchAvailable.onLocalhost();
private static final SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd");
@Autowired ReactiveElasticsearchOperations operations;
@Test
public void textSearch() {
String expectedDate = "2014-10-29";
String expectedWord = "java";
CriteriaQuery query = new CriteriaQuery(
new Criteria("keywords").contains(expectedWord).and("date").greaterThanEqual(expectedDate));
operations.find(query, Conference.class) //
.as(StepVerifier::create) //
.consumeNextWith(it -> verify(it, expectedWord, expectedDate)) //
.consumeNextWith(it -> verify(it, expectedWord, expectedDate)) //
.consumeNextWith(it -> verify(it, expectedWord, expectedDate)) //
.verifyComplete();
}
void verify(Conference it, String expectedWord, String expectedDate) {
assertThat(it.getKeywords()).contains(expectedWord);
try {
assertThat(format.parse(it.getDate())).isAfter(format.parse(expectedDate));
} catch (ParseException e) {
fail("o_O", e);
}
}
}

71
elasticsearch/reactive/src/test/java/example/springdata/elasticsearch/conference/ReactiveElasticsearchRepositoryTest.java Normal file
View File

@@ -0,0 +1,71 @@
/*
* Copyright 2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package example.springdata.elasticsearch.conference;
import static org.assertj.core.api.Assertions.*;
import example.springdata.elasticsearch.util.ElasticsearchAvailable;
import reactor.test.StepVerifier;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import org.junit.ClassRule;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
/**
* Test case to show reactive Spring Data Elasticsearch repository functionality.
*
* @author Christoph Strobl
*/
@RunWith(SpringJUnit4ClassRunner.class)
@SpringBootTest(classes = ApplicationConfiguration.class)
public class ReactiveElasticsearchRepositoryTest {
public static @ClassRule ElasticsearchAvailable elasticsearchAvailable = ElasticsearchAvailable.onLocalhost();
private static final SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd");
@Autowired ConferenceRepository repository;
@Test
public void textSearch() {
String expectedDate = "2014-10-29";
String expectedWord = "java";
repository.findAllByKeywordsContainsAndDateAfter(expectedWord, expectedDate) //
.as(StepVerifier::create) //
.consumeNextWith(it -> verify(it, expectedWord, expectedDate)) //
.consumeNextWith(it -> verify(it, expectedWord, expectedDate)) //
.consumeNextWith(it -> verify(it, expectedWord, expectedDate)) //
.verifyComplete();
}
void verify(Conference it, String expectedWord, String expectedDate) {
assertThat(it.getKeywords()).contains(expectedWord);
try {
assertThat(format.parse(it.getDate())).isAfter(format.parse(expectedDate));
} catch (ParseException e) {
fail("o_O", e);
}
}
}

70
elasticsearch/reactive/src/test/java/example/springdata/elasticsearch/util/ElasticsearchAvailable.java Normal file
View File

@@ -0,0 +1,70 @@
/*
* Copyright 2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package example.springdata.elasticsearch.util;
import java.io.IOException;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpHead;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.assertj.core.api.Assumptions;
import org.junit.AssumptionViolatedException;
import org.junit.rules.TestRule;
import org.junit.runner.Description;
import org.junit.runners.model.Statement;
/**
* @author Christoph Strobl
*/
public class ElasticsearchAvailable implements TestRule {
private final String url;
private ElasticsearchAvailable(String url) {
this.url = url;
}
public static ElasticsearchAvailable onLocalhost() {
return new ElasticsearchAvailable("http://localhost:9200");
}
@Override
public Statement apply(Statement base, Description description) {
return new Statement() {
@Override
public void evaluate() throws Throwable {
checkServerRunning();
base.evaluate();
}
};
}
private void checkServerRunning() {
try (CloseableHttpClient client = HttpClientBuilder.create().build()) {
CloseableHttpResponse response = client.execute(new HttpHead(url));
if (response != null && response.getStatusLine() != null) {
Assumptions.assumeThat(response.getStatusLine().getStatusCode()).isEqualTo(200);
}
} catch (IOException e) {
throw new AssumptionViolatedException(String.format("Elasticsearch Server seems to be down. %s", e.getMessage()));
}
}
}