SpringBoot3整合Elasticsearch8.x之全面保姆级教程

2024-03-16 09:52
文章标签 教程 全面 整合 保姆 springboot3 elasticsearch8

本文主要是介绍SpringBoot3整合Elasticsearch8.x之全面保姆级教程，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

整合ES

环境准备

  1. 安装配置ES：https://blog.csdn.net/qq_50864152/article/details/136724528
  2. 安装配置Kibana：https://blog.csdn.net/qq_50864152/article/details/136727707
  3. 新建项目：新建名为web的SpringBoot3项目

elasticsearch-java

公共配置

  1. 介绍：一个开源的高扩展的分布式全文检索引擎，可以近乎实时的存储 和检索数据
  2. 依赖：web模块引入elasticsearch-java依赖---但其版本必须与你下载的ES的版本一致
<!-- 若不存在Spring Data ES的某个版本支持你下的ES版本,则使用  -->
<!-- ES 官方提供的在JAVA环境使用的依赖 -->
<dependency><groupId>co.elastic.clients</groupId><artifactId>elasticsearch-java</artifactId><version>8.11.1</version>
</dependency><!-- 和第一个依赖是一起的,为了解决springboot项目的兼容性问题  -->
<dependency><groupId>com.fasterxml.jackson.core</groupId><artifactId>jackson-databind</artifactId>
</dependency>
  1. 配置：web模块dev目录application-dal添加

使用open＋@Value("${elasticsearch.open}")的方式不能放到Nacos配置中心

# elasticsearch配置
elasticsearch:# 自定义属性---设置是否开启ES,false表不开窍ESopen: true# es集群名称,如果下载es设置了集群名称,则使用配置的集群名称clusterName: eshosts: 127.0.0.1:9200# es 请求方式scheme: http# es 连接超时时间connectTimeOut: 1000# es socket 连接超时时间socketTimeOut: 30000# es 请求超时时间connectionRequestTimeOut: 500# es 最大连接数maxConnectNum: 100# es 每个路由的最大连接数maxConnectNumPerRoute: 100
  1. 配置：web模块config包下新建ElasticSearchConfig类
package cn.bytewisehub.pai.web.config;import co.elastic.clients.elasticsearch.ElasticsearchClient;
import co.elastic.clients.json.jackson.JacksonJsonpMapper;
import co.elastic.clients.transport.ElasticsearchTransport;
import co.elastic.clients.transport.rest_client.RestClientTransport;
import lombok.Data;
import lombok.extern.slf4j.Slf4j;
import org.apache.http.HttpHost;
import org.apache.http.auth.AuthScope;
import org.apache.http.auth.UsernamePasswordCredentials;
import org.apache.http.client.CredentialsProvider;
import org.apache.http.impl.client.BasicCredentialsProvider;
import org.elasticsearch.client.RestClient;
import org.elasticsearch.client.RestClientBuilder;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;@Slf4j
@Data
@Configuration
@ConfigurationProperties(prefix = "elasticsearch")
public class ElasticSearchConfig {// 是否开启ESprivate Boolean open;// es 集群host ip 地址private String hosts;// es用户名private String userName;// es密码private String password;// es 请求方式private String scheme;// es集群名称private String clusterName;// es 连接超时时间private int connectTimeOut;// es socket 连接超时时间private int socketTimeOut;// es 请求超时时间private int connectionRequestTimeOut;// es 最大连接数private int maxConnectNum;// es 每个路由的最大连接数private int maxConnectNumPerRoute;// es api keyprivate String apiKey;public RestClientBuilder creatBaseConfBuilder(String scheme){// 1. 单节点ES Host获取String host = hosts.split(":")[0];String port = hosts.split(":")[1];// The value of the schemes attribute used by noSafeRestClient() is http// but The value of the schemes attribute used by safeRestClient() is httpsHttpHost httpHost = new HttpHost(host, Integer.parseInt(port),scheme);// 2. 创建构建器对象//RestClientBuilder: ES客户端库的构建器接口,用于构建RestClient实例;允许你配置与Elasticsearch集群的连接,设置请求超时,设置身份验证,配置代理等RestClientBuilder builder = RestClient.builder(httpHost);// 连接延时配置builder.setRequestConfigCallback(requestConfigBuilder -> {requestConfigBuilder.setConnectTimeout(connectTimeOut);requestConfigBuilder.setSocketTimeout(socketTimeOut);requestConfigBuilder.setConnectionRequestTimeout(connectionRequestTimeOut);return requestConfigBuilder;});// 3. HttpClient 连接数配置builder.setHttpClientConfigCallback(httpClientBuilder -> {httpClientBuilder.setMaxConnTotal(maxConnectNum);httpClientBuilder.setMaxConnPerRoute(maxConnectNumPerRoute);return httpClientBuilder;});return builder;}
}
  1. 测试：web模块test目录下新建ElasticSearchTest类
