devbox
IT小白
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

SpringBoot整合ES（REST Client方式）并实现简单的增删改查_springboot集成restclient username password

作者：IT小白 | 2024-02-08 11:04:07

赞

踩

springboot集成restclient username password

首先有三种方式可以实现在java代码里操作ES，分别是Java API(TransportClient客户端)，REST Client以及Data-ES，对于第一种，ES官方表示将在ES 8.0版本弃用，所以不是我们学习的重点。至于Data-ES，虽然它和SpringBoot集成的很好，容易上手，而且提供了很方便的api，但是据说不支持ES的权限数据，如果只是很简单的获取普通数据，Data-ES将是很好的一个方式。但如果需要获取权限数据呢？

集成准备工作

首先pom依赖如下

  1.     <dependencies>
  2.         <!-- springboot相关 -->
  3.         <dependency>
  4.             <groupId>org.springframework.boot</groupId>
  5.             <artifactId>spring-boot-starter</artifactId>
  6.         </dependency>
  7.         <dependency>
  8.             <groupId>org.springframework.boot</groupId>
  9.             <artifactId>spring-boot-starter-test</artifactId>
  10.             <scope>test</scope>
  11.         </dependency>
  12.         <dependency>
  13.             <groupId>org.springframework.boot</groupId>
  14.             <artifactId>spring-boot-starter-web</artifactId>
  15.         </dependency>
  16.         <!--yml文件进行配置需要用到的依赖-->
  17.         <dependency>
  18.             <groupId>org.springframework.boot</groupId>
  19.             <artifactId>spring-boot-configuration-processor</artifactId>
  20.             <optional>true</optional>
  21.         </dependency>
  22.         <!-- elasticsearch -->
  23.         <dependency>
  24.             <groupId>org.elasticsearch</groupId>
  25.             <artifactId>elasticsearch</artifactId>
  26.             <version>6.8.4</version>
  27.         </dependency>
  28.         <dependency>
  29.             <groupId>org.elasticsearch.client</groupId>
  30.             <artifactId>elasticsearch-rest-client</artifactId>
  31.             <version>6.8.4</version>
  32.         </dependency>
  33.         <dependency>
  34.             <groupId>org.elasticsearch.plugin</groupId>
  35.             <artifactId>reindex-client</artifactId>
  36.             <version>6.8.4</version>
  37.         </dependency>
  38.         <!-- 工具包 -->
  39.         <dependency>
  40.             <groupId>com.alibaba</groupId>
  41.             <artifactId>fastjson</artifactId>
  42.             <version>1.2.54</version>
  43.         </dependency>
  44.         <dependency>
  45.             <groupId>org.apache.commons</groupId>
  46.             <artifactId>commons-lang3</artifactId>
  47.         </dependency>
  48.         <dependency>
  49.             <groupId>org.projectlombok</groupId>
  50.             <artifactId>lombok</artifactId>
  51.             <optional>true</optional>
  52.         </dependency>
  53.         <!-- swagger -->
  54.         <dependency>
  55.             <groupId>io.springfox</groupId>
  56.             <artifactId>springfox-swagger2</artifactId>
  57.             <version>2.7.0</version>
  58.         </dependency>
  59.         <dependency>
  60.             <groupId>io.springfox</groupId>
  61.             <artifactId>springfox-swagger-ui</artifactId>
  62.             <version>2.7.0</version>
  63.         </dependency>
  64.         <dependency>
  65.             <groupId>io.springfox</groupId>
  66.             <artifactId>springfox-staticdocs</artifactId>
  67.             <version>2.4.0</version>
  68.         </dependency>
  69.         <dependency>
  70.             <groupId>io.github.robwin</groupId>
  71.             <artifactId>assertj-swagger</artifactId>
  72.             <version>0.2.0</version>
  73.             <scope>test</scope>
  74.         </dependency>
  75.  
  76.     </dependencies>

然后是yml文件

  1. server:
  2.   port: 8080
  3.  
  4. swagger:
  5.   enable: true
  6.   title: ElasticSearch-demo
  7.   description:
  8.   serviceUrl: http://localhost:8080/
  9.   version: 1.0.0
  10.   controllers: com.example.es.controller
  11.  
  12. elasticsearch:
  13.   user:
  14.   password:
  15.   host: 192.168.145.128
  16.   port: 9200

PS:swagger和lombok是好东西

代码实现

