本節(jié)將重點(diǎn)介紹ElasticSearch Doucment Get API(根據(jù)ID獲取文檔)皱碘。從《ElasticSearch Client詳解》可知财剖，ElasticSearch Get Rest Hign level Get Api聲明如下：
public final GetResponse get(GetRequest getRequest, RequestOptions options) throws IOException
public final void getAsync(GetRequest getRequest, RequestOptions options, ActionListener<GetResponse> listener)
上述兩個(gè)API,一個(gè)同步調(diào)用，一個(gè)異步調(diào)用寸谜，同步調(diào)用方法直接組裝GetResponse 并返回竟稳，而異步方法通過(guò)回調(diào)ActionListener，并將執(zhí)行結(jié)果(GetResponse )傳入回調(diào)方法熊痴。從中可以看出他爸，Get API的核心是GetRequest 與RequestOptions，RequestOptions在上節(jié)中已詳細(xì)說(shuō)明果善，接下來(lái)將重點(diǎn)關(guān)注GetRequest诊笤。
1、GetRequest
GetRequest完整的類繼承層次如下：
其核心屬性如圖所示：
下面我們一一來(lái)介紹一下GetRequest的核心屬性巾陕。
protected String index：索引庫(kù)讨跟，對(duì)應(yīng)關(guān)系型數(shù)據(jù)庫(kù)的Database。
private String type：類型鄙煤，對(duì)應(yīng)關(guān)系型數(shù)據(jù)庫(kù)的表晾匠。
private String id：文檔ID，對(duì)應(yīng)關(guān)系型數(shù)據(jù)庫(kù)表中一行的主鍵ID馆类。
private String routing：路由值混聊。
private String parent：
private String preference：get請(qǐng)求選取執(zhí)行節(jié)點(diǎn)的偏好，傾向性乾巧，在下文會(huì)詳細(xì)介紹句喜。
private String[] storedFields：顯示的指定需要返回的字段，默認(rèn)會(huì)返回_source中所有字段沟于。
private FetchSourceContext fetchSourceContext：指定需要返回字段的上下文咳胃，是storedFields的補(bǔ)充與完善，支持通配符旷太，下文會(huì)詳細(xì)分析展懈。
private boolean refresh = false：是否刷新。
boolean realtime = true：是否實(shí)時(shí)執(zhí)行供璧，默認(rèn)為true存崖。
private VersionType versionType = VersionType.INTERNAL：版本類型，已在《Elasticsearch Document Get API詳解睡毒、原理與示例》中詳細(xì)介紹
private long version = Versions.MATCH_ANY：數(shù)據(jù)版本来惧，關(guān)于數(shù)據(jù)的版本管理，已在《Elasticsearch Document Get API詳解演顾、原理與示例》中詳細(xì)介紹供搀。
2隅居、Get API Demo
1、示例一：
public static void testGet() {
RestHighLevelClient client = EsClient.getClient();
try {
GetRequest request = new GetRequest("twitter", "_doc", "1");
GetResponse result = client.get(request, RequestOptions.DEFAULT);
System.out.println(result);
} catch(Throwable e) {
e.printStackTrace();
} finally {
EsClient.close(client);
}
}
返回值：
{
"_index":"twitter",
"_type":"_doc",
"_id":"1",
"_version":3,
"found":true,
"_source":{
"post_date":"2009-11-16T14:12:12",
"message":"trying out Elasticsearch",
"user":"dingw"
}
}
2葛虐、示例二：基于storeFields進(jìn)行source字段過(guò)濾
public static void testGet_storeFields() {
RestHighLevelClient client = EsClient.getClient();
try {
GetRequest request = new GetRequest("twitter", "_doc", "1");
request.storedFields("user");
GetResponse result = client.get(request, RequestOptions.DEFAULT);
System.out.println(result);
} catch(Throwable e) {
e.printStackTrace();
} finally {
EsClient.close(client);
}
}
返回值：
{
"_index":"twitter",
"_type":"_doc",
"_id":"1",
"_version":3,
"found":true
}
不符合預(yù)期胎源，這是為什么呢？將在下文給出答案屿脐。
3涕蚤、示例三：使用fetchSourceContext進(jìn)行字段的過(guò)濾
public static void testGet_fetchSourceContext() {
RestHighLevelClient client = EsClient.getClient();
try {
GetRequest request = new GetRequest("twitter", "_doc", "1");
= new String[]{"message", "*date"};
FetchSourceContext fsc = new FetchSourceContext(true, includes, null);
request.fetchSourceContext(fsc);
GetResponse result = client.get(request, RequestOptions.DEFAULT);
System.out.println(result);
} catch(Throwable e) {
e.printStackTrace();
} finally {
EsClient.close(client);
}
}
返回結(jié)果：
{
"_index":"twitter",
"_type":"_doc",
"_id":"1",
"_version":3,
"found":true,
"_source":{
"post_date":"2009-11-16T14:12:12",
"message":"trying out Elasticsearch"
}
}
符合預(yù)期，只獲取_source中的message與以date結(jié)尾的屬性摄悯。
3赞季、Get API 內(nèi)部工作機(jī)制分析
3.1 實(shí)時(shí)性(Realtime)
默認(rèn)情況下愧捕，get API是實(shí)時(shí)的奢驯，并且不會(huì)受到索引刷新頻率的影響。如果一個(gè)文檔被更新了(update)次绘，但是還沒(méi)有刷新瘪阁，那么get API將會(huì)發(fā)出一個(gè)刷新調(diào)用，以使文檔可見(jiàn)邮偎。這也會(huì)使其他文檔在上一次刷新可見(jiàn)后發(fā)生變化管跺。如果不使用實(shí)時(shí)獲取，可以將realtime設(shè)置false禾进。
3.2 source字段過(guò)濾
按需返回所需字段豁跑，例如SQL語(yǔ)句select * 返回所有字段，可以通過(guò)select a.id,a.name返回所需字段泻云。Elasticsearch提供了如下兩種方式對(duì)_source字段進(jìn)行過(guò)濾：
3.2.1 Stored Fields
get操作允許通過(guò)傳遞storedFields參數(shù)來(lái)指定一組需要獲取儲(chǔ)存的字段艇拍。如果所請(qǐng)求的字段沒(méi)有被存儲(chǔ)，它們將被忽略宠纯。請(qǐng)考慮以下映射：
PUT twitter
{
"mappings": {
"_doc": {
"properties": {
"counter": {
"type": "integer",
"store": false
},
"tags": {
"type": "keyword",
"store": true
}
}
}
}
}
注意映射在定義時(shí)卸夕，store字段，如果設(shè)置為false婆瓜，就算指定storedFields=["counter"],也不會(huì)返回結(jié)果快集，也就時(shí)上述【示例2】沒(méi)有返回 _source的原因。
3.2.2 FetchSourceContext
fetchSourceContext顧名思義廉白，就是fetch source的上下文環(huán)境个初，提供更加完善的過(guò)濾邏輯，主要特性為支持include猴蹂、exclude和支持通篇符過(guò)濾院溺。
FetchSourceContext的構(gòu)造函數(shù)：
public FetchSourceContext(boolean fetchSource, String[] includes, String[] excludes) {
this.fetchSource = fetchSource;
this.includes = includes == null ? Strings.EMPTY_ARRAY : includes;
this.excludes = excludes == null ? Strings.EMPTY_ARRAY : excludes;
}
可以從兩個(gè)維度includes（包含）、excludes(排除)晕讲。還支持帶""的通配符覆获，例如includes = ["msg"]表示以msg開(kāi)頭的屬性马澈。通配符的解析邏輯：org.elasticsearch.common.regex#simpleMatchToAutomaton：
/** Return an {@link Automaton} that matches the given pattern. */
public static Automaton simpleMatchToAutomaton(String pattern) {
List<Automaton> automata = new ArrayList<>();
int previous = 0;
for (int i = pattern.indexOf('*'); i != -1; i = pattern.indexOf('*', i + 1)) {
automata.add(Automata.makeString(pattern.substring(previous, i)));
automata.add(Automata.makeAnyString());
previous = i + 1;
}
automata.add(Automata.makeString(pattern.substring(previous)));
return Operations.concatenate(automata);
}
3.3 路由機(jī)制
如果路由字段不是ID，請(qǐng)使用routing屬性弄息，更好的轉(zhuǎn)發(fā)請(qǐng)求痊班，否則會(huì)全部轉(zhuǎn)發(fā)到所有的復(fù)制組，然后匯聚并返回摹量。
3.4 傾向性（優(yōu)先級(jí)涤伐、Preference）
Preference參數(shù)控制get請(qǐng)求對(duì)同一個(gè)復(fù)制組內(nèi)多個(gè)副本的選擇，默認(rèn)情況下缨称，該操作是在碎片副本之間進(jìn)行隨機(jī)分配的凝果。一言以蔽之，preference的作用是同一個(gè)復(fù)制組中的路由規(guī)則睦尽。
其可選值：
- _primary
操作將只在主分片上執(zhí)行器净。
- _local
如果可能的話，操作將更傾向于在本地分配的碎片上執(zhí)行当凡。當(dāng)請(qǐng)求發(fā)到一個(gè)Node上山害，如果該Node上有對(duì)應(yīng)的副本，則在該節(jié)點(diǎn)上執(zhí)行沿量，不會(huì)再將請(qǐng)求轉(zhuǎn)發(fā)到其他節(jié)點(diǎn)浪慌。
- 自定義字符串值
同一個(gè)自定義值，將會(huì)固定使用同一個(gè)分片（路由）朴则，該值通常會(huì)和會(huì)話信息綁定在一起权纤，例如用戶名，sessionId等乌妒，在應(yīng)用層面對(duì)各
分片節(jié)點(diǎn)進(jìn)行分流汹想。
3.5 刷新機(jī)制
refersh如果設(shè)置為true，以便在get操作之前刷新相關(guān)分片芥被，并使其可搜索欧宜，會(huì)刷新整個(gè)分片節(jié)點(diǎn)，此參數(shù)不建議使用拴魄，因?yàn)間et操作默認(rèn)是實(shí)時(shí)的冗茸，無(wú)性能損耗。
其他分布式特性匹中、版本等是ElasticSearch的通用特性夏漱，就不再重復(fù)講解了。
本節(jié)首先羅列了文檔Get API顶捷，并對(duì)GetRequest進(jìn)行了詳細(xì)分析挂绰，接著通過(guò)3個(gè) 示例展示Get API的使用，最后重點(diǎn)分析GET API 內(nèi)部的實(shí)現(xiàn)機(jī)制（實(shí)時(shí)性服赎、source過(guò)濾葵蒂、路由交播、復(fù)制組內(nèi)分片節(jié)點(diǎn)傾向性、刷新機(jī)制等）践付。
