https://github.com/notepad-plus-plus/notepad-plus-plus/releases
nodep++下载地址
GitHub - javastacks/spring-boot-best-practice: Spring Boot 最佳实践,包括自动配置、核心原理、源码分析、国际化支持、调试、日志集成、热部署等。
1. Mapping映射属性
mapping是对索引库中文档的约束,常见的mapping属性包括:
- type:字段数据类型,常见的简单类型有:
- 字符串:text(可分词的文本)、keyword(精确值,例如:品牌、国家、ip地址)
keyword类型只能整体搜索,不支持搜索部分内容
-
- 数值:long、integer、short、byte、double、float、
- 布尔:boolean
- 日期:date
- 对象:object
- index:是否创建索引,默认为true
- analyzer:使用哪种分词器
- properties:该字段的子字段
例如下面的json文档:
{
"age": 21,
"weight": 52.1,
"isMarried": false,
"info": "真相只有一个!",
"email": "zy@itcast.cn",
"score": [99.1, 99.5, 98.9],
"name": {
"firstName": "柯",
"lastName": "南"
}
}
对应的每个字段映射(mapping):
- age:类型为 integer;参与搜索,因此需要index为true;无需分词器
- weight:类型为float;参与搜索,因此需要index为true;无需分词器
- isMarried:类型为boolean;参与搜索,因此需要index为true;无需分词器
- info:类型为字符串,需要分词,因此是text;参与搜索,因此需要index为true;分词器可以用ik_smart
- email:类型为字符串,但是不需要分词,因此是keyword;不参与搜索,因此需要index为false;无需分词器
- score:虽然是数组,但是我们只看元素的类型,类型为float;参与搜索,因此需要index为true;无需分词器
- name:类型为object,需要定义多个子属性
- name.firstName;类型为字符串,但是不需要分词,因此是keyword;参与搜索,因此需要index为true;无需分词器
- name.lastName;类型为字符串,但是不需要分词,因此是keyword;参与搜索,因此需要index为true;无需分词器
2. 索引库的CRUD
CRUD简单描述:
- 创建索引库:PUT /索引库名
- 查询索引库:GET /索引库名
- 删除索引库:DELETE /索引库名
- 修改索引库(添加字段):PUT /索引库名/_mapping
这里统一使用Kibana编写DSL的方式来演示。
2.1 创建索引库和映射
基本语法:
- 请求方式:PUT
- 请求路径:/索引库名,可以自定义
- 请求参数:mapping映射
格式:
PUT /索引库名称
{
"mappings":
{
"properties":
{
"字段名":{
"type":
"text",
"analyzer":
"ik_smart"
},
"字段名2":{
"type":
"keyword",
"index":
"false"
},
"字段名3":{
"properties":
{
"子字段":
{
"type":
"keyword"
}
}
},
// ...略
}
}
}
示例:
PUT /conan
{
"mappings"
: {
"properties"
: {
"column1"
:{
"type"
:
"text",
"analyzer"
:
"ik_smart"
},
"column2"
:{
"type"
:
"keyword",
"index"
:
"false"
},
"column3"
:{
"properties"
: {
"子字段1"
: {
"type"
:
"keyword"
},
"子字段2"
: {
"type"
:
"keyword"
}
}
},
// ...略
}
}
}
2.2 查询索引库
基本语法:
- 请求方式:GET
- 请求路径:/索引库名
- 请求参数:无
格式:
GET/
索引库名
示例:
2.3 修改索引库
这里的修改是只能增加新的字段到mapping中
倒排索引结构虽然不复杂,但是一旦数据结构改变(比如改变了分词器),就需要重新创建倒排索引,这简直是灾难。因此索引库一旦创建,无法修改mapping。
虽然无法修改mapping中已有的字段,但是却允许添加新的字段到mapping中,因为不会对倒排索引产生影响。
语法说明:
PUT /索引库名/_mapping
{
"properties":
{
"新字段名":{
"type":
"integer"
}
}
}
示例:
2.4 删除索引库
语法:
- 请求方式:DELETE
- 请求路径:/索引库名
- 请求参数:无
格式:
copy
DELETE/
索引库名
在kibana中测试:
文档操作
文档操作有哪些?
- 创建文档:POST /{索引库名}/_doc/文档id
- 查询文档:GET /{索引库名}/_doc/文档id
- 删除文档:DELETE /{索引库名}/_doc/文档id
- 修改文档:
- 全量修改:PUT /{索引库名}/_doc/文档id
- 增量修改:POST /{索引库名}/_update/文档id { "doc": {字段}}
1. 文档的CRUD
1.1 新增文档
语法:
POST /索引库名/_doc/文档id
{
"字段1":
"值1",
"字段2":
"值2",
"字段3":
{
"子属性1":
"值3",
"子属性2":
"值4"
},
// ...
}
示例:
POST /heima/_doc/
1
{
"info":
"真相只有一个!",
"email":
"zy@itcast.cn",
"name":
{
"firstName":
"柯",
"lastName":
"南"
}
}
响应:
1.2 查询文档
根据rest风格,新增是post,查询应该是get,不过查询一般都需要条件,这里我们把文档id带上。
语法:
GET /
{索引库名称
}/_doc/
{id
}
//批量查询:查询该索引库下的全部文档
GET /
{索引库名称
}/_search
通过kibana查看数据:
GET /heima/_doc/
1
查看结果:
1.3 删除文档
删除使用DELETE请求,同样,需要根据id进行删除:
语法:
DELETE /{索引库名}/_doc/id值
示例:
# 根据id删除数据
DELETE /heima/_doc/
1
结果:
1.4 修改文档
修改有两种方式:
- 全量修改:直接覆盖原来的文档
- 增量修改:修改文档中的部分字段
1.4.1 全量修改
全量修改是覆盖原来的文档,其本质是:
- 根据指定的id删除文档
- 新增一个相同id的文档
注意:如果根据id删除时,id不存在,第二步的新增也会执行,也就从修改变成了新增操作了。
语法:
PUT /
{索引库名
}/_doc/文档id
{
"字段1":
"值1",
"字段2":
"值2",
// ... 略
}
示例:
PUT /heima/_doc/
1
{
"info":
"黑马程序员高级Java讲师",
"email":
"zy@itcast.cn",
"name":
{
"firstName":
"云",
"lastName":
"赵"
}
}
1.4.2 增量修改
增量修改是只修改指定id匹配的文档中的部分字段。
语法:
POST /
{索引库名
}/_update/文档id
{
"doc":
{
"字段名":
"新的值",
}
}
示例:
POST /heima/_update/
1
{
"doc":
{
"email":
"ZhaoYun@itcast.cn"
}
}
RestAPI
ES官方提供了各种不同语言的客户端,用来操作ES。这些客户端的本质就是组装DSL语句,通过http请求发送给ES。官方文档地址:Elasticsearch Clients | Elastic
其中的Java Rest Client又包括两种:
- Java Low Level Rest Client
- Java High Level Rest Client
我们使用的是Java HighLevel Rest Client客户端API
API操作索引库
JavaRestClient操作elasticsearch的流程基本类似。核心是client.indices()方法来获取索引库的操作对象。
索引库操作的基本步骤:【可以根据发送请求那步的第一个参数,发过来判断需要创建什么XXXXRequest】
- 初始化RestHighLevelClient
- 创建XxxIndexRequest。XXX是Create、Get、Delete
- 准备DSL( Create时需要,其它是无参)
- 发送请求。调用RestHighLevelClient#indices().xxx()方法,xxx是create、exists、delete
1. mapping映射分析
根据MySQL数据库表结构(建表语句),去写索引库结构JSON。表和索引库一一对应
注意:地理坐标、组合字段。索引库里的地理坐标是一个字段:坐标:维度
,
精度
。copy_to组合字段作用是供用户查询(输入关键字可以查询多个字段)
创建索引库,最关键的是mapping映射,而mapping映射要考虑的信息包括:
- 字段名
- 字段数据类型
- 是否参与搜索
- 是否需要分词
- 如果分词,分词器是什么?
其中:
- 字段名、字段数据类型,可以参考数据表结构的名称和类型
- 是否参与搜索要分析业务来判断,例如图片地址,就无需参与搜索
- 是否分词呢要看内容,内容如果是一个整体就无需分词,反之则要分词
- 分词器,我们可以统一使用ik_max_word
来看下酒店数据的索引库结构:
PUT /hotel
{
"mappings":
{
"properties":
{
"id":
{
"type":
"keyword"
},
"name":{
"type":
"text",
"analyzer":
"ik_max_word",
"copy_to":
"all"
},
"address":{
"type":
"keyword",
"index":
false
},
"price":{
"type":
"integer"
},
"score":{
"type":
"integer"
},
"brand":{
"type":
"keyword",
"copy_to":
"all"
},
"city":{
"type":
"keyword",
"copy_to":
"all"
},
"starName":{
"type":
"keyword"
},
"business":{
"type":
"keyword"
},
"location":{
"type":
"geo_point"
},
"pic":{
"type":
"keyword",
"index":
false
},
"all":{
"type":
"text",
"analyzer":
"ik_max_word"
}
}
}
}
几个特殊字段说明:
- location:地理坐标,里面包含精度、纬度
- all:一个组合字段,其目的是将多字段的值 利用copy_to合并,提供给用户搜索
地理坐标说明:
copy_to说明:
2.初始化RestClient
在elasticsearch提供的API中,与elasticsearch一切交互都封装在一个名为RestHighLevelClient的类中,必须先完成这个对象的初始化,建立与elasticsearch的连接。
分为三步:
1)引入es的RestHighLevelClient依赖:
<dependency>
<groupId>
org.elasticsearch.client
</groupId>
<artifactId>
elasticsearch-rest-high-level-client
</artifactId>
</dependency>
2)因为SpringBoot默认的ES版本是7.6.2,所以我们需要覆盖默认的ES版本:
<properties>
<java.version>
1.8
</java.version>
<elasticsearch.version>
7.12.1
</elasticsearch.version>
</properties>
3)初始化RestHighLevelClient:这里一般在启动类或者配置类里注入该Bean,用于告诉Java 访问ES的ip地址
初始化的代码如下:
@Bean
publicRestHighLevelClient
client(){
return
new
RestHighLevelClient
(RestClient.builder(
HttpHost.create(
"http://192.168.150.101:9200")
));
}
这里为了单元测试方便,我们创建一个测试类HotelIndexTest,然后将初始化的代码编写在@BeforeEach方法中:
package cn.itcast.hotel;
import org.apache.http.HttpHost;
import org.elasticsearch.client.RestHighLevelClient;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import java.io.IOException;
publicclass
HotelIndexTest
{
private
RestHighLevelClient client;
@BeforeEach
void
setUp()
{
this
.client =
newRestHighLevelClient
(RestClient.builder(
HttpHost.create(
"http://192.168.150.101:9200")
));
}
@AfterEach
void
tearDown()
throws
IOException {
this
.client.close();
}
}
3. 索引库CRUD
3.1 创建索引库
代码分为三步:
- 1)创建Request对象。因为是创建索引库的操作,因此Request是CreateIndexRequest。
- 2)添加请求参数,其实就是DSL的JSON参数部分。因为json字符串很长,这里是定义了静态字符串常量MAPPING_TEMPLATE,让代码看起来更加优雅。
- 3)发送请求,client.indices()方法的返回值是IndicesClient类型,封装了所有与索引库操作有关的方法。
创建索引库的API如下:
代码:
在hotel-demo的cn.itcast.hotel.constants包下,创建一个类,定义mapping映射的JSON字符串常量:
package cn.itcast.hotel.constants;
publicclass
HotelConstants
{
public
static
final
String
MAPPING_TEMPLATE
=
"{\n"
+
" \"mappings\": {\n"
+
" \"properties\": {\n"
+
" \"id\": {\n"
+
" \"type\": \"keyword\"\n"
+
" },\n"
+
" \"name\":{\n"
+
" \"type\": \"text\",\n"
+
" \"analyzer\": \"ik_max_word\",\n"
+
" \"copy_to\": \"all\"\n"
+
" },\n"
+
" \"address\":{\n"
+
" \"type\": \"keyword\",\n"
+
" \"index\": false\n"
+
" },\n"
+
" \"price\":{\n"
+
" \"type\": \"integer\"\n"
+
" },\n"
+
" \"score\":{\n"
+
" \"type\": \"integer\"\n"
+
" },\n"
+
" \"brand\":{\n"
+
" \"type\": \"keyword\",\n"
+
" \"copy_to\": \"all\"\n"
+
" },\n"
+
" \"city\":{\n"
+
" \"type\": \"keyword\",\n"
+
" \"copy_to\": \"all\"\n"
+
" },\n"
+
" \"starName\":{\n"
+
" \"type\": \"keyword\"\n"
+
" },\n"
+
" \"business\":{\n"
+
" \"type\": \"keyword\"\n"
+
" },\n"
+
" \"location\":{\n"
+
" \"type\": \"geo_point\"\n"
+
" },\n"
+
" \"pic\":{\n"
+
" \"type\": \"keyword\",\n"
+
" \"index\": false\n"
+
" },\n"
+
" \"all\":{\n"
+
" \"type\": \"text\",\n"
+
" \"analyzer\": \"ik_max_word\"\n"
+
" }\n"
+
" }\n"
+
" }\n"
+
"}"
;
}
在hotel-demo中的HotelIndexTest测试类中,编写单元测试,实现创建索引:
@Test
voidcreateHotelIndex()
throws
IOException {
// 1.创建Request对象
CreateIndexRequest
request
=
new
CreateIndexRequest
(
"hotel");
// 2.准备请求的参数:DSL语句
request.source(MAPPING_TEMPLATE, XContentType.JSON);
// 3.发送请求
client.indices().create(request, RequestOptions.DEFAULT);
}
3.2 删除索引库
三步走:
- 1)创建Request对象。这次是DeleteIndexRequest对象
- 2)准备参数。这里是无参
- 3)发送请求。改用delete方法
删除索引库的DSL语句非常简单:
DELETE /hotel
在hotel-demo中的HotelIndexTest测试类中,编写单元测试,实现删除索引:
@Test
voidtestDeleteHotelIndex()
throws
IOException {
// 1.创建Request对象
DeleteIndexRequest
request
=
new
DeleteIndexRequest
(
"hotel");
// 2.发送请求
client.indices().delete(request, RequestOptions.DEFAULT);
}
3.3 查询索引库
三步走:
- 1)创建Request对象。这次是GetIndexRequest对象
- 2)准备参数。这里是无参
- 3)发送请求。改用exists方法
判断索引库是否存在,本质就是查询,对应的DSL是:
GET /hotel
@Test
voidtestExistsHotelIndex()
throws
IOException {
// 1.创建Request对象
GetIndexRequest
request
=
new
GetIndexRequest
(
"hotel");
// 2.发送请求
boolean
exists
=
client.indices().exists(request, RequestOptions.DEFAULT);
// 3.输出
System.err.println(exists ?
"索引库已经存在!":
"索引库不存在!");
}
API操作文档
这里更多的是先读取Mysql中的数据,然后再存进ES中。
文档操作的基本步骤:【可以根据发送请求那步的第一个参数,发过来判断需要创建什么XXXXRequest】
- 初始化RestHighLevelClient
- 创建XxxRequest。XXX是Index、Get、Update、Delete、Bulk
- 准备参数(Index、Update、Bulk时需要)
- 发送请求。调用RestHighLevelClient#.xxx()方法,xxx是index、get、update、delete、bulk
- 解析结果(Get时需要)
1. 初始化RestClient
在elasticsearch提供的API中,与elasticsearch一切交互都封装在一个名为RestHighLevelClient的类中,必须先完成这个对象的初始化,建立与elasticsearch的连接。
分为三步:
1)引入es的RestHighLevelClient依赖:
<dependency>
<groupId>
org.elasticsearch.client
</groupId>
<artifactId>
elasticsearch-rest-high-level-client
</artifactId>
</dependency>
2)因为SpringBoot默认的ES版本是7.6.2,所以我们需要覆盖默认的ES版本:
<properties>
<java.version>
1.8
</java.version>
<elasticsearch.version>
7.12.1
</elasticsearch.version>
</properties>
3)初始化RestHighLevelClient:这里一般写在最前面,用于告诉Java 访问ES的ip地址
初始化的代码如下: