RestClient操作文档
前言:
文档操作(Document)与索引库(mapper)之间的关系
索引库(mapper)映射文件指定了具体的字段是什么类型的,和是否需要索引以及他的分词方式是什么
==文档操作(Document)==指定是我们字段所对应的一个具体信息,我们的信息是需要通过索引库映射文件来进行拆分的和排索引的
1、新增文档
为了与创建索引库操作分离,我们再次参加一个测试类HotelDocumentTest
,做两件事情:
-
初始化RestHighLevelClient
-
我们的酒店数据在数据库,需要利用IHotelService去查询数据库中的信息,所以注入这个接口,使用MP插件快速开发查询
-
原来我们定义的
Hotel
实体类是不符合创建文档格式的,因为我们的(经纬度问题在原来的实体类上是分开的,而文档上我们需要是合在一起),需要定义一个新的实体类来拼接经纬度字段longitude和latitude需要合并为locationpackage cn.itcast.hotel.pojo; import lombok.Data; import lombok.NoArgsConstructor; @Data @NoArgsConstructor public class HotelDoc { private Long id; private String name; private String address; private Integer price; private Integer score; private String brand; private String city; private String starName; private String business; private String location; private String pic; public HotelDoc(Hotel hotel) { this.id = hotel.getId(); this.name = hotel.getName(); this.address = hotel.getAddress(); this.price = hotel.getPrice(); this.score = hotel.getScore(); this.brand = hotel.getBrand(); this.city = hotel.getCity(); this.starName = hotel.getStarName(); this.business = hotel.getBusiness(); this.location = hotel.getLatitude() + ", " + hotel.getLongitude(); this.pic = hotel.getPic(); } }
新增语法说明:
POST /{
索引库名}/_doc/1
{
"name": "Jack",
"age": 21
}
可以看到与创建索引库类似,同样是三步走:
- 1)创建Request对象
- 2)准备请求参数,也就是DSL中的JSON文档
- 3)发送请求
变化的地方在于,这里直接使用client.xxx()的API,不再需要client.indices()了。
我们导入酒店数据,基本流程一致,但是需要考虑几点变化:
- 酒店数据来自于数据库,我们需要先查询出来,得到hotel对象
- hotel对象需要转为HotelDoc对象
- HotelDoc需要序列化为json格式
因此,代码整体步骤如下:
- 1)根据id查询酒店数据Hotel
- 2)将Hotel封装为HotelDoc
- 3)将HotelDoc序列化为JSON
- 4)创建IndexRequest,指定索引库名和id
- 5)准备请求参数,也就是JSON文档
- 6)发送请求
package cn.itcast.hotel;
import cn.itcast.hotel.pojo.Hotel;
import cn.itcast.hotel.pojo.HotelDoc;
import cn.itcast.hotel.service.impl.HotelService;
import com.alibaba.fastjson.JSON;
import org.apache.http.HttpHost;
import org.elasticsearch.action.index.IndexRequest;
import org.elasticsearch.client.RequestOptions;
import org.elasticsearch.client.RestClient;
import org.elasticsearch.client.RestHighLevelClient;
import org.elasticsearch.common.xcontent.XContentType;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import java.io.IOException;
/**
* 项目名称:hotel-demo
* 描述:文档操作
*
* @author zhong
* @date 2022-06-02 12:58
*/
@SpringBootTest
public class HotelDocumentTest {
/**
* 注入MP插件的查询信息
*/
@Autowired
HotelService hotelService;
private RestHighLevelClient client;
/**
* 执行之前进行连接
*/
@BeforeEach
void setUp(){
this.client = new RestHighLevelClient(RestClient.builder(
HttpHost.create("http://192.168.26.131:9200")
));
}
/**
* 新增文档
*/
@Test
void testAddDocument() throws IOException {
// 查询酒店信息
Hotel hotel = hotelService.getById(38609L);
System.out.println(hotel);
// 转换文档类型
HotelDoc hotelDoc = new HotelDoc(hotel);
// 1、创建对象
IndexRequest request = new IndexRequest("hotel").id(hotelDoc.getId().toString());
// 2、设置json文档
request.source(JSON.toJSONString(hotelDoc),XContentType.JSON);
// 3、发送文档
client.index(request,RequestOptions.DEFAULT);
}
/**
* 执行完之后销毁
* @throws IOException
*/
@AfterEach
void tearDown() throws IOException {
this.client.close();
}
}
根据文档id查询到新增的文档信息
# 查询文档下信息
GET /hotel/_doc/38609
查询效果如下:
{
"_index" : "hotel",
"_type" : "_doc",
"_id" : "38609",
"_version" : 1,
"_seq_no" : 0,
"_primary_term" : 1,
"found" : true,
"_source" : {
"address" : "广灵二路126号",
"brand" : "速8",
"business" : "四川北路商业区",
"city" : "上海",
"id" : 38609,
"location" : "31.282444, 121.479385",
"name" : "速8酒店(上海赤峰路店)",
"pic" : "https://m.tuniucdn.com/fb2/t1/G2/M00/DF/96/Cii-TFkx0ImIQZeiAAITil0LM7cAALCYwKXHQ4AAhOi377_w200_h200_c1_t0.jpg",
"price" : 249,
"score" : 35,
"starName" : "二钻"
}
}
2、查询文档
查询的DSL语句如下:
GET /hotel/_doc/{id}
非常简单,因此代码大概分两步:
- 准备Request对象
- 发送请求
不过查询的目的是得到结果,解析为HotelDoc,因此难点是结果的解析。完整代码如下:
/**
* 根据id查询文档信息
*/
@Test
void testGetDocumentById() throws IOException {
// 1、准备request
GetRequest request = new GetRequest("hotel", "38609");
// 2、发送请求,得到响应
GetResponse response = client.get(request, RequestOptions.DEFAULT);
// 3、解析响应结过
String sourceAsString = response.getSourceAsString();
// 4、返回对象类型
HotelDoc hotelDoc = JSON.parseObject(sourceAsString, HotelDoc.class);
System.out.println("查询文档的结果:"+hotelDoc);
}
可以看到,结果是一个JSON,其中文档放在一个_source
属性中,因此解析就是拿到_source
,反序列化为Java对象即可。
与之前类似,也是三步走:
- 1)准备Request对象。这次是查询,所以是GetRequest
- 2)发送请求,得到结果。因为是查询,这里调用client.get()方法
- 3)解析结果,就是对JSON做反序列化
3、删除文档
删除的DSL为是这样的:
DELETE /hotel/_doc/{id}
与查询相比,仅仅是请求方式从DELETE变成GET,可以想象Java代码应该依然是三步走:
- 1)准备Request对象,因为是删除,这次是DeleteRequest对象。要指定索引库名和id
- 2)准备参数,无参
- 3)发送请求。因为是删除,所以是client.delete()方法
在hotel-demo的HotelDocumentTest测试类中,编写单元测试:
@Test
void testDeleteDocument() throws IOException {
// 1.准备Request
DeleteRequest request = new DeleteRequest("hotel", "61083");
// 2.发送请求
client.delete(request, RequestOptions.DEFAULT);
}
4、修改文档
语法说明
修改我们讲过两种方式:
- 全量修改:本质是先根据id删除,再新增
- 增量修改:修改文档中的指定字段值
在RestClient的API中,全量修改与新增的API完全一致,判断依据是ID:
- 如果新增时,ID已经存在,则修改
- 如果新增时,ID不存在,则新增
这里不再赘述,我们主要关注全局修改。
代码如下所示:
/**
* 根据id修改代码
*/
@Test
void upDaupdateById() throws IOException {
// 1、准备req
UpdateRequest request = new UpdateRequest("hotel", "38609");
// 2、准备修改的参数
request.doc(
"price","300",
"city","广州"
);
// 3、发送请求
client.update(request, RequestOptions.DEFAULT);
}
5.、删除文档
/**
* 删除文档
*/
@Test
void testDelectById() throws IOException {
// 1、获取req
DeleteRequest request = new DeleteRequest("hotel", "38609");
// 2、发送请求
client.delete(request, RequestOptions.DEFAULT);
}
6、批量导入文档
案例需求:利用BulkRequest批量将数据库数据导入到索引库中。
步骤如下:
-
利用mybatis-plus查询酒店数据
-
将查询到的酒店数据(Hotel)转换为文档类型数据(HotelDoc)
-
利用JavaRestClient中的BulkRequest批处理,实现批量新增文档
6.1、语法说明
批量处理BulkRequest,其本质就是将多个普通的CRUD请求组合在一起发送。
其中提供了一个add方法,用来添加其他请求:
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-miqcpHR9-1654156804602)(images/image-20220602153520940.png)]
可以看到,能添加的请求包括:
- IndexRequest,也就是新增
- UpdateRequest,也就是修改
- DeleteRequest,也就是删除
因此Bulk中添加了多个IndexRequest,就是批量新增功能了。示例:
/**
* 批量导入数据
*/
@Test
void testBulkRequest() throws IOException {
// 调用MP插件的查询所有数据
List<Hotel> hotelList = hotelService.list();
// 1、创建request
BulkRequest request = new BulkRequest();
// 2、封装参数,一起提交
for (Hotel hotel : hotelList) {
// 转换类型
HotelDoc hotelDoc = new HotelDoc(hotel);
// 创建新增文档的对象信息
request.add(new IndexRequest("hotel")
.id(hotelDoc.getId().toString())
.source(JSON.toJSONString(hotelDoc),XContentType.JSON));
}
// 3、发送请求
client.bulk(request, RequestOptions.DEFAULT);
}
其实还是三步走:
- 1)创建Request对象。这里是BulkRequest
- 2)准备参数。批处理的参数,就是其它Request对象,这里就是多个IndexRequest
- 3)发起请求。这里是批处理,调用的方法为client.bulk()方法
我们在导入酒店数据时,将上述代码改造成for循环处理即可。
在Dev Tools
页面上可以通过下面的语句查询所有的数据
# 查询所有数据
GET /hotel/_search
小结
文档操作的基本步骤:
- 初始化RestHighLevelClient
- 创建XxxRequest。XXX是Index、Get、Update、Delete、Bulk
- 准备参数(Index、Update、Bulk时需要)
- 发送请求。调用RestHighLevelClient#.xxx()方法,xxx是index、get、update、delete、bulk
- 解析结果(Get时需要)