es中的Rest层

1、概述

rest层作为es处理外部请求的入口

2、Rest层相关接口或类

2.1 RestHandler

处理rest的处理器，作为函数接口，其方法有

方法	说明
void handleRequest(RestRequest request, RestChannel channel, NodeClient client)	处理rest请求
boolean canTripCircuitBreaker()	是否可以断路，默认返回true
boolean supportsContentStream()	是否支持ContentStream，默认是false
boolean allowsUnsafeBuffers()	是否允许使用不安全的缓冲区，默认是false
List<Route> routes()	方法支持的路由，默认是空列表
boolean allowSystemIndexAccessByDefault()	是否支持访问系统索引，默认是false
MediaTypeRegistry<? extends MediaType> validAcceptMediaTypes()	支持的媒体类型，默认是XContentType.MEDIA_TYPE_REGISTRY

结构图如下

 BaseRestHandler作为RestHandler的抽象实现类，实现了handleRequest接口，当中通过RestChannelConsumer prepareRequest(RestRequest request, NodeClient client)准备rest请求即创建RestChannelConsumer。

BaseRestHandler的方法有

方法	说明
String getName()	rest请求名
List<Route> routes()	支持的路由
RestChannelConsumer prepareRequest(RestRequest request, NodeClient client)	准备请求，创建RestChannelConsumer

2.2 RestChannel

其作为rest通道，处理rest响应。

AbstractRestChannel是RestChannel的抽象实现类，除了sendResponse方法没有实现。

其成员有

属性	说明
request	rest请求
detailedErrorsEnabled	是否开启错误详情
format	从请求参数format中获取
acceptHeader	从请求头中的header获取
filterPath	从请求参数filter_path中获取，默认值是null
pretty	从请求参数pretty中获取，默认值是false
human	从请求参数human中获取，默认值是false

结构图如下

2.3 RestRequestFilter

rest请求过滤器，过滤掉相应的字段，其方法有

方法	说明
Set<String> getFilteredFields()	需要过滤的字段
default RestRequest getFilteredRequest(RestRequest restRequest)	根据需要过滤的字段生成过滤后的rest请求

结构图如下 

2.4 RestRequest

rest请求类，主要包含请求的参数，请求头，原始路径、接受的媒体类型，内容媒体类型等

2.5 RestResponse

rest的响应类,为抽象类

2.6 MethodHandlers 

方法处理器，用于管理路径与RestHandler的对应关系。对于同一路径，可能方法类型不同，所以是一对多的关系。其方法有

方法	说明
MethodHandlers addMethod(RestRequest.Method method, RestApiVersion version, RestHandler handler)	添加method->version->hander对应关系
RestHandler getHandler(RestRequest.Method method, RestApiVersion version)	获取method->version对应的handler
Set<RestRequest.Method> getValidMethods()	获取支持的方法

2.7 RestController

RestController作为rest层的核心类，用于注册RestHandler及请求分发处理。注册RestHandler是遍历RestHandler的路由添加到PathTrie中。