官方文档地址:Performing requests
一旦创建了RestClient
,就可以通过调用performRequest
或performRequestAsync
来发送请求。performRequest
是同步的,它将阻塞调用线程,并在请求成功时返回响应,或者在请求失败时抛出异常。performRequestAsync
是异步的,它接受一个ResponseListener
参数,当请求成功时,使用Response
调用该参数,如果请求失败,则使用Exception
调用该参数。
这是同步的:
Request request = new Request(
//HTTP 方法(GET, POST, HEAD 等)
"GET",
//服务器地址
"/");
Response response = restClient.performRequest(request);
这是异步的:
Request request = new Request(
//HTTP 方法(GET, POST, HEAD 等)
"GET",
//服务器地址
"/");
Cancellable cancellable = restClient.performRequestAsync(request,
new ResponseListener() {
@Override
public void onSuccess(Response response) {
//处理响应
}
@Override
public void onFailure(Exception exception) {
//处理失败
}
});
可以向请求对象添加请求参数:
request.addParameter("pretty", "true");
可以将请求体设置为任何HttpEntity
:
request.setEntity(new NStringEntity(
"{\"json\":\"text\"}",
ContentType.APPLICATION_JSON));
为
HttpEntity
指定的ContentType
很重要,因为它将用于设置Content-Type
报头,以便 Elasticsearch 能够正确解析内容。
您也可以将它设置为一个String
,默认ContentType
为application/json
。
request.setJsonEntity("{\"json\":\"text\"}");
RequestOptions
RequestOptions
类包含在同一应用程序中的多个请求之间共享的请求部分设置。 您可以创建一个单例实例并在所有请求之间共享它:
private static final RequestOptions COMMON_OPTIONS;
static {
RequestOptions.Builder builder = RequestOptions.DEFAULT.toBuilder();
//添加所有请求所需的请求头
builder.addHeader("Authorization", "Bearer " + TOKEN);
//自定义响应使用者
builder.setHttpAsyncResponseConsumerFactory(
new HttpAsyncResponseConsumerFactory
.HeapBufferedResponseConsumerFactory(30 * 1024 * 1024 * 1024));
COMMON_OPTIONS = builder.build();
}
addHeader
用于授权或使用 Elasticsearch 前面的代理所需的报头。 无需设置Content-Type
报头,因为客户端会自动从附加到请求的HttpEntity
中设置该报头。
您可以设置NodeSelector
来控制哪些节点将接收请求。 NodeSelector.SKIP_DEDICATED_MASTERS
是一个不错的选择。
您还可以定制用于缓冲异步响应的响应使用者。默认使用者将在 JVM 堆上缓冲最大 100MB 的响应。如果响应较大,则请求将会失败。例如,您可以降低最大大小,如果您在上面示例这样的堆约束环境中运行,这可能会很有用。
一旦您创建了单例,就可以在发出请求时使用它:
request.setOptions(COMMON_OPTIONS);
您还可以根据每个请求定制这些选项。例如,这里增加一个额外的报头:
RequestOptions.Builder options = COMMON_OPTIONS.toBuilder();
options.addHeader("cats", "knock things off of other things");
request.setOptions(options);
多个并行异步操作
客户端很乐意并行执行多个操作。下面的示例并行地索引多个文档。在实际场景中,您可能更倾向于使用_bulk
API 来实现,所以在这里本示例仅供说明。
final CountDownLatch latch = new CountDownLatch(documents.length);
for (int i = 0; i < documents.length; i++) {
Request request = new Request("PUT", "/posts/doc/" + i);
//让我们假设文档存储在 HttpEntity 数组中
request.setEntity(documents[i]);
restClient.performRequestAsync(
request,
new ResponseListener() {
@Override
public void onSuccess(Response response) {
//处理返回的响应
latch.countDown();
}
@Override
public void onFailure(Exception exception) {
//处理由于通信错误或带有指示错误的状态码的响应而返回的异常
latch.countDown();
}
}
);
}
latch.await();
取消异步请求
performRequestAsync
方法返回一个Cancelable
对象,该类有一个名为cancel
的公共方法。可以通过调用该方法来取消正在进行的请求。取消请求将通过底层 http 客户端终止 http 请求。在服务器端,这个操作不会自动转换为取消请求的执行,这需要在 API 本身中具体实现。
Cancelable
实例的使用是可选的,如果你不需要它,你可以忽略它。一个典型的用例是将它与 Rx Java 或 Kotlin 的suspendCancellableCoRoutine
这样的框架一起使用。取消不再需要的请求是避免给 Elasticsearch 增加不必要负载的好方法。
Request request = new Request("GET", "/posts/_search");
Cancellable cancellable = restClient.performRequestAsync(
request,
new ResponseListener() {
@Override
public void onSuccess(Response response) {
//处理在取消请求之前已经执行成功并返回的响应
}
@Override
public void onFailure(Exception exception) {
//处理返回的异常,当请求被取消时,该异常很可能是 CancellationException
}
}
);
cancellable.cancel();