ElasticSearchJAVA开发手册

安装

Maven Repository

Elasticsearch Java API包已经上传到 Maven Central

在 pom.xml 文件中增加：

版本号选择自己合适的。

<dependency> 
<groupId>org.elasticsearch.client</groupId> 
<artifactId>transport</artifactId> 
<version>5.6.3</version> 
</dependency> 

Client

Java 客户端连接 Elasticsearch

一个是 TransportClient ，一个是 NodeClient ，还有一 个 XPackTransportClient

TransportClient：

作为一个外部访问者，请求ES的集群，对于集群而言，它 是一个外部因素。

NodeClient

作为ES集群的一个节点，它是ES中的一环，其他的节点对它是感知的。

XPackTransportClient：

服务安装了 x-pack 插件

重要：客户端版本应该和服务端版本保持一致 TransportClient旨在被Java高级REST客户端取代，该客户端执行HTTP请求而 不是序列化的Java请求。

在即将到来的Elasticsearch版本中将不赞成使用 TransportClient，建议使用Java高级REST客户端。

Transport Client

不设置集群名称

// on startup 
//此步骤添加IP，至少一个，如果设置了"client.transport.sniff"= true 一 
个就够了，因为添加了自动嗅探配置 
TransportClient client = new PreBuiltTransportClient(Settings.EM 
PTY) 
.addTransportAddress(new InetSocketTransportAddress(Inet 
Address.getByName("host1"), 9300)) 
.addTransportAddress(new InetSocketTransportAddress(Inet 
Address.getByName("host2"), 9300)); 
// on shutdown 关闭client 
client.close(); 

设置集群名称

Settings settings = Settings.builder()

.put("cluster.name", "myClusterName").build(); //设置ES

实例的名称

TransportClient client = new PreBuiltTransportClient(settings);

//自动嗅探整个集群的状态，把集群中其他ES节点的ip添加到本地的客户端列表中

//Add transport addresses and do something with the client...

增加自动嗅探配置

Settings settings = Settings.builder()

.put("client.transport.sniff", true).build();

TransportClient client = new PreBuiltTransportClient(settings);

其他配置

client.transport.ignore_cluster_name //设置 true ，忽略连接节点集群 名验证

client.transport.ping_timeout //ping一个节点的响应时间 默认5秒

client.transport.nodes_sampler_interval //sample/ping 节点的时间间 隔，默认是5s

对于ES Client，有两种形式，一个是TransportClient，一个是NodeClient。两个的区别为：

TransportClient作为一个外部访问者，通过HTTP去请求ES的集 群，对于集群而言，它是一个外部因素。 NodeClient顾名思义，是作为ES集

群的一个节点，它是ES中的一环，其他的节点对它是感知的，不像 TransportClient那样，ES集群对它一无所知。NodeClient通信的性能会更好，

但是因为是ES的一环，所以它出问题，也会给ES集群带来问题。NodeClient可以设置不作为数据节点，在elasticsearch.yml中设置，这样就不会在此节点上分配数据。

如果用ES的节点，大家仁者见仁智者见智，各按所需。

实例

Settings esSettings = Settings.builder() 
.put("cluster.name", clusterName) //设置ES实例的名称 
.put("client.transport.sniff", true) //自动嗅探整个集群的状态， 
把集群中其他ES节点的ip添加到本地的客户端列表中 
.build(); 
client = new PreBuiltTransportClient(esSettings);//初始化clie 
nt较老版本发生了变化，此方法有几个重载方法，初始化插件等。 
//此步骤添加IP，至少一个，其实一个就够了，因为添加了自动嗅探配置 
client.addTransportAddress(new InetSocketTransportAddress(In 
etAddress.getByName(ip), esPort)); 

XPackTransportClient

如果 ElasticSearch 服务安装了 x-pack 插件，需 要 PreBuiltXPackTransportClient 实例才能访问 使用Maven管理项目，把下面代码增加到 pom.xml ;

<project ...> 
<repositories> 
<!-- add the elasticsearch repo --> 
<repository> 
<id>elasticsearch-releases</id> 
<url>https://artifacts.elastic.co/maven</url> 
<releases> 
<enabled>true</enabled> 
</releases> 
<snapshots> 
<enabled>false</enabled> 
</snapshots> 
</repository> 
... 
</repositories> 
... 
<dependencies> 
<!-- add the x-pack jar as a dependency --> 
<dependency> 
<groupId>org.elasticsearch.client</groupId> 
<artifactId>x-pack-transport</artifactId> 
<version>5.6.3</version> 
</dependency> 
... 
</dependencies> 
... 
</project> 

Settings settings = Settings.builder().put("cluster.name", "xxx" 
) 
.put("xpack.security.transport.ssl.enabled", 
false) 
.put("xpack.security.user", "xxx:xxx") 
.put("client.transport.sniff", true).build() 
;
try {
client = new PreBuiltXPackTransportClient(settings) 
.addTransportAddress(new InetSocketTransportAddress( 
InetAddress.getByName("xxx.xxx.xxx.xxx"), 9300)) 
.addTransportAddress(new InetSocketTransportAddress( 
InetAddress.getByName("xxx.xxx.xxx.xxx"), 9300)); 
} catch (UnknownHostException e) { 
e.printStackTrace(); 
} 

Document APIs

本节介绍以下 CRUD API：

单文档 APIs

Index API

Get API

Delete API

Delete By Query API

Update API

多文档 APIs

Multi Get API

Bulk API

Using Bulk Processor

Multi Get API Bulk API

注意:所有的单文档的CRUD API，index参数只能接受单一的索引库名称，或者 是一个指向单一索引库的alias。

Index API

Index API 允许我们存储一个JSON格式的文档，使数据可以被搜索。文档通过

index、

type、

id唯一确定。我们可以自己提供一个id，或者也使用Index API 为我

们自动生成一个。

这里有几种不同的方式来产生JSON格式的文档(document)：

手动方式，使用原生的byte[]或者String

使用Map方式，会自动转换成与之等价的JSON

使用第三方库来序列化beans，如Jackson

使用内置的帮助类 XContentFactory.jsonBuilder()

手动方式

数据格式

String json = "{" + 
"\"user\":\"kimchy\"," + 
"\"postDate\":\"2013-01-30\"," + 
"\"message\":\"trying out Elasticsearch\"" + 
"}"; 
/**
* 手动生成JSON 
*/ 
@Test 
public void CreateJSON(){ 
String json = "{" + 
"\"user\":\"fendo\"," + 
"\"postDate\":\"2013-01-30\"," + 
"\"message\":\"Hell word\"" + 
"}"; 
IndexResponse response = client.prepareIndex("fendo", "fendo 
date") 
.setSource(json) 
.get(); 
System.out.println(response.getResult()); 
} 

【下载地址】

百度网盘链接：https://pan.baidu.com/s/1iOi_Sfl3B82G-3gbGjdNWw

提取码：