The best elasticsearch highlevel java rest api-----bboss

1.ElasticSearch客戶端bboss提供了一系列註解

@ESId 用於標識實體對象中作為docid的屬性，該註解只有一個persistent 布爾值屬性，用於控制被本註解標註的字段屬性是否作為普通文檔屬性保存，默認為true-保存，false不保存，字段名稱為屬性名稱。ESId可用於添加和修改文檔

@ESParentId 用於標識實體對象中作為parentid的屬性，該註解只有一個persistent 布爾值屬性，用於控制被本註解標註的字段屬性是否作為普通文檔屬性保存，默認為true-保存，false不保存，字段名稱為屬性名稱。ESParentId可用於添加和修改文檔

@ESVersion 用於標識實體對象中作為文檔版本信息的屬性，該註解只有一個persistent 布爾值屬性，用於控制被本註解標註的字段屬性是否作為普通文檔屬性保存，true-保存，默認為false不保存，字段名稱為屬性名稱。ESVersion可用於添加/修改文檔操作

@ESVersionType 用於標識實體對象中作為文檔版本類型信息的屬性，該註解只有一個persistent 布爾值屬性，用於控制被本註解標註的字段屬性是否作為普通文檔屬性保存，true-保存，默認為false不保存，字段名稱為屬性名稱。ESVersionType可用於添加/修改文檔操作

@ESRetryOnConflict 用於標識實體對象中作為文檔修改操作版本沖突重試次數信息的屬性，數字類型。該註解只有一個persistent 布爾值屬性，用於控制被本註解標註的字段屬性是否作為普通文檔屬性保存，true-保存，默認為false不保存，字段名稱為屬性名稱。ESRetryOnConflict可用於添加/修改文檔操作

@ESRouting 用於標識實體對象中作為文檔添加/修改操作路由信息的屬性，字符串或者數字類型。該註解只有一個persistent 布爾值屬性，用於控制被本註解標註的字段屬性是否作為普通文檔屬性保存，true-保存，默認為false不保存，字段名稱為屬性名稱。ESRouting可用於添加/修改文檔操作

@ESDocAsUpsert 用於標識實體對象中控制文檔修改操作時，文檔不存在時是否添加文檔的信息的屬性，布爾值。該註解只有一個persistent 布爾值屬性，用於控制被本註解標註的字段屬性是否作為普通文檔屬性保存，true-保存，默認為false不保存，字段名稱為屬性名稱。ESDocAsUpsert可用於添加/修改文檔操作

@ESSource 用於標識實體對象中控制文檔修改操作時，返回值是否包含文檔source數據的控制變量的屬性，布爾值。該註解只有一個persistent 布爾值屬性，用於控制被本註解標註的字段屬性是否作為普通文檔屬性保存，true-保存，默認為false不保存，字段名稱為屬性名稱。ESSource可用於修改文檔操作

@Column 該註解用於指定日期格式，和JsonFormat屬性結合一起使用：

@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss.SSS")
@Column(dataformat = "yyyy-MM-dd HH:mm:ss.SSS")

@JsonIgnore 標註實體屬性不作為es字段保存，使用示例：

@JsonIgnore
private Integer sqlEndElapsed;

2.註解的使用示例

@ESId(persistent = false)
protected String id;
@ESParentId
protected String parentId;
@ESVersion
protected int version;
@ESVersionType
protected String versionType;
@ESRetryOnConflict
protected int retryOnConflict;
@ESRouting
protected String routing;
@ESDocAsUpsert
protected boolean docAsUpsert;
@ESSource
protected boolean returnSource;