@Slf4j
@SpringBootTest
public class ElasticSearchTest {@Value("${elasticsearch.open}")// 是否开启ES,默认开启String open = "true";
}

直接连接ES

  1. 设置：ES Elasticsearch.yml的xpack.security.enabled属性设置为false

xpack.security.enabled：
● 默认true：必须使用账号连接ES
● 若为false：必须使用http://localhost:9200/访问ES服务+启动Kibana服务会失败+不需要使用账号连接，但必须使用HTTP连接

  1. 添加：ElasticSearchConfig类添加下列方法
/**
* @function: 创建使用http连接来直接连接ES服务器的客户端
* 如果@Bean没有指定bean的名称,那么这个bean的名称就是方法名
*/
@Bean(name = "directConnectionESClient")
public ElasticsearchClient directConnectionESClient(){RestClientBuilder builder = creatBaseConfBuilder((scheme == "http")?"http":"http");//Create the transport with a Jackson mapperElasticsearchTransport transport = new RestClientTransport(builder.build(), new JacksonJsonpMapper());//And create the API clientElasticsearchClient esClient = new ElasticsearchClient(transport);return esClient;
};
  1. 添加：ElasticSearchTest类中添加下列代码---索引名必须小写
  2. 运行：设置跳过测试--->手动运行/不跳过--->直接install，但不运行测试
@Resource(name = "directConnectionESClient")
ElasticsearchClient directConnectionESClient;@Test
public void directConnectionTest() throws IOException {if (open.equals("true")) {//创建索引CreateIndexResponse response = directConnectionESClient.indices().create(c -> c.index("direct_connection_index"));log.info(response.toString());
}
else{log.info("es is closed");
}
}

账号密码连接ES

  1. 设置：ES Elasticsearch.yml的xpack.security.enabled属性使用默认值+ xpack.security.http.ssl.enabled设置为false

注意：若xpack.security.enabled属性为false，则xpack.security.http.ssl.enabled属性不生效，即相当于设置为false；所有以xpack开头的属性都不会生效

ES Elasticsearch.yml的xpack.security.http.ssl.enabled：
● 默认true：必须使用https://localhost:9200/访问ES服务+启动Kibana服务会成功+需要使用账号连接+必须使用HTTPS连接
● 若为false：必须使用http://localhost:9200/访问ES服务+启动Kibana服务会失败+需要使用账号连接，但必须使用HTTP连接

  1. 配置：dev目录application-dal中添加下列配置
# elasticsearch配置
elasticsearch:userName:  #自己的账号名password:  #自己的密码
  1. 添加：ElasticSearchTest类中添加下列代码---索引名必须小写+不能有空格
  2. 运行：设置跳过测试--->手动运行/不跳过--->直接install，但不运行测试
@Resource(name = "accountConnectionESClient")
ElasticsearchClient accountConnectionESClient;@Test
public void accountConnectionTest() throws IOException {if (open.equals("true")) {//创建索引CreateIndexResponse response = accountConnectionESClient.indices().create(c -> c.index("account_connection_index"));log.info(response.toString());
}
else{log.info("es is closed");
}
}