配置类：

  1. @Configuration
  2. @Slf4j
  3. public class ESConfig {
  4.  
  5.     @Value("${elasticsearch.user}")
  6.     private String userName;
  7.     @Value("${elasticsearch.password}")
  8.     private String password;
  9.     @Value("${elasticsearch.host}")
  10.     private String host;
  11.     @Value("${elasticsearch.port}")
  12.     private Integer port;
  13.  
  14.     @Bean(name = "myClient")
  15.     public RestClient getRestClient() {
  16.         //基本的连接
  17.         RestClientBuilder clientBuilder = RestClient.builder(new HttpHost(host, port));
  18.         //配置身份验证
  19.         final CredentialsProvider credentialsProvider = new BasicCredentialsProvider();
  20.         credentialsProvider.setCredentials(AuthScope.ANY, new UsernamePasswordCredentials(userName, password));
  21.         clientBuilder.setHttpClientConfigCallback(
  22.                 httpClientBuilder -> httpClientBuilder.setDefaultCredentialsProvider(credentialsProvider));
  23.         //设置连接超时和套接字超时
  24.         clientBuilder.setRequestConfigCallback(builder -> builder.setConnectTimeout(10000).setSocketTimeout(60000));
  25.         //设置节点选择器
  26.         clientBuilder.setNodeSelector(NodeSelector.SKIP_DEDICATED_MASTERS);
  27.         //配置HTTP异步请求ES的线程数
  28.         clientBuilder.setHttpClientConfigCallback(
  29.                 httpAsyncClientBuilder -> httpAsyncClientBuilder.setDefaultIOReactorConfig(
  30.                         IOReactorConfig.custom().setIoThreadCount(1).build()));
  31.         //设置监听器，每次节点失败都可以监听到，可以作额外处理
  32.         clientBuilder.setFailureListener(new RestClient.FailureListener() {
  33.             @Override
  34.             public void onFailure(Node node) {
  35.                 super.onFailure(node);
  36.                 log.error(node.getHost() + "--->该节点失败了");
  37.             }
  38.         });
  39.  
  40.         return clientBuilder.build();
  41.     }
  42.  
  43.  
  44. }

这样的话，已经算是集成到springboot了，但是如何实现增删改查？

首先引入两个bean，后续的代码有用

Person类，这个是我们接下来要操作的实体类

  1. @Data
  2. public class Person {
  3.  
  4.     private String id;
  5.     private String name;
  6.     private String birthday;
  7.     private String addr;
  8.  
  9. }

SearchParam类，用于拼接请求内容，包括index,type和id

  1. @Data
  2. public class SearchParam {
  3.  
  4.     @ApiModelProperty("索引")
  5.     private String index;
  6.     @ApiModelProperty("类型")
  7.     private String type;
  8.     @ApiModelProperty("id")
  9.     private String id;
  10.  
  11. }

接下来是Controller层的代码

  1. @RestController
  2. @RequestMapping("/es")
  3. public class MyController {
  4.  
  5.     @Autowired
  6.     private MyService service;
  7.  
  8.     @PostMapping("/search")
  9.     @ApiOperation("根据id查询ES对应的数据")
  10.     public JSONObject getDataById(@RequestBody SearchParam param) {
  11.         return service.getDataById(param);
  12.     }
  13.  
  14.     @PostMapping("/add")
  15.     @ApiOperation("往ES里插入数据")
  16.     public ResponseEntity add(@RequestBody SearchParam param) {
  17.         return service.add(param);
  18.     }
  19.  
  20.     @PostMapping("/update")
  21.     @ApiOperation("根据id更新文档内容")
  22.     public ResponseEntity update(@RequestBody SearchParam param) {
  23.         return service.update(param);
  24.     }
  25.  
  26.     @PostMapping("/delete")
  27.     @ApiOperation("根据id更新文档内容")
  28.     public ResponseEntity delete(@RequestBody SearchParam param) {
  29.         return service.delete(param);
  30.     }
  31.  
  32.  
  33. }

重点来了，Service层，具体实现方法

在service类里，我们需要用到我们之前在config配置类里配置的bean，但是如果直接注入的话，spring会报如下错误

意思是spring不知道我们现在用哪个类，对于这个报错，我们做如下处理

  1. @Service
  2. @Slf4j
  3. public class MyService {
  4.  
  5.     @Qualifier("myClient")
  6.     @Autowired
  7.     private RestClient client;
  8. 	
  9. }

用@Qualifier注解来指定具体要注入哪个bean