3.結合控制註解的批量文檔修改操作

    @Test
	public void testOrmBulk(){
		ClientInterface clientUtil = ElasticSearchHelper.getRestClientUtil();
		List<OnlineGoodsInfoUpdateParams> onlineGoodsInfoUpdateParamss = new ArrayList<>();
		OnlineGoodsInfoUpdateParams onlineGoodsInfoUpdateParams = new OnlineGoodsInfoUpdateParams();
		onlineGoodsInfoUpdateParams.setId("aa");
		onlineGoodsInfoUpdateParams.setParentId("ppaa");
		onlineGoodsInfoUpdateParams.setType("tt");
		onlineGoodsInfoUpdateParams.setIndex("ddd");

		onlineGoodsInfoUpdateParams.setGoodsName("dddd");
		onlineGoodsInfoUpdateParams.setDocAsUpsert(true);
		onlineGoodsInfoUpdateParams.setRetryOnConflict(3);
		onlineGoodsInfoUpdateParams.setReturnSource(true);
		onlineGoodsInfoUpdateParams.setRouting("test");
		onlineGoodsInfoUpdateParams.setVersion(1);
		onlineGoodsInfoUpdateParams.setVersionType(ClientInterface.VERSION_TYPE_INTERNAL);

		onlineGoodsInfoUpdateParamss.add(onlineGoodsInfoUpdateParams);

		onlineGoodsInfoUpdateParams = new OnlineGoodsInfoUpdateParams();
		onlineGoodsInfoUpdateParams.setId("aa");
		onlineGoodsInfoUpdateParams.setParentId("ppaa");
		onlineGoodsInfoUpdateParams.setType("tt");
		onlineGoodsInfoUpdateParams.setIndex("ddd");

		onlineGoodsInfoUpdateParams.setGoodsName("dddd");

		/**
		 * 設置更新文檔控制變量
		 */
		onlineGoodsInfoUpdateParams.setDocAsUpsert(true);
		onlineGoodsInfoUpdateParams.setRetryOnConflict(3);
		onlineGoodsInfoUpdateParams.setReturnSource(true);
		onlineGoodsInfoUpdateParams.setRouting("test");
		onlineGoodsInfoUpdateParams.setVersion(1);
		onlineGoodsInfoUpdateParams.setVersionType(ClientInterface.VERSION_TYPE_INTERNAL);
		onlineGoodsInfoUpdateParamss.add(onlineGoodsInfoUpdateParams);
		String response = clientUtil.updateDocuments("aa","tt",onlineGoodsInfoUpdateParamss);
		System.out.println(response);
	}

我們可以看到執行updateDocuments方法時，生成的原生bulk報文如下，註意其中的控制參數信息：

{ "update" : { "_index" : "aa", "_type" : "tt", "_id" : "aa", "parent" : "ppaa", "_routing" : "test","retry_on_conflict":3,"_version":1,"_version_type":"internal" } }
{"doc":{"parentId":"ppaa","type":"tt","index":"ddd","routing":"test","goodsName":"dddd","brandId":0,"brandName":null,"shopCustomCategoryId":0,"goodsType":null,"quantityOfPacking":null,"freePostage":null,"postage":null,"goodsDescription":null,"packingDescription":null,"salesUnit":null,"minimumUnit":null,"minSalesPrice":0.0},"doc_as_upsert":true,"_source":true}
{ "update" : { "_index" : "aa", "_type" : "tt", "_id" : "aa", "parent" : "ppaa", "_routing" : "test","retry_on_conflict":3,"_version":1,"_version_type":"internal" } }
{"doc":{"parentId":"ppaa","type":"tt","index":"ddd","routing":"test","goodsName":"dddd","brandId":0,"brandName":null,"shopCustomCategoryId":0,"goodsType":null,"quantityOfPacking":null,"freePostage":null,"postage":null,"goodsDescription":null,"packingDescription":null,"salesUnit":null,"minimumUnit":null,"minSalesPrice":0.0},"doc_as_upsert":true,"_source":true}

reponse報文這裏不做介紹，如果被標準的returnSource屬性為true，那麽在response中將包含文檔的source字段信息。

4.參考資料

https://www.elastic.co/guide/en/elasticsearch/reference/6.2/docs-bulk.html

https://www.elastic.co/guide/en/elasticsearch/reference/6.2/docs-update.html

https://www.elastic.co/guide/en/elasticsearch/reference/6.2/docs-index_.html

https://my.oschina.net/bboss/blog/1556866

https://my.oschina.net/bboss/blog/1801273

ElasticSearch客戶端註解使用介紹