证书账号连接ES

  1. 设置：ES Elasticsearch.yml的xpack.security.enabled和xpack.security.http.ssl.enabled配置项使用默认值

设置为true后，ES就走https，若scheme为http，则报Unrecognized SSL message错误

  1. 配置：将dev目录application-dal中elasticsearch.scheme配置项改成https
  2. 证书添加：终端输入keytool -importcert -alias es_https_ca -keystore "D:\computelTool\Java\JDK\JDK21\lib\security\cacerts" -file "D:\computelTool\database\elasticsearch8111\config\certs\http_ca.crt"

keytool -delete -alias es_https_ca -keystore "D:\computelTool\Java\JDK\JDK21\lib\security\cacerts" ---与上面的命令相反

  1. 拷贝：将ESconfig目录下certs目录下的http_ca.crt文件拷贝到web模块resource目录
  2. 添加：ElasticSearchConfig类添加下列方法
/**
* @function: 创建用于安全连接(证书 + 账号)ES服务器的客户端
* 如果@Bean没有指定bean的名称,那么这个bean的名称就是方法名
*/
@Bean(name = "accountAndCertificateConnectionESClient")
public ElasticsearchClient accountAndCertificateConnectionESClient() {RestClientBuilder builder = creatBaseConfBuilder( (scheme == "https")?"https":"https");// 1.账号密码的配置//CredentialsProvider: 用于提供 HTTP 身份验证凭据的接口; 允许你配置用户名和密码,以便在与服务器建立连接时进行身份验证CredentialsProvider credentialsProvider = new BasicCredentialsProvider();credentialsProvider.setCredentials(AuthScope.ANY, new UsernamePasswordCredentials(userName, password));// 2.设置自签证书,并且还包含了账号密码builder.setHttpClientConfigCallback(httpAsyncClientBuilder -> httpAsyncClientBuilder.setSSLContext(buildSSLContext()).setSSLHostnameVerifier(NoopHostnameVerifier.INSTANCE).setDefaultCredentialsProvider(credentialsProvider));RestClientTransport transport = new RestClientTransport(builder.build(), new JacksonJsonpMapper());//And create the API clientElasticsearchClient esClient = new ElasticsearchClient(transport);return esClient;
}private static SSLContext buildSSLContext() {// 读取http_ca.crt证书ClassPathResource resource = new ClassPathResource("http_ca.crt");SSLContext sslContext = null;try {// 证书工厂CertificateFactory factory = CertificateFactory.getInstance("X.509");Certificate trustedCa;try (InputStream is = resource.getInputStream()) {trustedCa = factory.generateCertificate(is);}// 密钥库KeyStore trustStore = KeyStore.getInstance("pkcs12");trustStore.load(null, "liuxiansheng".toCharArray());trustStore.setCertificateEntry("ca", trustedCa);SSLContextBuilder sslContextBuilder = SSLContexts.custom().loadTrustMaterial(trustStore, null);sslContext = sslContextBuilder.build();} catch (CertificateException | IOException | KeyStoreException | NoSuchAlgorithmException |KeyManagementException e) {log.error("ES连接认证失败", e);}return sslContext;
}
  1. 测试：ElasticSearchTest类添加
@Resource(name = "accountAndCertificateConnectionESClient")
ElasticsearchClient accountAndCertificateConnectionESClient;@Test
public void  accountAndCertificateConnectionTest() throws IOException {if (open.equals("true")) {//创建索引CreateIndexResponse response =  accountAndCertificateConnectionESClient.indices().create(c -> c.index("account_and_certificate_connection_index"));log.info(response.toString());System.out.println(response.toString());
}
else{log.info("es is closed");
}
}

Spring Data ES

公共配置

  1. 依赖：web模块引入该依赖---但其版本必须与你下载的ES的版本一致

