{"id":344,"date":"2020-05-12T10:03:56","date_gmt":"2020-05-12T08:03:56","guid":{"rendered":"https:\/\/arasoftware.pl\/?p=344"},"modified":"2021-10-21T10:34:26","modified_gmt":"2021-10-21T08:34:26","slug":"spring-boot-elasticsearch","status":"publish","type":"post","link":"https:\/\/arasoftware.pl\/en\/spring-boot-elasticsearch\/","title":{"rendered":"Spring Boot i Elasticsearch"},"content":{"rendered":"Czas czytania: <\/span> 5<\/span> minut<\/span><\/span>

Elasticsearch to dokumentowa baza danych, która udostępnia bardzo sprawny mechanizm wyszukiwania pełnotekstowego. Jest to potężne narzędzie oparte na Apache Lucece, które umożliwia przeszukiwanie danych w czasie niemalże rzeczywistym. Dodatkowo udostępnia przyjazne API, dzięki któremu można w łatwy i przyjazny użytkownikowi sposób, zarządzać tą bazą danych.<\/p>\n\n\n

Wielu z nas, programistów, doświadczyło kiedyś problemu z wydajnością dużej bazy danych podczas wyszukiwania w niej informacji. Zwłaszcza jeśli duża część danych w tej bazie była tekstowa. Sam widziałem niejednokrotnie jak wolno może działać aplikacja jeśli nikt wcześniej nie zadbał o poprawną strukturę bazy danych. Brak normalizacji bazy, duplikaty danych oraz nieoptymalne wyszukiwanie sprawiały że po jakimś czasie, gdy już baza napełniła się danymi to aplikacja działała co raz wolniej.<\/p>\n\n\n

Jak uniknąć chociaż części z tych problemów? Jak sprawić żeby Twoja aplikacja działała płynnie po mimo ogromu danych jakie generuje? Z pomocą przychodzi Elasticsearch.<\/p>\n\n\n

Uruchomienie Elasticsearch na dockerze<\/h2>\n\n\n

Przejdźmy więc do przykładu, w którym połączymy aplikację opartą o Spring Boot z Elasticsearch. Na początek uruchommy sobie dockera z usługą Elasticsearch. Jeśli nie wiesz jak to zrobić, to zachęcam do zapoznania się z dokumentacją techniczną dostępną pod adresem <\/a> https:\/\/www.elastic.co\/guide\/en\/elasticsearch\/reference\/current\/docker.html<\/a><\/p>\n\n\n

Uruchomienie obrazu Elasticsearch sprowadza się do wywołania komendy:<\/p>\n\n\n\n

docker run -p 9200:9200 -p 9300:9300 -e \"discovery.type=single-node\" docker.elastic.co\/elasticsearch\/elasticsearch:7.6.2<\/code><\/pre>\n\n\n
Po poprawnym odpaleniu dockera oraz wejściu na „http:\/\/localhost:9200”, w oknie przeglądarki powinniśmy otrzymać poniższy response:<\/p>\n\n\n\n
{\n  \"name\" : \"2b22d9ccf50b\",\n  \"cluster_name\" : \"docker-cluster\",\n  \"cluster_uuid\" : \"TT6pCY7mTWmm8KWiRNMyPQ\",\n  \"version\" : {\n    \"number\" : \"7.6.2\",\n    \"build_flavor\" : \"default\",\n    \"build_type\" : \"docker\",\n    \"build_hash\" : \"ef48eb35cf30adf4db14086e8aabd07ef6fb113f\",\n    \"build_date\" : \"2020-03-26T06:34:37.794943Z\",\n    \"build_snapshot\" : false,\n    \"lucene_version\" : \"8.4.0\",\n    \"minimum_wire_compatibility_version\" : \"6.8.0\",\n    \"minimum_index_compatibility_version\" : \"6.0.0-beta1\"\n  },\n  \"tagline\" : \"You Know, for Search\"\n}<\/code><\/pre>\n\n\n
Warto w tym miejscu dodać, że Elasticsearch udostępnia REST API na porcie 9200. Dzięki temu rozwiązaniu możemy używać tej bazy także za pomocą użytecznego API, opisanego tutaj:  https:\/\/www.elastic.co\/guide\/en\/elasticsearch\/reference\/current\/rest-apis.html<\/a>.<\/p>\n\n\n
Przykład integracji Spring Boot i Elasticsearch<\/h2>\n\n\n
Jeśli docker z Elasticsearch działa poprawnie, to możemy przejść do implementacji aplikacji w Spring Boot. Będzie się ona łączyć bezpośrednio z Elasticsearch za pomocą Spring Data Elasticsearch. Jest to dedykowana zależność do Springa, która w łatwy i prosty sposób pozwala wywoływać requesty do Elasticsearch, za pomocą interfejsów analogicznych do tych z Spring Data.<\/p>\n\n\n
Poniżej znajduje się plik „pom.xml”, w którym znajduje się dodany starter spring-boot-starter-data-elasticsearch<\/code><\/p>\n\n\n\n
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<project xmlns=\"http:\/\/maven.apache.org\/POM\/4.0.0\" xmlns:xsi=\"http:\/\/www.w3.org\/2001\/XMLSchema-instance\"\n         xsi:schemaLocation=\"http:\/\/maven.apache.org\/POM\/4.0.0 https:\/\/maven.apache.org\/xsd\/maven-4.0.0.xsd\">\n    <modelVersion>4.0.0<\/modelVersion>\n    <parent>\n        <groupId>org.springframework.boot<\/groupId>\n        <artifactId>spring-boot-starter-parent<\/artifactId>\n        <version>2.2.6.RELEASE<\/version>\n        <relativePath\/> <!-- lookup parent from repository -->\n    <\/parent>\n    <groupId>com.ara<\/groupId>\n    <artifactId>elastic<\/artifactId>\n    <version>0.0.1-SNAPSHOT<\/version>\n    <name>elastic<\/name>\n    <description>Demo project for Spring Boot and Elasticsearch integration<\/description>\n\n    <properties>\n        <java.version>1.8<\/java.version>\n    <\/properties>\n\n    <dependencies>\n        <dependency>\n            <groupId>org.springframework.boot<\/groupId>\n            <artifactId>spring-boot-starter-data-elasticsearch<\/artifactId>\n        <\/dependency>\n        <dependency>\n            <groupId>org.springframework.boot<\/groupId>\n            <artifactId>spring-boot-starter-web<\/artifactId>\n        <\/dependency>\n\n        <dependency>\n            <groupId>org.projectlombok<\/groupId>\n            <artifactId>lombok<\/artifactId>\n            <optional>true<\/optional>\n        <\/dependency>\n        <dependency>\n            <groupId>org.springframework.boot<\/groupId>\n            <artifactId>spring-boot-starter-test<\/artifactId>\n            <scope>test<\/scope>\n            <exclusions>\n                <exclusion>\n                    <groupId>org.junit.vintage<\/groupId>\n                    <artifactId>junit-vintage-engine<\/artifactId>\n                <\/exclusion>\n            <\/exclusions>\n        <\/dependency>\n    <\/dependencies>\n\n    <build>\n        <plugins>\n            <plugin>\n                <groupId>org.springframework.boot<\/groupId>\n                <artifactId>spring-boot-maven-plugin<\/artifactId>\n            <\/plugin>\n        <\/plugins>\n    <\/build>\n\n<\/project>\n\n<\/code><\/pre>\n\n\n
Warto zauważyć, że dodałem do projektu zależności projektu Lombok. Pomoże to w późniejszej implementacji aplikacji. <\/p>\n\n\n
Kolejnym krokiem jest zdefiniowanie połączenia po między naszą aplikacją, a usługą Elasticsearch, którą przed chwilą uruchomiliśmy na dockerze. W tym celu dodamy poniższą klasę „EsConfig.java”. Jest to klasa konfiguracyjna, która dostarcza nam deificeję dwóch beanów; Client i ElasticsearchOperations. Odpowiadają one odpowiednio za możliwość połączenia się z usługą Elasticsearch oraz za zdefiniowanie operacji, które mogą być wykonywane na tej usłudze.<\/p>\n\n\n\n
package com.ara.elastic;\n\nimport org.elasticsearch.client.Client;\nimport org.elasticsearch.client.transport.TransportClient;\nimport org.elasticsearch.common.settings.Settings;\nimport org.elasticsearch.common.transport.TransportAddress;\nimport org.elasticsearch.transport.client.PreBuiltTransportClient;\nimport org.springframework.beans.factory.annotation.Value;\nimport org.springframework.context.annotation.Bean;\nimport org.springframework.context.annotation.Configuration;\nimport org.springframework.data.elasticsearch.core.ElasticsearchOperations;\nimport org.springframework.data.elasticsearch.core.ElasticsearchTemplate;\nimport org.springframework.data.elasticsearch.repository.config.EnableElasticsearchRepositories;\n\nimport java.net.InetAddress;\nimport java.net.UnknownHostException;\n\n@Configuration\n@EnableElasticsearchRepositories\npublic class EsConfig {\n\n    @Value(\"${elasticsearch.cluster.name:docker-cluster}\")\n    private String clusterName;\n\n    @Value(\"${elasticsearch.host}\")\n    private String elasticsearchHost;\n\n    @Value(\"#{new Integer('${elasticsearch.port}')}\")\n    private Integer elasticsearchPort;\n\n    @Bean\n    public Client client() throws UnknownHostException {\n        TransportClient client = new PreBuiltTransportClient(Settings.builder()\n                .put(\"cluster.name\", clusterName)\n                .build());\n        client.addTransportAddress(new TransportAddress(InetAddress.getByName(elasticsearchHost), elasticsearchPort));\n        return client;\n    }\n\n    @Bean\n    public ElasticsearchOperations elasticsearchTemplate() throws UnknownHostException {\n        return new ElasticsearchTemplate(client());\n    }\n}<\/code><\/pre>\n\n\n
Do pliku konfiguracyjnego „application.properties”, w celu zdefiniowania danych dostępowych do usługi Elasticsearch, należy dodać poniższe parametry:<\/p>\n\n\n\n
elasticsearch.host=127.0.0.1\nelasticsearch.port=9300\nelasticsearch.cluster.name=docker-cluster<\/code><\/pre>\n\n\n
Klasa „Post.java” będzie naszą encją poddawaną persystencji w bazie danych.<\/p>\n\n\n\n
package com.ara.elastic.model;\n\nimport lombok.AllArgsConstructor;\nimport lombok.Getter;\nimport lombok.NoArgsConstructor;\nimport lombok.Setter;\nimport org.springframework.data.annotation.Id;\nimport org.springframework.data.elasticsearch.annotations.Document;\n\n@Getter\n@Setter\n@NoArgsConstructor\n@AllArgsConstructor\n@Document(indexName = \"blog\", type = \"post\")\npublic class Post {\n\n    @Id\n    private String id;\n    private String title;\n    private String content;\n    private boolean isPublished;\n    private String author;\n}\n<\/code><\/pre>\n\n\n
Warto zauważyć że nie ma tutaj klasycznych getterów, setterów i konstrukrotów, a wszystko dzieje się dzięki Lombok’owi i jego adnotacjom:<\/p>\n\n\n\n
@Getter\n@Setter\n@NoArgsConstructor\n@AllArgsConstructor<\/code><\/pre>\n\n\n
Lecz najważniejsza dla nas jest adnotacja:<\/p>\n\n\n\n
@Document(indexName = \"blog\", type = \"post\")<\/code><\/pre>\n\n\n
Pozwola ona na zapis obiektu „Post” do bazy danych Elasticsearch. Adnotacja „@Document” przyjmuje w tym wypadku dwa parametry:<\/p>\n\n\n