通过id查询：

  1.     /**
  2.      * 根据id查询文档内容
  3.      *
  4.      * @param param
  5.      * @return
  6.      */
  7.     public JSONObject getDataById(SearchParam param) {
  8.         //拼接查询内容
  9.         String body = param.getIndex() + "/" + param.getType() + "/" + param.getId();
  10.         Request request = new Request("GET", body);
  11.         JSONObject jsonObject = new JSONObject();
  12.         try {
  13.             Response response = client.performRequest(request);
  14.             String responseBody = EntityUtils.toString(response.getEntity(), "UTF-8");
  15.             JSONObject json = JSONObject.parseObject(responseBody);
  16.             //获取我们需要的内容
  17.             Object source = json.get("_source");
  18.             jsonObject = JSONObject.parseObject(source.toString());
  19.         } catch (IOException e) {
  20.             log.error(e.getMessage());
  21.         }
  22.         return jsonObject;
  23.     }

添加文档：

  1.     /**
  2.      * 添加文档
  3.      *
  4.      * @param param
  5.      * @return
  6.      */
  7.     public ResponseEntity add(SearchParam param) {
  8.         Person person = new Person();
  9.         person.setName("朱元璋");
  10.         person.setAddr("安徽凤阳");
  11.         person.setBirthday("1328-10-29");
  12.         person.setId("1234567890");
  13.         //以bean的id为该文档的id,以便查询
  14.         String body = param.getIndex() + "/" + param.getType() + "/" + person.getId();
  15.         String responseBody = "";
  16.         try {
  17.             Request request = new Request("POST", body);
  18.             JSONObject jsonObject = (JSONObject) JSONObject.toJSON(person);
  19.             //设置请求体并指定ContentType和编码格式
  20.             request.setEntity(new NStringEntity(jsonObject.toString(), "UTF-8"));
  21.             Response response = client.performRequest(request);
  22.             //获取响应体
  23.             responseBody = EntityUtils.toString(response.getEntity());
  24.         } catch (IOException e) {
  25.             log.error(e.getMessage());
  26.         }
  27.         return new ResponseEntity<>(responseBody, HttpStatus.OK);
  28.     }

根据id更新文档内容：

  1.     /**
  2.      * 根据id更新文档内容
  3.      *
  4.      * @param param
  5.      * @return
  6.      */
  7.     public ResponseEntity update(SearchParam param) {
  8.         Person person = new Person();
  9.         person.setName("朱棣");
  10.         person.setAddr("南京");
  11.         person.setBirthday("1360-05-02");
  12.         //需要更新对应的id
  13.         String body = param.getIndex() + "/" + param.getType() + "/" + param.getId() + "/_update";
  14.         String responseBody = "";
  15.         try {
  16.             //构造http请求
  17.             Request request = new Request("POST", body);
  18.             JSONObject json = (JSONObject) JSONObject.toJSON(person);
  19.             JSONObject jsonObject = new JSONObject();
  20.             //将数据由"doc"包住，以便内部识别
  21.             jsonObject.put("doc", json);
  22.             request.setEntity(new NStringEntity(jsonObject.toString(), "UTF-8"));
  23.             Response response = client.performRequest(request);
  24.             //获取响应体
  25.             responseBody = EntityUtils.toString(response.getEntity());
  26.         } catch (Exception e) {
  27.             log.error(e.getMessage());
  28.         }
  29.         return new ResponseEntity<>(responseBody, HttpStatus.OK);
  30.     }
 

根据id删除对应文档：

  1.     /**
  2.      * 根据id删除文档
  3.      *
  4.      * @param param
  5.      * @return
  6.      */
  7.     public ResponseEntity delete(SearchParam param) {
  8.         String body = param.getIndex() + "/" + param.getType() + "/" + param.getId();
  9.         String responseBody = "";
  10.         try {
  11.             Request request = new Request("DELETE", body);
  12.             // 执行HTTP请求
  13.             Response response = client.performRequest(request);
  14.             // 获取结果
  15.             responseBody = EntityUtils.toString(response.getEntity());
  16.         } catch (IOException e) {
  17.             log.error(e.getMessage());
  18.         }
  19.         return new ResponseEntity<>(responseBody, HttpStatus.OK);
  20.     }

好了，简单的增删改查已经可以实现了，而且对于增删改这三种操作来说，以上的方法已经基本够用了，但是对于查询的操作，远远不够，比如我不知道文档的id，我需要通过name="张三"这个条件查询出所有符合条件的文档内容来，还有我需要知道出生日期在1990-1991年之间的，如此种种，上述方法不可能实现。

关于复杂查询的，SpringBoot工程整合ElasticSearch(通过Rest-High-Level-Client)并实现较复杂的查询​​​​​​​

 

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/IT小白/article/detail/68723
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号