版本：点击https://spring.io/projects/spring-data-elasticsearch#learn，点击GA版本的Reference Doc，点击version查看Spring Data ES与ES版本的支持关系

参考：https://www.yuque.com/itwanger/vn4p17/wslq2t/https://blog.csdn.net/qq_40885085/article/details/105023026

<!-- 若存在Spring Data ES的某个版本支持你下的ES版本,则使用  -->
<!-- Spring官方在ES官方提供的JAVA环境使用的依赖的基础上做了封装 -->
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-data-elasticsearch</artifactId>
</dependency><!-- ESTestEntity用到 -->
<dependency><groupId>jakarta.servlet</groupId><artifactId>jakarta.servlet-api</artifactId><version>6.0.0</version><scope>provided</scope>
</dependency><!-- ESTestEntity用到 -->
<dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><scope>provided</scope><!--provided：指定该依赖项在编译时是必需的，才会生效, 但在运行时不需要,也不会生效--><!--这样 Lombok 会在编译期静悄悄地将带 Lombok 注解的源码文件正确编译为完整的 class 文件 -->
</dependency>
  1. 新建：web模块TestEntity目录新建ESTestEntity
@Data
@EqualsAndHashCode(callSuper = false)
@Document(indexName = "test")
public class ESTestEntity implements Serializable {private static final long serialVersionUID = 1L;@Idprivate Long id;@Field(type = FieldType.Text, analyzer = "ik_max_word")private String content;private String title;private String excerpt;
}
  1. 新建：web模块TestRepository包下新建ESTestRepository 接口
import cn.bytewisehub.pai.web.TestEntity.ESTestEntity;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.elasticsearch.repository.ElasticsearchRepository;public interface ESTestRepository extends ElasticsearchRepository<ESTestEntity, Long> {
}

直接连接ES

  1. 配置：ES Elasticsearch.yml的xpack.security.enabled属性设置为false

xpack.security.enabled：
● 默认true：必须使用账号连接ES
● 若为false：必须使用http://localhost:9200/访问ES服务+启动Kibana服务会失败+不需要使用账号连接，但必须使用HTTP连接

  1. 配置：web模块dev目录application-dal添加
spring:elasticsearch:uris:- http://127.0.0.1:9200
  1. 新建：web模块test目录新建ElasticsearchTemplateTest
import cn.bytewisehub.pai.web.TestEntity.ESTestEntity;
import cn.bytewisehub.pai.web.TestRepository.ESTestRepository;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.data.elasticsearch.client.elc.ElasticsearchTemplate;@SpringBootTest
public class ElasticsearchTemplateTest {@AutowiredESTestRepository esTestRepository;@AutowiredElasticsearchTemplate elasticsearchTemplate;@Testvoid save() {ESTestEntity esTestEntity = new ESTestEntity();esTestEntity.setId(1L);esTestEntity.setContent("不安全连接");esTestEntity.setTitle("world");esTestEntity.setExcerpt("test");System.out.println(elasticsearchTemplate.save(esTestEntity));}@Testvoid insert() {ESTestEntity esTestEntity = new ESTestEntity();esTestEntity.setId(2L);esTestEntity.setContent("不安全连接");esTestEntity.setTitle("world");esTestEntity.setExcerpt("test");System.out.println(esTestRepository.save(esTestEntity));}
}
  1. 访问：点击http://localhost:9200/test/_search ---查询索引库test
    请添加图片描述

HTTP连接ES

  1. 配置：ES Elasticsearch.yml的xpack.security.enabled属性使用默认值+ xpack.security.http.ssl.enabled设置为false

ES Elasticsearch.yml的xpack.security.http.ssl.enabled：
● 默认true：必须使用https://localhost:9200/访问ES服务+启动Kibana服务会成功+需要使用账号连接+必须使用HTTPS连接
● 若为false：必须使用http://localhost:9200/访问ES服务+启动Kibana服务会失败+需要使用账号连接，但必须使用HTTP连接

  1. 配置：web模块dev目录application-dal添加
spring:elasticsearch:uris:- http://127.0.0.1:9200username:  # 账号用户名password:  #账号密码
  1. 修改：web模块test目录下ElasticsearchTemplateTest修改成这样，其他参见直接连接
import cn.bytewisehub.pai.web.TestEntity.ESTestEntity;
import cn.bytewisehub.pai.web.TestRepository.ESTestRepository;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.data.elasticsearch.client.elc.ElasticsearchTemplate;@SpringBootTest
public class ElasticsearchTemplateTest {@AutowiredESTestRepository esTestRepository;@AutowiredElasticsearchTemplate elasticsearchTemplate;@Testvoid save() {ESTestEntity esTestEntity = new ESTestEntity();esTestEntity.setId(1L);esTestEntity.setContent("不安全连接");esTestEntity.setTitle("world");esTestEntity.setExcerpt("test");System.out.println(elasticsearchTemplate.save(esTestEntity));}@Testvoid insert() {ESTestEntity esTestEntity = new ESTestEntity();esTestEntity.setId(2L);esTestEntity.setContent("不安全连接");esTestEntity.setTitle("world");esTestEntity.setExcerpt("test");System.out.println(esTestRepository.save(esTestEntity));}
}
  1. 访问：点击http://localhost:9200/test/_search ---查询索引库test

HTTPS连接ES

  1. 配置：ES Elasticsearch.yml的xpack.security.enabled和xpack.security.http.ssl.enabled属性使用默认值
  2. 配置：web模块dev目录application-dal添加
spring:elasticsearch:uris:- https://127.0.0.1:9200username:  # 账号用户名password:  #账号密码
  1. 修改：web模块test目录下ElasticsearchTemplateTest修改成这样，其他参见直接连接
import cn.bytewisehub.pai.web.TestEntity.ESTestEntity;
import cn.bytewisehub.pai.web.TestRepository.ESTestRepository;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.data.elasticsearch.client.elc.ElasticsearchTemplate;@SpringBootTest
public class ElasticsearchTemplateTest {@AutowiredESTestRepository esTestRepository;@AutowiredElasticsearchTemplate elasticsearchTemplate;@Testvoid save() {ESTestEntity esTestEntity = new ESTestEntity();esTestEntity.setId(1L);esTestEntity.setContent("不安全连接");esTestEntity.setTitle("world");esTestEntity.setExcerpt("test");System.out.println(elasticsearchTemplate.save(esTestEntity));}@Testvoid insert() {ESTestEntity esTestEntity = new ESTestEntity();esTestEntity.setId(2L);esTestEntity.setContent("不安全连接");esTestEntity.setTitle("world");esTestEntity.setExcerpt("test");System.out.println(esTestRepository.save(esTestEntity));}
}
  1. 访问：点击http://localhost:9200/test/_search ---查询索引库test

这篇关于SpringBoot3整合Elasticsearch8.x之全面保姆级教程的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/815095。

相关文章

Vue项目的甘特图组件之dhtmlx-gantt使用教程和实现效果展示(推荐)

Vue项目的甘特图组件之dhtmlx-gantt使用教程和实现效果展示(推荐)

《Vue项目的甘特图组件之dhtmlx-gantt使用教程和实现效果展示(推荐)》文章介绍了如何使用dhtmlx-gantt组件来实现公司的甘特图需求,并提供了一个简单的Vue组件示例,文章还分享了一... 目录一、首先 npm 安装插件二、创建一个vue组件三、业务页面内 引用自定义组件：四、dhtmlx
阅读更多...
Spring Boot 3 整合 Spring Cloud Gateway实践过程

Spring Boot 3 整合 Spring Cloud Gateway实践过程

《SpringBoot3整合SpringCloudGateway实践过程》本文介绍了如何使用SpringCloudAlibaba2023.0.0.0版本构建一个微服务网关,包括统一路由、限... 目录引子为什么需要微服务网关实践1.统一路由2.限流防刷3.登录鉴权小结引子当前微服务架构已成为中大型系统的标
阅读更多...
MySQL zip安装包配置教程

MySQL zip安装包配置教程

《MySQLzip安装包配置教程》这篇文章详细介绍了如何使用zip安装包在Windows11上安装MySQL8.0,包括下载、解压、配置环境变量、初始化数据库、安装服务以及更改密码等步骤,感兴趣的朋... 目录mysql zip安装包配置教程1、下载zip安装包：2、安装2.1 解压zip包到安装目录2.2
阅读更多...
Java使用Tesseract-OCR实战教程

Java使用Tesseract-OCR实战教程

《Java使用Tesseract-OCR实战教程》本文介绍了如何在Java中使用Tesseract-OCR进行文本提取,包括Tesseract-OCR的安装、中文训练库的配置、依赖库的引入以及具体的代... 目录Java使用Tesseract-OCRTesseract-OCR安装配置中文训练库引入依赖代码实
阅读更多...
SpringBoot整合easy-es的详细过程

SpringBoot整合easy-es的详细过程

《SpringBoot整合easy-es的详细过程》本文介绍了EasyES,一个基于Elasticsearch的ORM框架,旨在简化开发流程并提高效率,EasyES支持SpringBoot框架,并提供... 目录一、easy-es简介二、实现基于Spring Boot框架的应用程序代码1.添加相关依赖2.添
阅读更多...
SpringBoot中整合RabbitMQ(测试+部署上线最新完整)的过程

SpringBoot中整合RabbitMQ(测试+部署上线最新完整)的过程

《SpringBoot中整合RabbitMQ(测试+部署上线最新完整)的过程》本文详细介绍了如何在虚拟机和宝塔面板中安装RabbitMQ,并使用Java代码实现消息的发送和接收,通过异步通讯,可以优化... 目录一、RabbitMQ安装二、启动RabbitMQ三、javascript编写Java代码1、引入
阅读更多...
Ubuntu固定虚拟机ip地址的方法教程

Ubuntu固定虚拟机ip地址的方法教程

《Ubuntu固定虚拟机ip地址的方法教程》本文详细介绍了如何在Ubuntu虚拟机中固定IP地址,包括检查和编辑`/etc/apt/sources.list`文件、更新网络配置文件以及使用Networ... 1、由于虚拟机网络是桥接，所以ip地址会不停地变化，接下来我们就讲述ip如何固定 2、如果apt安
阅读更多...
PyCharm 接入 DeepSeek最新完整教程

PyCharm 接入 DeepSeek最新完整教程

《PyCharm接入DeepSeek最新完整教程》文章介绍了DeepSeek-V3模型的性能提升以及如何在PyCharm中接入和使用DeepSeek进行代码开发,本文通过图文并茂的形式给大家介绍的... 目录DeepSeek-V3效果演示创建API Key在PyCharm中下载Continue插件配置Con
阅读更多...
Deepseek R1模型本地化部署+API接口调用详细教程(释放AI生产力)

Deepseek R1模型本地化部署+API接口调用详细教程(释放AI生产力)

《DeepseekR1模型本地化部署+API接口调用详细教程(释放AI生产力)》本文介绍了本地部署DeepSeekR1模型和通过API调用将其集成到VSCode中的过程,作者详细步骤展示了如何下载和... 目录前言一、deepseek R1模型与chatGPT o1系列模型对比二、本地部署步骤1.安装oll
阅读更多...
在不同系统间迁移Python程序的方法与教程

在不同系统间迁移Python程序的方法与教程

《在不同系统间迁移Python程序的方法与教程》本文介绍了几种将Windows上编写的Python程序迁移到Linux服务器上的方法,包括使用虚拟环境和依赖冻结、容器化技术（如Docker）、使用An... 目录使用虚拟环境和依赖冻结1. 创建虚拟环境2. 冻结依赖使用容器化技术（如 docker）1. 创
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2