文档章节

高性能elasticsearch ORM开发库使用介绍

bboss
 bboss
发布于 2017/10/26 20:50
字数 14094
阅读 12735
收藏 6

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

    bboss是一款高性能elasticsearch ORM开发库, 以类似于mybatis管理和配置sql的方式,采用xml文件管理elasticsearch的dsl脚本,在dsl脚本中可以使用变量、dsl片段、foreach循环、逻辑判断、注释;支持在线修改、自动热加载dsl配置文件,开发和调试非常方便。bboss对原生elasticsearch restful api、elasticsearch java orm api、elasticsearch sql都提供了很好的支持。如果喜欢直接使用query dsl(es的官方语言),但是又不想在代码里面编写冗长的dsl拼接串的话,可以考虑采用 bboss。

    bboss elasticsearch jdk兼容性: jdk 1.6+

  bboss es restful组件不依赖elasticsearch官方任何jar文件,兼容所有elasticsearch版本:2.x,5.x,6.x,+   ,兼容spring boot 1.x,2,x

   bboss与es官方客户端的对比:bboss es对比直接使用es客户端的优势

  bboss elasticsearch开发环境搭建和开发入门视频教程:下载

首先介绍如何在项目中导入和配置elasticsearch开发包,spring boot的导入和配置请参考文档:

快速集成和应用 

2 elasticsearch配置

运行bboss es需要一个application.properties文件,放到资源目录(resources)目录下即可:

配置文件application.properties主要配置说明:

2.1 es服务器账号和口令配置

如果启用了x-pack或者searchguard安全认证,那么通过下面两个属性配置账号和口令:

elasticUser=elastic

elasticPassword=changeme

2.2 Elasticsearch 服务器http地址和端口配置

ES单节点配置

elasticsearch.rest.hostNames=127.0.0.1:9200

ES集群节点配置

Elasticsearch集群地址采用逗号分隔即可,如果开启了discovery机制可以只配置部分节点;

如果启用了ES的client node模式则只能配置所有client node的地址即可,并且关闭discovery机制

elasticsearch.rest.hostNames=127.0.0.1:9200,127.0.0.1:9201,127.0.0.1:9202

https协议配置

如果开启了https协议,则需要在elasticsearch地址中添加https://协议头
elasticsearch.rest.hostNames=https://10.180.211.27:9280,https://10.180.211.27:9281,https://10.180.211.27:9282

2.3 集群节点自动发现discover控制开关

集群节点自动发现控制开关,true开启,false关闭

elasticsearch.discoverHost=false

如果开启discover机制,客户端就会具备自动发现新增的ES集群节点的能力,elasticsearch.rest.hostNames中就可以只配置初始的几个节点,不需要配置全部节点。

注意:

在容器环境/虚拟机环境部署ES时,请关闭:elasticsearch.discoverHost=false

2.4 query dsl脚本调试日志开关

query dsl脚本调试日志开关,将showTemplate设置为true,同时将日志级别设置为INFO,则会将query dsl脚本输出到日志文件中:

elasticsearch.showTemplate=true

bboss可以通过常用的日志组件输出真实的dsl语句,支持的日志组件有:log4j(默认),log4j2,logback,javalog等。

log4j的配置实例:

log4j.rootLogger=INFO,CONSOLE
##bboss需要的category配置
log4j.category.com.frameworkset = INFO, COMMON_FILE
log4j.category.org.frameworkset = INFO, COMMON_FILE
log4j.category.org.apache = INFO, COMMON_FILE
log4j.category.bboss=INFO, COMMON_FILE

###################
# Console Appender
###################
log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
log4j.appender.CONSOLE.Threshold=INFO
log4j.appender.CONSOLE.Target=System.out
log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
log4j.appender.CONSOLE.layout.ConversionPattern=[%d{yyyy-MM-dd HH:mm:ss}][%p]%x[%c] %m%n



#####################
# Common Rolling File Appender
#####################
log4j.appender.COMMON_FILE=org.apache.log4j.RollingFileAppender
log4j.appender.COMMON_FILE.Threshold=INFO
log4j.appender.COMMON_FILE.File=common.log
log4j.appender.COMMON_FILE.Append=true
log4j.appender.COMMON_FILE.MaxFileSize=10240KB
log4j.appender.COMMON_FILE.MaxBackupIndex=10
log4j.appender.COMMON_FILE.layout=org.apache.log4j.PatternLayout
log4j.appender.COMMON_FILE.layout.ConversionPattern=[%d{yyyy-MM-dd HH:mm:ss}][%p]%x[%c] %m%n

注意:

在生产环境请关闭:elasticsearch.showTemplate=false

如果需要使用log4j 2那么只需要在bboss的maven坐标中排除log4j的包导入log4j2的依赖库即可:

非spring boot项目

        <dependency>
            <groupId>com.bbossgroups.plugins</groupId>
            <artifactId>bboss-elasticsearch-rest-jdbc</artifactId>
            <version>5.3.9</version>
            <exclusions>
                <exclusion>
                    <artifactId>slf4j-log4j12</artifactId>
                    <groupId>org.slf4j</groupId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-slf4j-impl</artifactId>
            <version>2.8.2</version>
        </dependency>
<!-- https://mvnrepository.com/artifact/org.apache.logging.log4j/log4j-core -->
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-core</artifactId>
            <version>2.8.2</version>
        </dependency>

spring boot项目

        <dependency>
            <groupId>com.bbossgroups.plugins</groupId>
            <artifactId>bboss-elasticsearch-spring-boot-starter</artifactId>
            <version>5.3.9</version>
            <exclusions>
                <exclusion>
                    <artifactId>slf4j-log4j12</artifactId>
                    <groupId>org.slf4j</groupId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-slf4j-impl</artifactId>
            <version>2.8.2</version>
        </dependency>
<!-- https://mvnrepository.com/artifact/org.apache.logging.log4j/log4j-core -->
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-core</artifactId>
            <version>2.8.2</version>
        </dependency>

2.5 按日期动态产生的索引索引名称的日期格式

elasticsearch.dateFormat=yyyy.MM.dd

固定index对应的添加文档api addDocument(单文档接口)/addDocuments(批量接口)

动态Index对应的添加文档api addDateDocument(单文档接口)/addDateDocuments(批量接口)

下面是一个对比案例:

//向固定index demo添加或者修改文档,如果demoId已经存在做修改操作,否则做添加文档操作,返回处理结果
String response = clientUtil.addDocument("demo",//索引表
      "demo",//索引类型
      demo);

//向动态index demo-yyyy.MM.dd这种添加或者修改文档,如果demoId已经存在做修改操作,否则做添加文档操作,返回处理结果
//elasticsearch.dateFormat=yyyy.MM.dd 按照日期生成动态index名称,例如:
// 到月 elasticsearch.dateFormat=yyyy.MM demo-2018.03
// 到天 elasticsearch.dateFormat=yyyy.MM.dd demo-2018.03.14
// 到小时 elasticsearch.dateFormat=yyyy.MM.dd.HH demo-2018.03.14.11
// 到分钟 elasticsearch.dateFormat=yyyy.MM.dd.HH.mm demo-2018.03.14.11.18
String response = clientUtil.addDateDocument("demo",//索引表
      "demo",//索引类型
      demo);

2.6 http连接池配置

 ## 总共允许的最大连接数:节点数n x defaultMaxPerRoute
http.maxTotal = 600

## 每个地址允许的最大连接数
http.defaultMaxPerRoute = 200

##连接失败重试次数,默认-1,小于等于0时不重试

http.retryTime = 3

自定义重试机制 

#* 自定义重试控制接口,必须实现接口方法
#* public interface CustomHttpRequestRetryHandler  {
#*     public boolean retryRequest(IOException exception, int executionCount, HttpContext context,ClientConfiguration configuration);
#* }
#* 方法返回true,进行重试,false不重试
# http.customHttpRequestRetryHandler=org.frameworkset.spi.remote.http.DefaultHttpRequestRetryHandler

http.customHttpRequestRetryHandler=org.frameworkset.spi.remote.http.ConnectionResetHttpRequestRetryHandler

空闲连接保活校验频率,单位毫秒,>0起作用

http.validateAfterInactivity=3000
每次获取connection时校验连接,true,校验,默认false
http.staleConnectionCheckEnabled=false 
 

2.7 DSL配置文件热加载扫描时间间隔配置

# dsl配置文件热加载扫描时间间隔,毫秒为单位,默认5秒扫描一次,<= 0时关闭扫描机制

dslfile.refreshInterval = -1

2.8 设置slice scroll查询线程池线程数和等待队列长度

elasticsearch.sliceScrollThreadCount 默认值500

elasticsearch.sliceScrollThreadQueue 默认值500

完成导入和配置,接下来就可以开始使用bboss操作和访问elasticsearch了。

3 操作和访问elasticsearch模式

bboss操作和访问elasticsearch提供两种模式,分别对应两个组件:

RestClientUtil:通用组件,提供所有不依赖dsl的功能,也可以直接接收dsl。

ConfigRestClientUtil:加载配置文件中的dsl来实现对es的操作

这两个组件分别通过org.frameworkset.elasticsearch.ElasticSearchHelper中提供的静态工厂方法获取其单实例对象,这些单实例对象是多线程并发安全的,分别说明如下:

3.1 加载配置文件中的dsl来实现对es的操作模式

public static ClientInterface getConfigRestClientUtil(String configFile)

public static ClientInterface getConfigRestClientUtil(String elasticSearch,String configFile) //elasticsearch参数指定了bboss中多集群配

置中的逻辑es集群名称,关于多集群配置请参考文档:

快速集成Elasticsearch Restful API案例分享  中的章节【2.2多集群配置

通过这两个方法获取到的ClientInterface实例是多线程安全的、单实例对象

加载配置文件中的dsl操作实例参考本文章节:【4.1 配置es查询dsl】和【4.2 ormapping操作示例】

3.2 所有不依赖dsl的功能,或直接接收dsl模式

public static ClientInterface getRestClientUtil()

public static ClientInterface getRestClientUtil(String elasticSearch) //elasticsearch参数指定了bboss中多集群配

置中的逻辑es集群名称,关于多集群配置请参考文档:

快速集成Elasticsearch Restful API案例分享  中的章节【2.2多集群配置

通过这两个方法获取到的ClientInterface实例是多线程安全的、单实例对象

直接操作dsl使用实例:

	public void testDirectDslQuery(){
		String queryAll = "{\"query\": {\"match_all\": {}}}";
		ClientInterface clientUtil = ElasticSearchHelper.getRestClientUtil();
		ESDatas<Demo> esDatas =clientUtil.searchList("demo/_search",//demo为索引表,_search为检索操作action
				queryAll,//queryAll变量对应的dsl语句
				Demo.class);
		//获取结果对象列表
		List<Demo> demos = esDatas.getDatas();

		//获取总记录数
		long totalSize = esDatas.getTotalSize();
		System.out.println(totalSize);
	}

getConfigRestClientUtil方法获取的ClientInterface实例是getRestClientUtil方法获取到的ClientInterface实例的子类,所以同样具备后者的所有功能。加载配置文件api和不加载配置文件api都是一致的,区别就是加载配置文件api传递的是dsl在配置文件中dsl对应的名称,如果配置文件中的dsl带有参数变量,还需要传递参数(map方式、bean方式传入即可)。

RestClientUtil和ConfigRestClientUtil区别说明

4 基本功能

4.1 配置es查询dsl

在resources下创建配置文件estrace/ESTracesqlMapper.xml,配置一个query dsl脚本,名称为queryServiceByCondition,我们将在后面的ClientInterface 组件中通过queryServiceByCondition引用这个脚本,脚本内容定义如下:

<properties>
   <property name="queryServiceByCondition">
        <![CDATA[
        {
            "sort": [  ##排序
                {
                    "startTime": {
                        "order": "desc"
                    }
                }
            ],
            #if($lastStartTime > 0)//search_after分页查询
            "search_after": [#[lastStartTime]],
            #end
            "size": 100, ##每次返回100条记录
            "query": {
                "bool":{
                    "filter": [
                        {"term": {  ##精确查找
                            "applicationName": #[application]
                        }}
                        #if($queryStatus.equals("success"))
                          ,
                          {"term": { ##精确查找

                               "err": 0
                          }}
                        #elseif($queryStatus.equals("error"))
                          ,
                          {"term": { ##精确查找

                               "err": 1
                          }}
                        #end
                        ,
                        {"range": { ##指定时间范围
                            "startTime": {
                                "gte": #[startTime],
                                "lt": #[endTime]
                            }
                        }}
                    ]
                    
                    #if($queryCondition && !$queryCondition.equals(""))
                     ,
                     "must" : {
                        "multi_match" : { ##分词检索,指定坐在多个field执行检索
                          "query" : #[queryCondition],

                          "fields" : [ "agentId", "applicationName" ,"endPoint","params","remoteAddr","rpc","exceptionInfo"]
                        }
                     }
                    #end
                }
            },
            "aggs": {
                "applicationsums": {
                      "terms": {
                        "field": "applicationName.keyword",##按应用名称进行统计计数
                        "size":10000
                      },
                      "aggs":{
                            "successsums" : {
                                "terms" : {
                                    "field" : "err" ##按err标识统计每个应用的成功数和失败数,0标识成功,1标识失败
                                }
                            },
                            "elapsed_ranges" : {
                                "range" : {
                                    "field" : "elapsed", ##按响应时间分段统计
                                    "keyed" : true,
                                    "ranges" : [
                                        { "key" : "1秒", "to" : 1000 },
                                        { "key" : "3秒", "from" : 1000, "to" : 3000 },
                                        { "key" : "5秒", "from" : 3000, "to" : 5000 },
                                        { "key" : "5秒以上", "from" : 5000 }
                                    ]
                                }
                            }
                      }
                }
            }
        }]]>
    </property>

</properties>

4.2 ormapping操作示例

加载query dsl文件,并执行查询操作


import org.frameworkset.elasticsearch.ElasticSearchHelper;
import org.frameworkset.elasticsearch.client.ClientInterface;
//加载配置文件,创建es客户端工具包
ClientInterface clientUtil = ElasticSearchHelper.getConfigRestClientUtil("estrace/ESTracesqlMapper.xml");

//构建查询条件对象
TraceExtraCriteria traceExtraCriteria = new TraceExtraCriteria();
traceExtraCriteria.setApplication("testweb88");
DateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
traceExtraCriteria.setStartTime(dateFormat.parse("2017-09-02 00:00:00").getTime());
traceExtraCriteria.setEndTime(dateFormat.parse("2017-09-13 00:00:00").getTime());

// 检索条件
String queryCondition = (request.getParameter("queryCondition"));
// 设置检索条件
traceExtraCriteria.setQueryCondition(queryCondition);
// 查询状态:all 全部 success 处理成功 fail 处理失败
String queryStatus = request.getParameter("queryStatus");
traceExtraCriteria.setQueryStatus(queryStatus);
//设置分页数据起点,以时间为起点
String lastStartTimeStr = request.getParameter("lastStartTime");
if(lastStartTimeStr != null && !lastStartTimeStr.equals("")) {
    Long lastStartTime = Long.parseLong(lastStartTimeStr);
    traceExtraCriteria.setLastStartTime(lastStartTime);
}

//执行查询操作,查询可以是简单的检索查询,也可以结合聚合查询
ESDatas<Traces> data //ESDatas为查询结果集对象,封装了返回的当前查询的List<Traces>结果集、符合条件的总记录数totalSize、以及聚合查询的结果
            = clientUtil.searchList"trace-*/_search",//查询操作,查询indices trace-*中符合条件的数据
                                "queryServiceByCondition",//通过名称引用配置文件中的query dsl语句
                                traceExtraCriteria,//查询条件封装对象
                                Traces.class);//指定返回的po对象类型,po对象中的属性与indices表中的文档filed名称保持一致
List<Traces> traceList = data.getDatas();//获取查询到的记过集
long totalSize = data.getTotalSize();//获取总记录数
List<Map<String, Object>> applicationsums= data.getAggregationBuckets("applicationsums");//同时可以做聚合查询,获取聚合查询结果集
for (int i = 0; i < applicationsums .size(); i++) {
			 
	Map<String, Object> map = applicationsums.get(i);
			
	//获取子聚合查询结果:成功数和失败数
	List<Map<String, Object>> appstatic = (List<Map<String, Object>>)ResultUtil.getAggBuckets(map, "successsums");
 
	//获取响应时间分段统计信息
	Map<String, Map<String, Object>> appPeriodstatic = (Map<String, Map<String, Object>>)ResultUtil.getAggBuckets(map, "elapsed_ranges");
}

4.3 文档批量创建或者修改

按日期分表

 //一个完整的批量添加和修改索引文档的案例  
SimpleDateFormat format = new SimpleDateFormat("yyyy.MM.dd");
		String date = format.format(new Date());
		ClientInterface clientUtil = ElasticSearchHelper.getRestClientUtil();
		List<Demo> demos = new ArrayList<>();
		Demo demo = new Demo();
		demo.setDemoId(2l);
		demo.setAgentStarttime(new Date());
		demo.setApplicationName("blackcatdemo2");
		demo.setContentbody("this is content body2");
		demos.add(demo);

		demo = new Demo();
		demo.setDemoId(3l);
		demo.setAgentStarttime(new Date());
		demo.setApplicationName("blackcatdemo3");
		demo.setContentbody("this is content body3");
		demos.add(demo);

		//批量创建文档
		String response = clientUtil.addDateDocuments("demo",//索引表
				"demo",//索引类型
				demos);

		System.out.println("addDateDocument-------------------------");
		System.out.println(response);

		//批量更新文档
		demo.setContentbody("updated");
		response = clientUtil.updateDocuments("demo-"+date,"demo",demos);
		System.out.println("updateDateDocument-------------------------");

		System.out.println(response);
        //获取索引文档,json格式
		response = clientUtil.getDocument("demo-"+date,//索引表
				"demo",//索引类型
				"2");//文档id
		System.out.println("getDocument-------------------------");
		System.out.println(response);
        //获取索引文档,返回Demo对象类型
		demo = clientUtil.getDocument("demo-"+date,//索引表
				"demo",//索引类型
				"3",//文档id
				Demo.class);

不按日期分表

 //一个完整的批量添加和修改索引文档的案例  
 
		ClientInterface clientUtil = ElasticSearchHelper.getRestClientUtil();
		List<Demo> demos = new ArrayList<>();
		Demo demo = new Demo();
		demo.setDemoId(2l);
		demo.setAgentStarttime(new Date());
		demo.setApplicationName("blackcatdemo2");
		demo.setContentbody("this is content body2");
		demos.add(demo);

		demo = new Demo();
		demo.setDemoId(3l);
		demo.setAgentStarttime(new Date());
		demo.setApplicationName("blackcatdemo3");
		demo.setContentbody("this is content body3");
		demos.add(demo);

		//批量创建文档
		String response = clientUtil.addDocuments("demo",//索引表
				"demo",//索引类型
				demos);

		System.out.println("addDocuments-------------------------");
		System.out.println(response);

		//批量更新文档
		demo.setContentbody("updated");
		response = clientUtil.updateDocuments("demo","demo",demos);
		System.out.println("updateDateDocument-------------------------");

		System.out.println(response);
        //获取索引文档,json格式
		response = clientUtil.getDocument("demo",//索引表
				"demo",//索引类型
				"2");//文档id
		System.out.println("getDocument-------------------------");
		System.out.println(response);
        //获取索引文档,返回Demo对象类型
		demo = clientUtil.getDocument("demo",//索引表
				"demo",//索引类型
				"3",//文档id
				Demo.class);

批量删除文档的示例,这里不举例说明,请访问github demo

4.4 添加/修改索引文档

添加/修改文档

TAgentInfo agentInfo = (TAgentInfo) dataObj;
ClientInterface clientUtil = ElasticSearchHelper.getRestClientUtil();				
clientUtil.addDocument("agentinfo",//索引名称
                       "agentinfo",//索引类型
                        agentInfo);//索引数据对象
//执行查询操作
ESDatas<TAgentInfo> data //ESDatas为查询结果集对象,封装了返回的当前查询的List<TAgentInfo>结果集和符合条件的总记录数totalSize
            = clientUtil.searchList"trace-*/_search",//查询操作,查询indices trace-*中符合条件的数据
                                "queryServiceByCondition",//通过名称引用配置文件中的query dsl语句
                                traceExtraCriteria,//查询条件封装对象
                                TAgentInfo.class);//指定返回的po对象类型,po对象中的属性与indices表中的文档filed名称保持一致
TAgentInfo的结构如下:

public class TAgentInfo implements java.io.Serializable{
	private String hostname;
	@ESId    //ip属性作为文档唯一标识,根据ip值对应的索引文档存在与否来决定添加或者修改操作
	private String ip;
	private String ports;
	private String agentId;
	private String applicationName;
	private int serviceType;
	private int pid;
	private String agentVersion;
	private String vmVersion;
    //日期类型
	private Date startTimestampDate;
	private Date endTimestampDate;
	private long startTimestamp;
	private long endTimestamp;
	private int endStatus;
	private String serverMetaData;
	private String jvmInfo;

	
}

注意事项:如果对象的属性不需要存入索引中,则在字段的定义加上@JsonIgnore注解,例如:

@JsonIgnore
private Integer sqlEndElapsed;

根据文档ID获取单个文档

        //创建批量创建文档的客户端对象,单实例多线程安全
		ClientInterface clientUtil = ElasticSearchHelper.getRestClientUtil(); 
        //获取索引文档,json格式
		String response = clientUtil.getDocument("demo",//索引表
				"demo",//索引类型
				"2");//文档id
		System.out.println("getDocument-------------------------");
		System.out.println(response);
        //获取索引文档,返回Demo对象类型
		Demo demo = clientUtil.getDocument("demo",//索引表
				"demo",//索引类型
				"3",//文档id
				Demo.class);
        //获取索引文档,返回Map对象类型
		Map demo = clientUtil.getDocument("demo",//索引表
				"demo",//索引类型
				"3",//文档id
				Map.class);

根据条件检索单个对象和对象列表

        //创建加载配置文件的客户端工具,用来检索文档,单实例多线程安全
		ClientInterface clientUtil = ElasticSearchHelper.getConfigRestClientUtil(mappath);       
        Map<String,Object> params = new HashMap<String,Object>();
		//设置applicationName1和applicationName2两个变量的值
		params.put("applicationName1","blackca\"tdemo2");
		params.put("applicationName2","blackcat\"demo3");
		DateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
		//设置时间范围,时间参数接受long值
		params.put("startTime",dateFormat.parse("2017-09-02 00:00:00"));
		params.put("endTime",new Date());
		//执行查询,返回列表结果 ,demo为索引表,_search为检索操作action
		ESDatas<Demo> esDatas =  //ESDatas包含当前检索的记录集合,最多1000条记录,由dsl中的size属性指定
				clientUtil.searchList("demo/_search",//demo为索引表,_search为检索操作action
						"searchWithCustomEscape",//esmapper/demo.xml中定义的dsl语句
						params,//变量参数
						Demo.class);//返回的文档封装对象类型
       //获取结果对象列表
		List<Demo> demos = esDatas.getDatas();
 
		//获取总记录数
		long totalSize = esDatas.getTotalSize();
		System.out.println(totalSize); 
       //执行查询,返回单个对象
		Demo single = clientUtil.searchObject("demo/_search",//demo为索引表,_search为检索操作action
				"searchWithCustomEscape",//esmapper/demo.xml中定义的dsl语句
				params,//变量参数
				Demo.class );

4.5 文档_id和parentid的设置规则

除了es能够自动生成文档_id属性,bboss提供了三种指定文档_id和parentid的方法:

  1. 注解@ESId和@ESParentId
  2. ClientInterface接口方法参数
  3. ClientOptions(新增/修改)/UpdateOptions(修改控制)

4.5.1 注解@ESId和@ESParentId

添加索引文档时,es会自动设置文档_id属性,如果需要人工指定_id值,只需要在对象属性上设置注解@ESId即可,例如:

@ESId //ip属性作为文档唯一标识,根据ip值对应的索引文档存在与否来决定添加或者修改操作
private String ip;

@ESId同样适用于文档批量创建和修改操作

另外一个注解@ESParentId用来表示父子关系,在父子关系检索案例中有介绍。

ESId和ESParentId两个注解在添加/修改文档、批量添加/修改文档操中指定文档的_id和parent属性,如果不指定,es自动生成_id属性,parent必须手工指定。

4.5.2 ClientInterface接口方法参数

除了通过ESId和ESParentId这两个注解来指定文档id和parentid,ClientInterface接口中还提供了一组方法来提供docid和parentid两个参数来指定文档id和parentid。

  • 单文档添加/修改-直接指定文档id和parentid的值
 
	public abstract String addDocumentWithId(String indexName, String indexType, Object bean,Object docId) throws ElasticSearchException;

	 
	public abstract String addDocumentWithId(String indexName, String indexType, Object bean,Object docId,Object parentId) throws ElasticSearchException;

	 
	public abstract String addDocument(String indexName, String indexType, Object bean,Object docId,Object parentId,String refreshOption) throws ElasticSearchException;

	 
	public abstract String addDocument(String indexName, String indexType, Object bean,Object docId,String refreshOption) throws ElasticSearchException;

    public String addDocumentWithParentId(String indexName, String indexType, Object bean,Object parentId) throws ElasticSearchException;

	public String addDocumentWithParentId(String indexName, String indexType, Object bean,Object parentId,String refreshOption) throws ElasticSearchException;

	public String addDateDocumentWithParentId(String indexName, String indexType, Object bean,Object parentId) throws ElasticSearchException;

	public String addDateDocumentWithParentId(String indexName, String indexType, Object bean,Object parentId,String refreshOption) throws ElasticSearchException;
  • 批量文档添加和修改-指定文档id和parentId对应的对象字段名称
	/**
	 * 指定对象集合的文档id字段
	 */
	/**
	 * 批量创建索引,根据时间格式建立新的索引表
	 * @param indexName
	 * @param indexType
	 * @param beans
	 * @param docIdField 对象中作为文档id的Field
	 * @return
	 * @throws ElasticSearchException
	 */
	public abstract String addDateDocumentsWithIdOptions(String indexName, String indexType, List<Object> beans,String docIdField,String refreshOption) throws ElasticSearchException;
	/**
	 * 批量创建索引,根据时间格式建立新的索引表
	 * @param indexName
	 * @param indexType
	 * @param beans
	 * @param docIdField 对象中作为文档id的字段名称
	 * @return
	 * @throws ElasticSearchException
	 */
	public abstract String addDateDocumentsWithIdField(String indexName, String indexType, List<Object> beans,String docIdField) throws ElasticSearchException;
	public abstract String addDocumentsWithIdField(String indexName, String indexType, List<Object> beans,String docIdField,String refreshOption) throws ElasticSearchException;
	public abstract String addDocumentsWithIdField(String indexName, String indexType,  List<Object> beans,String docIdField) throws ElasticSearchException;


	/**********************/
	/**
	 * 批量创建索引,根据时间格式建立新的索引表
	 * @param indexName
	 * @param indexType
	 * @param beans
	 * @param docIdField 对象中作为文档id的字段名称
	 * @return
	 * @throws ElasticSearchException
	 */
	public abstract String addDateDocumentsWithIdField(String indexName, String indexType, List<Object> beans,String docIdField,String parentIdField,String refreshOption) throws ElasticSearchException;
	/**
	 * 批量创建索引,根据时间格式建立新的索引表
	 * @param indexName
	 * @param indexType
	 * @param beans
	 * @param docIdField 对象中作为文档id的字段名称
	 * @return
	 * @throws ElasticSearchException
	 */
	public abstract String addDateDocumentsWithIdField(String indexName, String indexType, List<Object> beans,String docIdField,String parentIdField) throws ElasticSearchException;
	public abstract String addDocumentsWithIdField(String indexName, String indexType, List<Object> beans,String docIdField,String parentIdField,String refreshOption) throws ElasticSearchException;
	public abstract String addDocumentsWithIdParentField(String indexName, String indexType,  List<Object> beans,String docIdField,String parentIdField) throws ElasticSearchException;

批量bean类型导入文档,如需指定docid和parentid,必须通过ESId和ESParentId两个注解或者ClientOptions/UpdateOptions指定docid属性和parentid属性

批量map类型导入文档,如需指定docid,必须通过制定一个map里面的key或者ClientOptions/UpdateOptions指定key对应的value作为docid,必须设置docidKey参数:

public String addDateDocuments(String indexName, String indexType, List<Map> beans, String docIdKey, String refreshOption) 

public String addDateDocumentsWithIdKey(String indexName, String indexType, List<Map> beans, String docIdKey) throws ElasticSearchException

public abstract String addDocuments(String indexName, String indexType, List<Map> beans,String docIdKey,String refreshOption) throws ElasticSearchException;
public abstract String addDocumentsWithIdKey(String indexName, String indexType,  List<Map> beans,String docIdKey) throws ElasticSearchException;

4.5.3 ClientOptions/UpdateOptions

ClientOptions:主要用于新增/修改操作,可以指定以下属性:

*  String parentIdField;
*  String idField;
*  String esRetryOnConflictField;
*  String versionField;
*  String versionTypeField;
*  String rountField;
*  String refreshOption;
    /**
	 * 自动按照日期分表:日期通过参数指定elasticsearch.dateFormat=yyyy.MM.dd
	 * @param indexName
	 * @param indexType
	 * @param beans
	 * @param ClientOptions 传递es操作的相关控制参数,采用ClientOptions后,定义在对象中的相关注解字段将不会起作用(失效)
	 * @return
	 * @throws ElasticSearchException
	 */
	public abstract String addDateDocuments(String indexName, String indexType, List<?> beans,ClientOptions ClientOptions) throws ElasticSearchException;

	/**
	 *
	 * @param indexName
	 * @param indexType
	 * @param beans
	 * @param ClientOptions 传递es操作的相关控制参数,采用ClientOptions后,定义在对象中的相关注解字段将不会起作用(失效)
	 * @return
	 * @throws ElasticSearchException
	 */
	public abstract String addDocuments(String indexName, String indexType, List<?> beans,ClientOptions ClientOptions) throws ElasticSearchException;
	/**************************************创建或者修改文档结束**************************************************************/

ClientOptions使用示例:

ClientOptions clientOption = new ClientOptions();
clientOption.setRefreshOption("refresh=true");//为了测试效果,启用强制刷新机制,实际线上环境去掉最后一个参数"refresh=true",线上环境谨慎设置这个参数
clientOption.setIdField("demoId");//设置文档id对应的字段
//批量添加或者修改2万个文档,将两个对象添加到索引表demo中,批量添加2万条记录耗时1.8s,
String response = clientUtil.addDocuments("demo",//索引表
      "demo",//索引类型
      demos,clientOption);

UpdateOptions:主要用户修改,可以设置以下属性

private String refreshOption;
private String detectNoopField;
private String docasupsertField;
private String docIdField;

 

    /**
	 * 根据路径更新文档
	 * https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update.html
	 * @param index test/_doc/1
	 *             test/_doc/1/_update
	 * @param indexType
	 * @param params
	 * @param updateOptions 指定更新的相关参数

	 *    refresh=wait_for
	 *    refresh=false
	 *    refresh=true
	 *    refresh
	 *    Empty string or true
	Refresh the relevant primary and replica shards (not the whole index) immediately after the operation occurs, so that the updated document appears in search results immediately. This should ONLY be done after careful thought and verification that it does not lead to poor performance, both from an indexing and a search standpoint.
	wait_for
	Wait for the changes made by the request to be made visible by a refresh before replying. This doesn’t force an immediate refresh, rather, it waits for a refresh to happen. Elasticsearch automatically refreshes shards that have changed every index.refresh_interval which defaults to one second. That setting is dynamic. Calling the Refresh API or setting refresh to true on any of the APIs that support it will also cause a refresh, in turn causing already running requests with refresh=wait_for to return.
	false (the default)
	Take no refresh related actions. The changes made by this request will be made visible at some point after the request returns.
	 *
	 * @return
	 * @throws ElasticSearchException
	 */
	public String updateDocument(String index,String indexType,Object params,UpdateOptions updateOptions) throws ElasticSearchException;

 

4.6 删除/批量删除索引文档

//删除索引文档
clientUtil.deleteDocument("demo",//索引表
      "demo",//索引类型
      "5");//文档id

//批量删除索引文档
clientUtil.deleteDocuments("demo",//索引表
      "demo",//索引类型
      "1","2","3");//文档ids

4.7 设置索引刷新机制

往elasticsearch(批量)添加/修改/删除索引时,并不会立即生效,本节介绍通过bboss api来指定刷新机制:

public abstract String addDocument(String indexName, String indexType, Object bean,String refreshOption) throws ElasticSearchException;
public abstract String addDocuments(String indexName, String indexType, Object bean,String refreshOption) throws ElasticSearchException;

public abstract String updateDocument(String indexName, String indexType, List<?> beans,String refreshOption) throws ElasticSearchException;
public abstract String updateDocuments(String indexName, String indexType, List<?> beans,String refreshOption) throws ElasticSearchException;
public abstract String addDateDocument(String indexName, String indexType, Object bean,String refreshOption) throws ElasticSearchException;
public abstract String addDateDocuments(String indexName, String indexType, List<?> beans,String refreshOption) throws ElasticSearchException;

bboss在相关的api增加了refreshOption参数,refreshOption参数的值为,通过指定不同的值来指定索引刷新策略:

refresh=wait_for
refresh=false
refresh=true  //强制刷新
refresh  //强制刷新


refreshOption参数说明如下
   
   refresh: Empty string or true
   refresh=true:
	Refresh the relevant primary and replica shards (not the whole index) immediately after the 
operation occurs, so that the updated document appears in search results immediately. This should 
ONLY be done after careful thought and verification that it does not lead to poor performance, both 
from an indexing and a search standpoint.
	refresh=wait_for:
	Wait for the changes made by the request to be made visible by a refresh before replying. This 
doesn’t force an immediate refresh, rather, it waits for a refresh to happen. Elasticsearch 
automatically refreshes shards that have changed every index.refresh_interval which defaults to one 
second. That setting is dynamic. Calling the Refresh API or setting refresh to true on any of the 
APIs that support it will also cause a refresh, in turn causing already running requests with 
refresh=wait_for to return.
	false (the default)
	Take no refresh related actions. The changes made by this request will be made visible at some 
point after the request returns.

refreshOption 使用实例:

		//强制刷新
		String response = clientUtil.addDocument("demo",//索引表
				"demo",//索引类型
				demo,"refresh=true");

4.8 为添加/修改文档指定控制参数

【4.7】小节介绍了控制定时刷新的refresh参数,其实refreshOption中还可以指定其他文档操作的控制参数:

retry_on_conflict

In between the get and indexing phases of the update, it is possible that another process might have already updated the same document. By default, the update will fail with a version conflict exception. The retry_on_conflict parameter controls how many times to retry the update before finally throwing an exception.

routing

Routing is used to route the update request to the right shard and sets the routing for the upsert request if the document being updated doesn’t exist. Can’t be used to update the routing of an existing document.

timeout

Timeout waiting for a shard to become available.

wait_for_active_shards

The number of shard copies required to be active before proceeding with the update operation. See here for details.

refresh

Control when the changes made by this request are visible to search. See ?refresh.

_source

Allows to control if and how the updated source should be returned in the response. By default the updated source is not returned. See source filtering for details.

version

The update API uses the Elasticsearch’s versioning support internally to make sure the document doesn’t change during the update. You can use the version parameter to specify that the document should only be updated if its version matches the one specified.

具体的用法如下:

指定修改的文档版本号

		//强制刷新
		String response = clientUtil.addDocument("demo",//索引表
				"demo",//索引类型
				demo,"version=1");

指定文档版本号同时强制刷新:

		//强制刷新
		String response = clientUtil.addDocument("demo",//索引表
				"demo",//索引类型
				demo,"refresh=true&version=1");

4.9 @JsonProperty注解使用

当elasticsearch索引表字段名称和java bean的字段名称不一致的情况下,采用@JsonProperty注解用来定义elasticsearch和java bean的field名称转换映射关系,使用实例如下:

@JsonProperty("max_score")
private Double maxScore;

5 进阶

5.1 ClientInterface 提供的一组通用http api

通过ClientInterface 接口提供的以下通用executeHttp api,我们可以非常方便地实现es中所有带请求报文的功能

        /**
	 * 发送es restful请求,获取String类型json报文
	 * @param path
	 * @param templateName 请求报文
	 * @param action get,post,put,delete
	 * @return
	 * @throws ElasticSearchException
	 */
	public String executeHttp(String path, String templateName,Map params, String action) throws ElasticSearchException
	/**
	 * 发送es restful请求,返回String类型json报文
	 * @param path
	 * @param templateName 请求报文dsl名称,在配置文件中指定
	 * @param action get,post,put,delete
	 * @return
	 * @throws ElasticSearchException
	 */
	public String executeHttp(String path, String templateName,Object bean, String action) throws ElasticSearchException

	/**
	 * 
	 * @param path
	 * @param templateName
	 * @param action get,post,put,delete
	 * @return
	 * @throws ElasticSearchException
	 */
	@Override
	public String executeHttp(String path, String templateName, String action) throws ElasticSearchException
	/**
	 * 发送es restful请求,获取返回值,返回值类型由ResponseHandler决定
	 * @param path
	 * @param templateName
	 * @param action get,post,put,delete
	 * @param responseHandler
	 * @param <T>
	 * @return
	 * @throws ElasticSearchException
	 */
	public <T> T  executeHttp(String path, String templateName,String action,Map params,ResponseHandler<T> responseHandler) throws ElasticSearchException
	/**
	 * 发送es restful请求,获取返回值,返回值类型由ResponseHandler决定
	 * @param path
	 * @param templateName
	 * @param action get,post,put,delete
	 * @param responseHandler
	 * @param <T>
	 * @return
	 * @throws ElasticSearchException
	 */
	public <T> T  executeHttp(String path, String templateName,String action,Object bean,ResponseHandler<T> responseHandler) throws ElasticSearchException

通过ClientInterface 提供的这个通用http api,我们可以非常方便地实现es中所有不带请求报文的功能

    /**
	 * 没有报文的请求处理api
	 * @param path 请求url相对路径,可以带参数
	 * @param action get,post,put,delete
	 * @return
	 * @throws ElasticSearchException
	 */
	@Override
	public String executeHttp(String path, String action) throws ElasticSearchException

通用api的使用案例:path参数为相对路径,不需要带ip和端口,在application.properties文件中统一配置

	public void testTempate() throws ParseException{

		ClientInterface clientUtil = ElasticSearchHelper.getConfigRestClientUtil("esmapper/estrace/ESTemplate.xml");
		//创建模板
		String response = clientUtil.createTempate("demotemplate_1",//模板名称
				"demoTemplate");//模板对应的脚本名称,在esmapper/estrace/ESTemplate.xml中配置
		System.out.println("createTempate-------------------------");
		System.out.println(response);
		//获取模板
		/**
		 * 指定模板
		 * /_template/demoTemplate_1
		 * /_template/demoTemplate*
		 * 所有模板 /_template
		 *
		 */
		String template = clientUtil.executeHttp("/_template/demotemplate_1",ClientUtil.HTTP_GET);
		System.out.println("HTTP_GET-------------------------");
		System.out.println(template);
		//删除模板
		template = clientUtil.executeHttp("/_template/demotemplate_1",ClientUtil.HTTP_DELETE);
		System.out.println("HTTP_DELETE-------------------------");
		System.out.println(template);

		template = clientUtil.executeHttp("/_template/demotemplate_1",ClientUtil.HTTP_GET);
		System.out.println("HTTP_GET after delete-------------------------");
		System.out.println(template);
	}

5.2 多elasticsearch服务器集群支持

初始化bboss elasticsearch组件ClientInterface 时,可以指定elasticsearch服务器,支持在指定的elasticsearch服务器集群进行操作,例如:

ClientInterface clientUtil = ElasticSearchHelper
                 .getConfigRestClientUtil("logs",//指定logs对应的es集群服务器
                                          "estrace/ESTracesqlMapper.xml");

logs对应的es集群服务器相关参数配置,请参考文档:

快速集成Elasticsearch Restful API案例分享

中的章节【2.2多集群配置

5.3 dsl配置规范

5.3.1 查询dsl动态脚本语法

      bboss elasticsearch采用xml文件管理elasticsearch的dsl脚本,在dsl脚本中可以使用变量、foreach循环、逻辑判断、注释;配置文件支持在线修改、自动热加载,开发和调试非常方便。

  • 变量

脚本中变量定义语法有两种:#[xxx],$xxx,尽可能地在脚本中使用#[xxx]方式的变量,在#[]类型变量中还可以指定属性,后面举例说明。对于#[xxx]类型变量值中包含的可能破坏dsl json语法结构的特殊字符(例如回车换行符等),框架会自动进行转义处理;$xxx类型变量直接输出原始值(特殊字符不做转移处理),$xxx类型变量可以用于if/else和foreach循环控制变量,而#[xxx]不可以。   

正确用法

判断List集合datas不为空并且datas的size大于0

#if($datas && $datas.size()> 0)

#foreach($bb in $datas)

#end

#end 

错误用法

#if(#[xxxxx] > 0)

#foreach($bb in #[datas])

#end

#end 

  • 片段引用

@{pianduan}

  • script脚本封装语法
@"""
  ctx._source.last = params.last;
  ctx._source.nick = params.nick
"""
  • SQL语句回车换行符替换语法

#""" """,包含在这个中间的dsl片段中包含的回车换行符会被替换成空格,使用示例及注意事项:

<property name="sqlPagineQuery">
    <![CDATA[
     {
     ## 指示sql语句中的回车换行符会被替换掉开始符,注意dsl注释不能放到sql语句中,否则会有问题,因为sql中的回车换行符会被去掉,导致回车换行符后面的语句变道与注释一行
     ##  导致dsl模板解析的时候部分sql段会被去掉
        "query": #"""
                SELECT * FROM dbclobdemo
                    where channelId=#[channelId]
         """,
         ## 指示sql语句中的回车换行符会被替换掉结束符
        "fetch_size": #[fetchSize]
     }
    ]]>
</property>
  • foreach循环语法

#foreach-#end

  foreach循环内置循环变量:$velocaitycount,不需要从外部传入

  • 逻辑判断语法

#if-#else-#end,#if-#elseif-#else-#end

  • 变量值逻辑判断

#if($xxxx) ##变量值不为null判断(类似java语法 if(xxxx != null)) 

#end

#if(!$xxxx) ##变量值为null判断(类似java语法 if(xxxx == null)) 

#end

#if($xxxx && !$xxxx.equals("")) ##变量值不为null判断且不等于""判断(类似java语法 if(xxxx != null && !xxx.equals(""))) 

#end

#if($xxxx > 0) ##变量值大于某个值判断,其他类似(类似java语法 if(xxxx > 0)) 

#end

判断List集合不为null并且size大于0

#if($datas && $datas.size() > 0)

#end

逻辑判断还可以包含各种组合 && ||操作。

  • 在dsl中定义和修改$模式变量

定义变量

#set($needComma = true)

修改$变量值

#set($needComma = false)

  • 在dsl中使用注释

dsl注释是用多个#号来标识的,大段注释用 #* 和 *#包起来
单行注释:##注释内容
多行注释:
#*
注释内容
*#

使用示例

<property name="searchAfterAggs">
        <![CDATA[
            ## 通过searchafter实现分页查询
            #if($lastStartTime && $lastStartTime > 0)
                #if($orderBy && $orderBy.equals("elapsed"))
                "search_after": [#[lastElapsed],#[lastStartTime],"trace#$lastId"],
                #else
                "search_after": [#[lastStartTime],"trace#$lastId"],
                #end
            #end
            "size": $pageSize,
            "sort": [
                 #if($orderBy && $orderBy.equals("elapsed")){"elapsed": "desc"},#end
                {"startTime": "desc"},
                {"_uid": "desc"}
            ],
            #* 
              应用服务调用次数聚合统计:
              按每分钟统计服务调用次数
            *#  
            "aggs": {
                "traces_date_histogram": {
                    "date_histogram": {
                        "field": "starttimeDate",
                        "interval": "1m",
                        "time_zone": "Asia/Shanghai",
                        "min_doc_count": 0
                    }
                }
            },]]>
    </property>

5.3.2 变量使用 

  • #[application]

变量application在替换值时,如果是字符串类型会在值的两边加上"",例如

带变量application的脚本:


{"term": {
                            "applicationName": #[application]
                        }}

如果变量application为String类型,值为testweb,那么替换后得到:

{"term": {
                            "applicationName": "testweb"
                        }}

如果变量application为数字类型,值为100,那么替换后得到:

{"term": {
                            "applicationName": 100
                        }}

变量格式#[aaa]所有格式: 
#[aaa] 简单的变量属性引用 
#[aaa[0]] (一维数组中的第一个元素,或者list中的第一个元素,具体取决于aaa变量是一个数组还是list对象) 
#[aaa[0][1]](二维数组中的第一维度的第二个个元素,或者list中的第一个元素的数第二个组元素或者list第第二个元素,具体取决于aaa变量是每一维度是数组还是list对象) 

#[aaa[0][1]...](多维数组中的第一维度的第二个个元素的n维元素,或者list中的第一个元素的第二个数组元素或者list第二个元素的n维元素引用,具体取决于aaa变量是每一维度是数组还是list对象) 
#[aaa[key]] 引用map对象aaa中key所对应的value数据,引用map元素的等价方法#[aaa->key] 
#[aaa[key][0]] 引用map对象aaa中key所对应的value的第一个元素,取决于value的类型是数组还是list,等价引用方法#[aaa->key[0]] 

#[aaa->bb] 如果aaa是一个bean对象,这个变量格式表示了对aaa对象的bb属性的引用,如果aaa是一个map对象,这个变量格式表示了对aaa对象的key为bb的元素值引用 

以上就是全部的类型,每种类型可以任意组合,例如: 
#[aaa->bb[0]] 
#[aaa[0]->bb[0]] 

#[aaa[0]->bb[0]->fff] 
#[aaa[0]->bb[0]->cc[keyname]] 
#[aaa[0]->bb->cc[keyname]] 
等等 

  • #[application]变量属性

另外,可以在#[]变量中指定escapeCount,serialJson,quoted、lpad、rpad、escape、dateformat/locale/timezone属性,属性和变量名称用逗号分隔:

#[变量名,quoted=false,lpad=xxx,rpad=ddd]

#[变量名,quoted=false,lpad=xxx|3,rpad=ddd|4]

#[dynamicPriceTemplate->goodName,escapeCount=2]

#[dynamicPriceTemplate->rules[$velocityCount],serialJson=true]

#[testVar,serialJson=true]

说明如下:

  • serialJson boolean类型,通过属性serialJson指示框架直接将对象序列化为json数据,使用案例:

#[dynamicPriceTemplate->rules[$velocityCount],serialJson=true]

#[testVar,serialJson=true]

  • escapeCount int类型,在脚本中,含有特殊字符的goodName需要转义2次,使用案例:

#[dynamicPriceTemplate->goodName,escapeCount=2]

  • quoted  boolean类型,控制是否为字符串变量和日期变量串两头添加"号,true添加,false不加,默认为true,一般在不需要自动加"号的情况下使用,示例如下:
"asdfaf#[application,quoted=false]s"

变量application的值为testweb,解析后的效果如下:

"asdfaftestwebs"
  • lpad、rpad 在通过lpad(左边追加)和rpad(右边追加)变量值两头追加字符串,同时可以通过|指定一个数字,表示追加多少次,示例如下:

简单的例子:

"#[application,quoted=false,lpad=#]s"

变量的值为testweb,解析后的效果如下:

"#testwebs"

带倍数的例子

"ddd#[application,quoted=false,lpad=#|2,rpad=#|3]s"

变量的值为testweb,解析后的效果如下:

"ddd##testweb###s"
  • dateformat/locale/timezone 一组时间相关的属性,用来对时间类型的变量进行转换和处理,示例如下:
"term": {
    "startDate": #[date,dateformat=yyyy-MM-dd HH:mm:ss,locale=zh_CN,timezone=Asia/Shanghai]
}

变量值设置为new Date(),那么解析后的效果如下:

 "term": {
     "startDate": "2018-01-20 12:52:35"
  }

注意:

1. 在map中传递日期类型参数,则可以通过dateformat/locale/timezone属性在变量中指定所需要的日期格式,如果不指定则默认采用utc时区的日期格式:

"term": {
    "startDate": #[date,dateformat=yyyy-MM-dd'T'HH:mm:ss.SSS'Z',timezone=Etc/UTC],
    "endDate": #[date,dateformat=yyyy-MM-dd HH:mm:ss,timezone=Asia/Shanghai]
}
"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",null,"Etc/UTC"

2. 在bean实体对象中日期类型field,dateformat/locale/timezone属性优先起作用,注解@JsonFormat,@Column 来指定自定义日期格式其次:

@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss") 
@Column(dataformat = "yyyy-MM-dd HH:mm:ss") 
protected Date agentStarttime;

     如果不指定注解@JsonFormat,@Column,最后默认为日期类型的bean属性采用utc时区的日期格式:

"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",null,"Etc/UTC"
  • escape 用于控制是否对参数值进行特殊字符转义处理,true 处理 false 不处理,默认为空,这时候如果是map传递的参数,默认转义;如果是bean实体传值,如果bean属性指定了@Column(escape="false"),则按照注解中设置的escape属性值来控制是否转义,如果没有在column注解中制定escape,则默认转义处理

        escape使用实例:   

"term": {
     "applicationName": #[applicationName,escape=false]
 }
 ## 不转义,两边不追加双引号,等价于$applicationName
"term": {
     "applicationName": #[applicationName,escape=false,quote=false]
 }

  • $application

$类型的变量,只是做值替换,所以对于""这样的类型修饰符,需要自己在query dsl中加上,在类型明确的情况下,使用$变量比较合适,举例说明:

带变量$application的脚本:


{"term": {
                            "applicationName": "$application"
                        }}

如果变量application为String类型,值为testweb,那么替换后得到:

{"term": {
                            "applicationName": "testweb"
                        }}

如果变量application为数字类型,值为100,那么替换后得到:

{"term": {
         "applicationName": "100" ##数字100被当成String处理了,这种情况下可能会出现不可预知的问题
}}

$方式的变量还用于逻辑判断和foreach循环。

  • 在dsl中定义$类型变量

除了外部传参的$变量,还可以在dsl中定义自己的$变量,例如:

变量定义

#set( $hasParam = false )

然后在dsl其他地方可以修改变量的值

#set( $hasParam = true )

案例:

   <property name="qcondition">
        <![CDATA[
         #set( $hasParam = false ) ## 定义一个是否已经有参数条件的bool变量,控制后续的条件是否前面加逗号
        "bool": {
            "filter": [
                #if($application && !$application.equals("_all"))
                 #set( $hasParam = true )
                {"term": {
                    "applicationName": #[application]
                }}
                #end
                #if($queryStatus.equals("success"))                 
                  #if($hasParam),#end
                  {"term": {

                       "err": 0
                  }}
                #elseif($queryStatus.equals("error"))                  
                  #if($hasParam),#end
                  {"term": {

                       "err": 1
                  }}
                #end
            ],
            "must": [
                #if($queryCondition && !$queryCondition.equals(""))
                {
                    "query_string": {
                        "query": #[queryCondition],
                        "analyze_wildcard": true,
                        "all_fields": true
                    }
                },
                #end
                {
                    "range": {
                        "startTime": {
                            "gte": #[startTime],
                            "lt": #[endTime],
                            "format": "epoch_millis"
                        }
                    }
                }
            ]
        }]]>
    </property>
  • #[xxx]和$xxx两种模式变量的区别

本小节总结#[xxx]和$xxx两种模式变量的区别:

  1. #[xxx]自动对变量值中的特殊字符进行转义处理,而$xxx不会进行处理直接输出原始值
  2. #[xxx]自动在String类型变量两边加上双引号""
  3. #[xxx]自动对日期类型变量值采用Utc标准时间格式(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')进行格式化处理,而$xxx不会进行处理直接输出原始值
  4. 因此如果$xxx模式变量参数中包含有特殊字符或者是日期类型,请在程序中自行处理好
  5. $xxx可用于逻辑判断、循环处理语句,#[xxx]不能用于逻辑判断、循环处理语句
  6. $xxx变量参数值拼接到dsl中需要特别注意,如果变量的值不确定,变化频繁,在高并发的场景下回导致严重的性能问题;$xxx用在foreach和if/else语法中不会存在这个问题

建议:在dsl拼接中采用#[xxx]替代$xxx模式变量,在foreach和if/else语法中使用$xxx.

  • @{pianduan}-片段引用变量

@{}类型变量用于在query dsl中引用脚本片段。很多的dsl脚本会包含一些公共内容,比如查询条件,聚合操作脚本等待,可以把这些公共部分抽取出来定义成dsl片段;另外,一些复杂的搜索聚合查询的dsl脚本很长,由很多比较通用独立的部分组成,这样也可以将独立部分剥离形成片段,这样dsl的结构更加清晰,更加易于维护。片段定义一定要定义在引用片段的dsl脚本前面,片段引用变量示例如下:

定义片段searchAfterAggs和qcondition:

<!--
        分页查询和按日期分钟统计片段
        应用:链路检索和统计查询,rpc时间段统计查询
    -->
    <property name="searchAfterAggs">
        <![CDATA[
            #if($lastStartTime && $lastStartTime > 0)
                #if($orderBy && $orderBy.equals("elapsed"))
                "search_after": [#[lastElapsed],#[lastStartTime],"trace#$lastId"],
                #else
                "search_after": [#[lastStartTime],"trace#$lastId"],
                #end
            #end
            "size": $pageSize,
            "sort": [
                 #if($orderBy && $orderBy.equals("elapsed")){"elapsed": "desc"},#end
                {"startTime": "desc"},
                {"_uid": "desc"}
            ],
            "aggs": {
                "traces_date_histogram": {
                    "date_histogram": {
                        "field": "starttimeDate",
                        "interval": "1m",
                        "time_zone": "Asia/Shanghai",
                        "min_doc_count": 0
                    }
                }
            },]]>
    </property>
    <!--
    查询条件片段
    -->
    <property name="qcondition">
        <![CDATA[
        "bool": {
            "filter": [
                #if($application && !$application.equals("_all"))
                {"term": {
                    "applicationName": #[application]
                }}
                #end
                #if($queryStatus.equals("success"))
                  #if($application && !$application.equals("_all")),#end
                  {"term": {

                       "err": 0
                  }}
                #elseif($queryStatus.equals("error"))
                  #if($application && !$application.equals("_all")),#end
                  {"term": {

                       "err": 1
                  }}
                #end
            ],
            "must": [
                #if($queryCondition && !$queryCondition.equals(""))
                {
                    "query_string": {
                        "query": #[queryCondition],
                        "analyze_wildcard": true,
                        "all_fields": true
                    }
                },
                #end
                {
                    "range": {
                        "startTime": {
                            "gte": #[startTime],
                            "lt": #[endTime],
                            "format": "epoch_millis"
                        }
                    }
                }
            ]
        }]]>
    </property>

引用片段:

<property name="queryServiceByCondition">
        <![CDATA[{
            "version": true,
            @{searchAfterAggs} //片段引用,此处是一个占位符,在系统加载配置文件时候,
                                 直接被searchAfterAggs对应的片段替换
            "query": {
                @{qcondition} //片段引用,此处是一个占位符,在系统加载配置文件时候,
                                直接被qcondition对应的片段替换
            },
            "_source": {
                "excludes": []
            },

            "highlight": {
                "pre_tags": [
                    "<mark>"
                ],
                "post_tags": [
                    "</mark>"
                ],
                "fields": {
                    "*": {
                        "highlight_query": {
                            @{qcondition}  //片段引用,此处是一个占位符,在系统加载配置文件时候,
                                             直接被qcondition对应的片段替换
                        }
                    }
                },
                "fragment_size": 2147483647
            }
        }]]></property>

片段变量只是一个占位符,在系统第一次加载配置文件时候,直接被qcondition对应的片段内容替换。

片段定义中同样可以引用其他片段。

5.3.3 不同dsl配置文件之间的dsl语句引用

bboss elastic还支持不同dsl配置文件之间的dsl引用,例如:

  <!--
    querySqlTraces直接引用链路查询模板文件esmapper/estrace/ESTracesMapper.xml中定义的查询dsl语句
    queryTracesByCriteria
  -->
  <property name="querySqlTraces"
            templateFile="esmapper/estrace/ESTracesMapper.xml"
            templateName="queryTracesByCriteria"/>

说明:querySqlTraces直接引用链路查询模板文件esmapper/estrace/ESTracesMapper.xml中定义的查询dsl语句queryTracesByCriteria,注意这里只是引用,在热加载机制中,当原始定义文件对应的dsl语句被修改,引用的地方也会同时被修改

5.3.4 sql语句中回车换行符替换指示语法以及变量使用注意事项

#""" """,包含在这个中间的dsl片段中包含的回车换行符会被替换成空格,使用示例及注意事项:

<property name="sqlPagineQuery">
    <![CDATA[
     {
     ## 指示sql语句中的回车换行符会被替换掉开始符,注意dsl注释不能放到sql语句中,否则会有问题,因为sql中的回车换行符会被去掉,导致回车换行符后面的语句变道与注释一行
     ##  导致dsl模板解析的时候部分sql段会被去掉
        "query": #"""
                SELECT * FROM dbclobdemo
                    where channelId=#[channelId]
         """,
         ## 指示sql语句中的回车换行符会被替换掉结束符
        "fetch_size": #[fetchSize]
     }
    ]]>
</property>

变量使用注意事项

bboss dsl语法支持#[channelId]和$channelId两种模式的变量定义,在sql语句中使用变量需要注意几个地方,下面的举例说明。

如果channelId是数字,那么以下两条sql语句的写法是等价的

SELECT * FROM dbclobdemo where channelId=#[channelId]

SELECT * FROM dbclobdemo where channelId=$channelId

如果channelId是字符串,那么分两种情况处理

情况1 channelId中不会包含回车换行之类的特殊字符,那么下面两种写法等价

SELECT * FROM dbclobdemo where channelId='#[channelId,quoted=false]'

SELECT * FROM dbclobdemo where channelId='$channelId'

#[channelId,quoted=false]中必须包含属性quoted=false,指示框架不要在值的两边加双"号,否则会破坏sql语法

情况2 channelId中会或者可能会包含回车换行之类的特殊字符,那么只能采用以下的写法

SELECT * FROM dbclobdemo where channelId='#[channelId,quoted=false]'

bboss执行sql分页查询方法:

/**
 * 配置文件中的sql dsl检索,返回Map类型集合,亦可以返回自定义的对象集合
 */
@Test
public void testObjectSQLQueryFromDSL(){
   ClientInterface clientUtil = ElasticSearchHelper.getConfigRestClientUtil("esmapper/sql.xml");//初始化一个加载sql配置文件的es客户端接口
   //设置sql查询的参数

   Map params = new HashMap();
   params.put("channelId",1);
   params.put("fetchSize",1);
   SQLResult<DocObject> sqlResult = clientUtil.fetchQuery(DocObject.class,"sqlPagineQuery",params);

   do{
      List<DocObject> datas = sqlResult.getDatas();
      if(datas == null || datas.size() == 0){
         System.out.println(0);//处理数据
         break;
      }
      else{
         System.out.println(datas.size());//处理数据
         sqlResult = sqlResult.nextPage();//获取下一页数据

      }

   }while(true);

}

5.3.5 文本块脚本配置语法用法

在一些脚本或者字段值中可能存在一个值占多行的场景,那么在dsl配置中,bboss提供了以下语法了对这些值进行处理:

@"""

多行值

多行值

"""
  • 简单脚本案例

字段中的多行值案例 

    <property name="scriptPianduan">
        <![CDATA[
            "params": {
              "last": @"""
              asdfasdfasdf
                asdfasdfasdfasdfasdf
              """,
              "nick": #[nick]
            }
        ]]>
    </property>

以下是一个script的应用案例

    <property name="scriptPianduan">
        <![CDATA[
            "params": {
              "last": #[last],
              "nick": #[nick]
            }
        ]]>
    </property>
    <property name="scriptDsl">
        <![CDATA[{
          "script": {
            "lang": "painless",
            "source": @""" ## 脚本开始
              ctx._source.last = params.last;
              ctx._source.nick = params.nick
            """,## 脚本结束
            @{scriptPianduan}
          }
        }]]>
    </property>

执行上述脚本的java代码示例:

    private String mappath = "esmapper/demo.xml";

	public void updateDocumentByScriptPath(){
		DocumentCRUD documentCRUD = new DocumentCRUD();
		documentCRUD.testCreateIndice();
		documentCRUD.testBulkAddDocument();
		//创建加载配置文件的客户端工具,用来检索文档,单实例多线程安全
		ClientInterface clientUtil = ElasticSearchHelper.getConfigRestClientUtil(mappath);
		Map<String,Object> params = new HashMap<String,Object>();
		 
		params.put("last","gaudreau");
		params.put("nick","hockey");
		clientUtil.updateByPath("demo/demo/2/_update?refresh","scriptDsl",params);
		String doc = clientUtil.getDocument("demo","demo","2");
		System.out.println(doc);

	}
  • 更加复杂的案例 

    <property name="scriptPianduan1">
        <![CDATA[
            "params": {
              "last": #[last],
              "nick": #[nick],
              "goodsId": #[dynamicPriceTemplate->goodsId],
              "rules":[
                   #foreach($rule in $dynamicPriceTemplate.rules)
                       #if($velocityCount > 0),#end
                   {
                        "ruleId": #[dynamicPriceTemplate->rules[$velocityCount]->ruleId],
                        "ruleCount": #[dynamicPriceTemplate->rules[$velocityCount]->ruleCount],
                        "ruleExist": #[dynamicPriceTemplate->rules[$velocityCount]->ruleExist]
                    }
                   #end
              ]
            }
        ]]>
    </property>

    <property name="scriptPianduan2">
        <![CDATA[
            "params": {
              "last": #[last],
              "nick": #[nick],
              "goodsId": #[dynamicPriceTemplate->goodsId],
              "rules":[
                   #foreach($rule in $dynamicPriceTemplate.rules)
                       #if($velocityCount > 0),#end
                       #[dynamicPriceTemplate->rules[$velocityCount],serialJson=true] ## 通过属性serialJson指示框架直接将对象序列化为json数据
                   #end
              ]
            }
        ]]>
    </property>

    <property name="scriptPianduan">
        <![CDATA[
            "params": {
              "last": #[last],
              "nick": #[nick],
              "goodsId": #[dynamicPriceTemplate->goodsId],
              "rules":[
                   #foreach($rule in $dynamicPriceTemplate.rules)
                       #if($velocityCount > 0),#end
                   {

                        "ruleId": "$rule.ruleId",
                        "ruleCount": $rule.ruleCount,
                        "ruleExist":  $rule.ruleExist

                    }
                   #end
              ]
            }
        ]]>
    </property>
    <property name="scriptDsl">
        <![CDATA[{
          "script": {
            "lang": "painless",
            "source": @"""
              ctx._source.last = params.last;
              ctx._source.nick = params.nick;
              ctx._source.rules = params.rules
            """,
            @{scriptPianduan}
          }
        }]]>
    </property>

    <property name="scriptDslByQuery">
        <![CDATA[{
          "query": {
            "bool": {
              "must": [
                {
                  "term": {
                    "_id": #[id]
                  }
                }
              ]
            }
          },
          "script": {
            "lang": "painless",
            "source": @"""
              ctx._source.last = params.last;
              ctx._source.nick = params.nick;
              ctx._source.goodName = #[dynamicPriceTemplate->goodName,escapeCount=2];#*在脚本中,含有特殊字符的goodName需要转义2次*#
              ctx._source.goodsId = #[dynamicPriceTemplate->goodsId];
              ctx._source.dynamicPriceTemplate.goodsId = params.goodsId;
              ctx._source.rules = params.rules
            """,
            @{scriptPianduan2}
          }
        }]]>
    </property>

对应的java代码:

    public void updateDocumentByScriptQueryPath(){
		//初始化数据,会创建type为demo的indice demo,并添加docid为2的文档
		DocumentCRUD documentCRUD = new DocumentCRUD();
		documentCRUD.testCreateIndice();
		documentCRUD.testBulkAddDocument();
		//创建加载配置文件的客户端工具,用来检索文档,单实例多线程安全
		ClientInterface clientUtil = ElasticSearchHelper.getConfigRestClientUtil(mappath);
		Map<String,Object> params = new HashMap<String,Object>();
		DynamicPriceTemplate dynamicPriceTemplate = new DynamicPriceTemplate();
		dynamicPriceTemplate.setGoodsId(1);
		dynamicPriceTemplate.setGoodName("asd\"国家");
		List<Rule> ruleList = new ArrayList<Rule>();
		Rule rule = new Rule();
		rule.setRuleCount(100);
		rule.setRuleExist(true);
		rule.setRuleId("asdfasdfasdf");
		ruleList.add(rule);

		rule = new Rule();
		rule.setRuleCount(101);
		rule.setRuleExist(false);
		rule.setRuleId("bbbb");
		ruleList.add(rule);

		rule = new Rule();
		rule.setRuleCount(103);
		rule.setRuleExist(true);
		rule.setRuleId("ccccc");
		ruleList.add(rule);
		dynamicPriceTemplate.setRules(ruleList);


		//为id为2的文档增加last和nick两个属性
		params.put("last","gaudreau");
		params.put("nick","hockey");
		params.put("id",3);
		params.put("dynamicPriceTemplate",dynamicPriceTemplate);
		//通过script脚本为id为2的文档增加last和nick两个属性,为了演示效果强制refresh,实际环境慎用
		clientUtil.updateByPath("demo/demo/_update_by_query?refresh","scriptDslByQuery",params);
		//获取更新后的文档,会看到新加的2个字段属性
		String doc = clientUtil.getDocument("demo","demo","3");
		System.out.println(doc);

	}

5.3.5 逻辑判断和foreach循环用法

逻辑判断语法:#if-#else-#end,#if-#elseif-#else-#end

循环语法:#foreach-#end

循环控制计数器变量:velocityCount

举例说明如下:

案例1:#if-#end 和#foreach-#end相结合

如果集合中元素类型不确定,使用#[]类型变量

{
#foreach($ldxxbh in $ldxxbhs) //foreach循环,变量$ldxxbhs是一个list集合,$ldxxbh对应循环中的元素变量,
                                对应当前遍历的元素
   #if($velocityCount > 0),#end  //$velocityCount是foreach循环控制变量
        "v$velocityCount":#[ldxxbhs[$velocityCount]]  //拼接每个元素到脚本中,如果集合中元素类型不确定,使用#[]类型变量,同时又结合$velocityCount做集合的下标索引
   
#end  
}    

传入一个List集合的属性ldxxbhs,包含以下元素值:

{"aa",1,"bb",33,"cc"}

经过解析得到最终的query dsl脚本为:

{
   "v0":"aa",
   "v1":1,
   "v2":"bb",
   "v3":33,
   "v4":"cc" 
}

案例2:循环List或者数组中的bean对象,并访问每个bean对象属性id

"dynamic_price_template.rules":#foreach($rule in $rules)#if($velocityCount > 0),#end #[rules[$velocityCount]->id]  #end 

案例3:动态排序字段案例-#[xxx]模式变量(适合各种场景) 

#if($sortColumn)  ##动态排序字段案例
	"sort":[                   
		#foreach( $column in $sortColumn)
			#if($velocityCount > 0),#end
			{
				#[sortColumn[$velocityCount]->sort] :{
					"order" : #[sortColumn[$velocityCount]->order]
				}
			}
		#end
	],
#end

案例4:动态排序字段案例-$xxx模式变量 (适合集合值固定且长度固定并不包含特殊字符的场景)        

#if($sortColumn) 
	"sort":[                   
        #foreach( $column in $sortColumn)
            #if($velocityCount > 0),#end
            {
               "$column.Sort" :{
                   "order": "$column.Order"
                }
            }
        #end
   ],            
#end                

案例5:循环遍历map对象的key和值-$xxx模式变量

适合集合值固定且长度固定并不包含特殊字符的场景 

#if($sortColumn) #从map中获取所有的排序字段
	"sort":[             
        
            #foreach( $key in $columnMap.keySet() ) 
            #if($velocityCount > 0),#end
            {
                "$key": {
                   "order" :"$columnMap.get($key)"
                }				 
            }
            #end
   ],            
#end 

案例6:循环遍历map对象的key和值-#[xxx]模式变量 

适合集合值不固定,或者长度不固定,或者可能包含特殊字符等多种场景 

#if($sortColumn) #从map中获取所有的排序字段
	"sort":[             
        
            #foreach( $key in $columnMap.keySet() ) 
            #if($velocityCount > 0),#end
            {
               "$key": {
                   "order" :#[columnMap[$key]]
                }				 
            }
            #end
   ],            
#end 

案例7 #if-#else-#end结合$xxx变量

适合于集合元素少,值固定的场景,且值中不包含破坏json格式的特殊字符,否则参考案例8或者案例9

#if(!$searchFields && $searchFields.size() == 0)
    "fields": ["rpc","params","agentId","applicationName","endPoint","remoteAddr"]
#else
    "fields":[
          #foreach($field in $searchFields)
             #if($velocityCount > 0),#end "$field" //拼接每个元素到脚本中,如果集合中元素类型确定,使用$xxx类型变量
          #end
     ]
#end

案例8 #if-#else-#end结合#[xxx]变量(适合各种场景)

如果集合元素,使用$xxx类型变量,以拼接检索字段为例: 

#if(!$searchFields && $searchFields.size() == 0)
    "fields": ["rpc","params","agentId","applicationName","endPoint","remoteAddr"]
#else
    "fields":[
          #foreach($field in $searchFields)
             #if($velocityCount > 0),#end #[searchFields[$velocityCount]]
          #end
     ]
#end

案例9 #if-#else-#end结合#[xxx,serialJson=true]变量

(适合各种场景)

#if(!$searchFields && $searchFields.size() == 0)
    "fields": ["rpc","params","agentId","applicationName","endPoint","remoteAddr"]
#else
    "fields":#[searchFields,serialJson=true]
#end

案例10 foreach循环嵌套遍历map

foreach嵌套dsl脚本定义

    <property name="dynamicInnerDsl">
        <![CDATA[{ ## 最多返回1000条记录
            size: #[size],
            "query": {
                "bool": {
                    "must": [
                    #set($needComma = false)
                    #foreach($condition in $conditions.entrySet())
                        #foreach($item in $condition.value.entrySet())
                        #if($needComma), #else #set($needComma = true) #end
                        {
                            "$condition.key": {
                                "$item.key": #[conditions[$condition.key][$item.key],serialJson=true]
                            }
                        }
                        #end
                    #end
                    ]
                }
            }
        }]]>
    </property>

传递参数和解析上述dsl的java方法代码

	@Test
	public void dynamicInnerDsl(){
		Map conditions = new HashMap<String,Map<String,Object>>();
		Map<String,Object> term = new HashMap<String, Object>();
		term.put("terma","tavalue");
		term.put("termb","tbvalue");
		term.put("termc","tcvalue");
		conditions.put("term",term);

		Map<String,Object> terms = new HashMap<String, Object>();
		terms.put("termsa",new String[]{"tavalue","tavalue1"});
		terms.put("termsb",new String[]{"tbvalue","tbvalue1"});
		terms.put("termsc",new String[]{"tcvalue","tcvalue1"});
		conditions.put("terms",terms);

		Map params = new HashMap();
		params.put("conditions",conditions);
		params.put("size",1000);
		//加载配置文件中的dsl信息,解析dsl语句dynamicInnerDsl
		ESUtil esUtil = ESUtil.getInstance("esmapper/dsl.xml");
		String parseResult = ESTemplateHelper.evalTemplate(esUtil,"dynamicInnerDsl",params);
		//打印解析结果
		System.out.println(parseResult);

	}

运行上述代码打印出来的实际dsl

{
    "size": 1000,
    "query": {
        "bool": {
            "must": [
                {
                    "terms": {
                        "termsc": ["tcvalue","tcvalue1"]
                    }
                },
                {
                    "terms": {
                        "termsa": ["tavalue","tavalue1"]
                    }
                },
                {
                    "terms": {
                        "termsb": ["tbvalue","tbvalue1"]
                    }
                },
                {
                    "term": {
                        "termb": "tbvalue"
                    }
                },
                {
                    "term": {
                        "termc": "tcvalue"
                    }
                },
                {
                    "term": {
                        "terma": "tavalue"
                    }
                }
            ]
        }
    }
}

案例11 综合案例

{
    "query": {
        "bool": {
            "filter": [
                #if($channelApplications && $channelApplications.size() > 0)
                {
                    "terms": {
                        "applicationName.keyword": [
                        #foreach($application in $channelApplications) ## 遍历列表channelApplications,列表中对象类型Application包含属性applicationName
                           #if($velocityCount > 0),#end #[channelApplications[$velocityCount]->applicationName] ## 引用列表中元素属性applicationName的语法
                        #end
                        ]
                    }
                },
                #end
                {"range": {
                        "startTime": {
                            "gte": #[startTime],##统计开始时间
                            "lt": #[endTime]  ##统计截止时间
                        }
                    }
                }
            ]
        }
    },
    "size":0,
    "aggs": {
        "applicationsums": {
              "terms": {
                "field": "applicationName.keyword",##按应用名称进行统计计数
                "size":10000
              },
              "aggs":{
                    "successsums" : {
                        "terms" : {
                            "field" : "err" ##按err标识统计每个应用的成功数和失败数,0标识成功,1标识失败
                        }
                    },
                    "elapsed_ranges" : {
                        "range" : {
                            "field" : "elapsed", ##按响应时间分段统计
                            "keyed" : true,
                            "ranges" : [
                                { "key" : "1秒", "to" : 1000 },
                                { "key" : "3秒", "from" : 1000, "to" : 3000 },
                                { "key" : "5秒", "from" : 3000, "to" : 5000 },
                                { "key" : "5秒以上", "from" : 5000 }
                            ]
                        }
                    }
              }
        }
    }
}

5.3.6 日期类型使用方法

bboss对于日期类型的映射处理比较简单,分为两种情况:

第一种情况,采用默认的时间格式和utc时区定义,mapping field定义如下:

"agentStarttime": {
    "type": "date"     
}

那么我们在对象中也只需要定义一个日期类型的字段与之对应即可: 

private Date agentStarttime;

第二种情况,定义mapping field时指定了时间格式:

"agentStarttime": {
    "type": "date",
     "format":"yyyy-MM-dd HH:mm:ss"
},

那么我们在对象中除了定义日期类型的字段,还要为字段加上时间格式的注解: 

@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
@Column(dataformat = "yyyy-MM-dd HH:mm:ss")
protected Date agentStarttime;

其中的pattern和dataformat必须和mapping中指定的格式一致。

5.3.7 dsl配置文件中关于dsl解析语法树缓存相关配置

可以在配置文件中直接指定dsl语法解析缓存参数(一般采用默认配置即可)

perKeyDSLStructionCacheSize:配置文件中对应的dsl可以缓存的解析后的最大dsl语法结构个数

alwaysCacheDslStruction:布尔值,单个dsl超过perKeyDSLStructionCacheSize指定的dsl个数后,是否继续缓存dsl语句,true 缓存,并且清除不经常使用的dsl,false 不缓存(默认值),每次都硬解析。

<property name="perKeyDSLStructionCacheSize" value="2000"/>
<property name="alwaysCacheDslStruction" value="false"/>

5.4 一些小技巧

5.4.1 多条件判断逗号追加问题处理技巧

经常在dsl中碰到很多个条件的动态组合,中间的,号出现的位置不确定,例如:

{
	"from": #[from],
	"size": #[size],
	"query": {
		"bool": {
			"filter": [
				#if($orderId)
					{
						"term": {
							"orderId.keyword":  #[orderId]
						}
					},
				#end
				#if($startCreateDatetime || $endCreateDatetime)
				{
					"range": {
					  "createDatetime": {
						#if($startCreateDatetime)
						 "gte":  #[startCreateDatetime]
						#end
						#if($startCreateDatetime && $endCreateDatetime)
						 ,
						#end
						#if($endCreateDatetime)
						 "lte": #[endCreateDatetime]
						#end
					  }
					}
				},
				#end
				#if($machineId)
				{
					"term": {
						"machineId":  #[machineId]
					}
				},
				#end
				#if($status)
				{
					"term": {
						"status.keyword":  #[status]
					}
				},
				#end
				#if($payCategoryName)
				{
					"term": {
						"payCategoryName.keyword":  #[payCategoryName]
					}
				},
				#end
				#if($payMode)
				{
					"term": {
						"payMode.keyword":  #[payMode]
					}
				},
				#end
				#if($couponId)
				{
					"term": {
						"couponId.keyword":  #[couponId]
					}
				},
				#end
				#if($payAccount)
				{
					"term": {
						"payAccount.keyword":  #[payAccount]
					}
				},
				#end
				#if($startPayDatetime || $endPayDatetime)
				{
					"range": {
					  "payDatetime": {
						#if($startPayDatetime)
						 "gte":  #[startPayDatetime]
						#end
						#if($startPayDatetime && $endPayDatetime)
						 ,
						#end
						#if($endPayDatetime)
						 "lte": #[endPayDatetime]
						#end
					  }
					}
				},
				#end
					#if($tradeNo)
				{
					"term": {
						"tradeNo.keyword":  #[tradeNo]
					}
				},
				#end
				#if($operatorId)
				{
					"term": {
						"operatorId.keyword":  #[operatorId]
					}
				},
				#end
				#if($officeId)
				{
					"term": {
						"officeId.keyword":  #[officeId]
					}
				},
				#end
				#if($netId)
				{
					"term": {
						"netId.keyword":  #[netId]
					}
				},
				#end
				#if($pointId)
				{
					"term": {
						"pointId.keyword":  #[pointId]
					}
				},
				#end
				#if($isContrast)
				{
					"term": {
						"isContrast.keyword":  #[isContrast]
					}
				},
				#end
				#if($startUpdateDatetime || $endUpdateDatetime)
				{
					"range": {
					  "updateDatetime": {
						#if($startUpdateDatetime)
						 "gte":  #[startUpdateDatetime]
						#end
						#if($startUpdateDatetime && $endUpdateDatetime)
						 ,
						#end
						#if($endUpdateDatetime)
						 "lte": #[endUpdateDatetime]
						#end
					  }
					}
				},
				#end
				#if($contrastStatus)
				{
					"term": {
						"contrastStatus.keyword":  #[contrastStatus]
					}
				},
				#end
				#if($oprOrgId)
				{
					"term": {
						"oprOrgId.keyword":  #[oprOrgId]
					}
				},
				#end
				#if($isClearing)
				{
					"term": {
						"isClearing.keyword":  #[isClearing]
					}
				},
				#end
				#if($machineType)
				{
					"term": {
						"machineType.keyword":  #[machineType]
					}
				},
				#end
				#if($orderId)
					{
						"term": {
							"orderId.keyword":  #[orderId]
						}
					}
				#end
			]
		}
	}
}

逗号放到正确的位置的技巧如下:定义一个boolean局部变量来控制,变量定义语法为:

#set( $needComma = false )

加上变量后的dsl如下:

{
	"from": #[from],
	"size": #[size],
	"query": {
		"bool": {
			"filter": [
			    #set( $needComma = false )
				#if($orderId)
					{
						"term": {
							"orderId.keyword":  #[orderId]
						}
					}
					#set( $needComma = true )
				#end
				
				#if($startCreateDatetime || $endCreateDatetime)
				#if($needComma),#else #set( $needComma = true ) #end	
				{					 				
					"range": {
					  "createDatetime": {
						#if($startCreateDatetime)
						 "gte":  #[startCreateDatetime]
						#end
						#if($startCreateDatetime && $endCreateDatetime)
						 ,
						#end
						#if($endCreateDatetime)
						 "lte": #[endCreateDatetime]
						#end
					  }
					}
				}
				#end
				#if($machineId)
				#if($needComma),#else #set( $needComma = true ) #end	
				{					 
					"term": {
						"machineId":  #[machineId]
					}
				}
				#end
				#if($status)
				#if($needComma),#else #set( $needComma = true ) #end	
				{					
					"term": {
						"status.keyword":  #[status]
					}
				}
				#end
				
				#if($machineType)
				#if($needComma),#else #set( $needComma = true ) #end	
				{					
					"term": {
						"machineType.keyword":  #[machineType]
					}
				}
				#end
				#if($orderId)
				#if($needComma),#end	
				{
					"term": {
						"orderId.keyword":  #[orderId]
					}
				}
				#end
			]
		}
	}
}

 

6 代码演示和文档资料

6.1 完整query dsl定义文件

esmapper/estrace/ESTracesMapper.xml

<!--es
https://www.elastic.co/guide/en/elasticsearch/reference/5.5/query-dsl-term-query.html
https://www.elastic.co/guide/en/elasticsearch/reference/5.5/query-dsl-range-query.html
-->

6.2 索引表模板新增和删除

ESTemplate.xml文件定义

public void testTempate() throws ParseException{

		ClientInterface clientUtil = ElasticSearchHelper.getConfigRestClientUtil("esmapper/estrace/ESTemplate.xml");
		//创建模板
		String response = clientUtil.createTempate("demotemplate_1",//模板名称
				"demoTemplate");//模板对应的脚本名称,在esmapper/estrace/ESTemplate.xml中配置
		System.out.println("createTempate-------------------------");
		System.out.println(response);
		//获取模板
		/**
		 * 指定模板
		 * /_template/demoTemplate_1
		 * /_template/demoTemplate*
		 * 所有模板 /_template
		 *
		 */
		String template = clientUtil.executeHttp("/_template/demotemplate_1",ClientUtil.HTTP_GET);
		System.out.println("HTTP_GET-------------------------");
		System.out.println(template);
		//删除模板
		template = clientUtil.executeHttp("/_template/demotemplate_1",ClientUtil.HTTP_DELETE);
		System.out.println("HTTP_DELETE-------------------------");
		System.out.println(template);

		template = clientUtil.executeHttp("/_template/demotemplate_1",ClientUtil.HTTP_GET);
		System.out.println("HTTP_GET after delete-------------------------");
		System.out.println(template);
	}

6.3 创建和查询索引表模板

ESTemplate.xml文件定义

public void testCreateTempate() throws ParseException{

   ClientInterface clientUtil = ElasticSearchHelper.getConfigRestClientUtil("esmapper/estrace/ESTemplate.xml");
   //创建模板
   String response = clientUtil.createTempate("demotemplate_1",//模板名称
         "demoTemplate");//模板对应的脚本名称,在estrace/ESTemplate.xml中配置
   System.out.println("createTempate-------------------------");
   System.out.println(response);
   //获取模板
   /**
    * 指定模板
    * /_template/demoTemplate_1
    * /_template/demoTemplate*
    * 所有模板 /_template
    *
    */
   String template = clientUtil.executeHttp("/_template/demotemplate_1",ClientUtil.HTTP_GET);
   System.out.println("HTTP_GET-------------------------");
   System.out.println(template);

}

 

6.4 更新x-pack license

public void testLicense(){
        ClientInterface clientUtil = ElasticSearchHelper.getConfigRestClientUtil("esmapper/estrace/ESTemplate.xml");
   
		String ttt = clientUtil.executeHttp("_xpack/license?acknowledge=true","license",ClientUtil.HTTP_PUT);
		System.out.println(ttt);
//		ttt = clientUtil.createTempate("tracesql_template","traceSQLTemplate");
	}

6.5 创建索引表

 ClientInterface clientUtil = ElasticSearchHelper.getConfigRestClientUtil("esmapper/estrace/ESTracesMapper.xml");
String ret = clientUtil.createIndiceMapping("trace", "createTraceIndice") ;

6.6 获取索引表结构

json格式

public void testGetmapping(){
   SimpleDateFormat format = new SimpleDateFormat("yyyy.MM.dd");
   String date = format.format(new Date());
  ClientInterface clientUtil = ElasticSearchHelper.getRestClientUtil();
   System.out.println(clientUtil.getIndexMapping("demo-*"));
   clientUtil.dropIndice("demo-"+date);
}

 

字段列表

public void testQueryDocMapping(){
   ClientInterface clientUtil = ElasticSearchHelper.getRestClientUtil();
   List<IndexField> fields = clientUtil.getIndexMappingFields("trace-*",//索引表名称
                                                              "trace");//索引类型
   System.out.println(fields.size());
}

6.7 单文档操作

public void testAddDateDocument() throws ParseException{
   testGetmapping();
   SimpleDateFormat format = new SimpleDateFormat("yyyy.MM.dd");
   String date = format.format(new Date());
   ClientInterface clientUtil = ElasticSearchHelper.getConfigRestClientUtil("esmapper/estrace/ESTracesMapper.xml");
   Demo demo = new Demo();
   demo.setDemoId(5l);
   demo.setAgentStarttime(new Date());
   demo.setApplicationName("blackcatdemo");
   demo.setContentbody("this is content body");
   //根据dsl脚本创建索引文档,将文档保存到当天的索引表中demo-2018.02.03
   String response = clientUtil.addDateDocument("demo",//索引表,自动添加日期信息到索引表名称中
         "demo",//索引类型
         "createDemoDocument",//创建文档对应的脚本名称,在esmapper/estrace/ESTracesMapper.xml中配置
         demo);

   System.out.println("addDateDocument-------------------------");
   System.out.println(response);
  //根据文档id获取索引文档,返回json格式
   response = clientUtil.getDocument("demo-"+date,//索引表,手动指定日期信息
         "demo",//索引类型
         "5");
   System.out.println("getDocument-------------------------");
   System.out.println(response);
//根据文档id获取索引文档,返回Demo对象
   demo = clientUtil.getDocument("demo-"+date,//索引表
         "demo",//索引类型
         "5",//索引文档ID
         Demo.class);
}

创建索引文档脚本:createDemoDocument

 <property name="createDemoDocument">
        <![CDATA[{"applicationName" : #[applicationName],"agentStarttime" : #[agentStarttime],"contentbody" : #[contentbody]}]]>
    </property>

 

6.8 批量操作

public void testBulkAddDateDocument() throws ParseException{
   testGetmapping();
   SimpleDateFormat format = new SimpleDateFormat("yyyy.MM.dd");
   String date = format.format(new Date());
   ClientInterface clientUtil = ElasticSearchHelper.getConfigRestClientUtil("esmapper/estrace/ESTracesMapper.xml");
   List<Demo> demos = new ArrayList<>();
   Demo demo = new Demo();
   demo.setDemoId(2l);
   demo.setAgentStarttime(new Date());
   demo.setApplicationName("blackcatdemo2");
   demo.setContentbody("this is content body2");
   demos.add(demo);

   demo = new Demo();
   demo.setDemoId(3l);
   demo.setAgentStarttime(new Date());
   demo.setApplicationName("blackcatdemo3");
   demo.setContentbody("this is content body3");
   demos.add(demo);

   //批量添加索引文档
   String response = clientUtil.addDateDocuments("demo",//索引表
         "demo",//索引类型
         "createDemoDocument",//创建文档对应的脚本名称,在esmapper/estrace/ESTracesMapper.xml中配置
         demos);

   System.out.println("addDateDocument-------------------------");
   System.out.println(response);

   response = clientUtil.getDocument("demo-"+date,//索引表
         "demo",//索引类型
         "2");
   System.out.println("getDocument-------------------------");
   System.out.println(response);

   demo = clientUtil.getDocument("demo-"+date,//索引表
         "demo",//索引类型
         "3",//索引文档ID
         Demo.class);
}

6.9 管理类api演示

管理类api演示,以健康状态和集群状态为例进行说明,其他服务调整服务地址即可。更多的服务参考elasticsearch官方文档地址:集群  Cat

    @Test
	public void clusterHeathCheck(){
		ClientInterface clientUtil = ElasticSearchHelper.getRestClientUtil();
		//返回json格式健康状态
		String heath = clientUtil.executeHttp("_cluster/health?pretty",ClientInterface.HTTP_GET);
		System.out.println(heath);

	}

	@Test
	public void clusterState(){
		ClientInterface clientUtil = ElasticSearchHelper.getRestClientUtil();
		//返回json格式集群状态
		String state = clientUtil.executeHttp("_cluster/state?pretty",ClientInterface.HTTP_GET);
		System.out.println(state);

	}

	@Test
	public void clusterMapState(){
		ClientInterface clientUtil = ElasticSearchHelper.getRestClientUtil();
		//返回map类型集群状态信息
		Map<String,Object> state = clientUtil.executeHttp("_cluster/state",ClientInterface.HTTP_GET,new MapResponseHandler());
		System.out.println(state);

	}

6.10 执行列子代码:TestMain.java

public static void main(String[] args) throws ParseException {
   ESTest esTest = new ESTest();
   //测试模板管理功能
   esTest.testTempate();
   //重新创建模板
   esTest.testCreateTempate();
   //向当天的索引表中添加文档
   esTest.testAddDateDocument();
   //批量创建文档
   esTest.testBulkAddDateDocument();
   //获取索引映射结构
   esTest.testGetmapping();
}

6.11 一个聚合查询的案例

http://yin-bp.iteye.com/blog/2408321

6.12 suggest使用案例

https://gitee.com/bboss/elasticsearchdemo/tree/master/src/test/java/org/frameworkset/elasticsearch/suggest

https://gitee.com/bboss/elasticsearchdemo/blob/master/src/test/resources/esmapper/estrace/suggest.xml

6.13 Elasticsearch Mget、GetDocSource、索引部分字段更新案例

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

6.14 scroll分页检索案例

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

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

6.15 Elasticsearch地理位置维护及检索案例

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

6.16 Elasticsearch 父子关系维护和检索案例

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

6.17 Elasticsearch Delete/UpdateByquery案例

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

7 相关资料

7.1 完整的demo

https://gitee.com/bboss/eshelloword-booter(基于maven)

https://gitee.com/bboss/eshelloword-spring-boot-starter(基于maven)

https://gitee.com/bboss/elasticsearchdemo (基于gradle)

7.2 bboss elasticsearch特点

https://www.oschina.net/p/bboss-elastic

7.3 es query dsl语法请参考官方文档

https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html

https://www.elastic.co/guide/en/elasticsearch/reference/current/search.html

https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations.html

velocity官方文档:

http://velocity.apache.org/engine/1.7/user-guide.html

7.4 开发交流

elasticsearch技术交流:166471282

elasticsearch:

© 著作权归作者所有

共有 人打赏支持
bboss

bboss

粉丝 109
博文 60
码字总数 67693
作品 8
长沙
程序员
私信 提问
加载中

评论(8)

bboss
bboss

引用来自“血色残阳1987”的评论

Json不能格式化 很痛苦
下载一个jsonView的工具,格式化一下
血色残阳1987
Json不能格式化 很痛苦
bboss
bboss

引用来自“zhaobohao”的评论

5.0.5.3 版本,写testCase的时候,报
Caused by: java.lang.NoClassDefFoundError: Could not initialize class org.apache.http.conn.ssl.SSLConnectionSocketFactory
  at org.frameworkset.spi.remote.http.ClientConfiguration.buildSSLConnectionSocketFactory(ClientConfiguration.java:222)
  at org.frameworkset.spi.remote.http.ClientConfiguration.getHttpClient(ClientConfiguration.java:293)
  at org.frameworkset.spi.remote.http.ClientConfiguration.afterPropertiesSet(ClientConfiguration.java:440)
但SSLConnectionSocketFactory这个类确认是有的,能够找到,何解?
应该是你项目依赖的http版本低了,以bboss的依赖的版本为准就可以了,可以加bboss交流群讨论:166471282
目前依赖的http组件版本为:
[group: 'org.apache.httpcomponents', name: 'httpclient', version: '4.5.3', transitive: false],
[group: 'org.apache.httpcomponents', name: 'httpcore', version: '4.4.5', transitive: false],
[group: 'org.apache.httpcomponents', name: 'httpmime', version: '4.5.3', transitive: false],
zhaobohao
zhaobohao
5.0.5.3 版本,写testCase的时候,报
Caused by: java.lang.NoClassDefFoundError: Could not initialize class org.apache.http.conn.ssl.SSLConnectionSocketFactory
  at org.frameworkset.spi.remote.http.ClientConfiguration.buildSSLConnectionSocketFactory(ClientConfiguration.java:222)
  at org.frameworkset.spi.remote.http.ClientConfiguration.getHttpClient(ClientConfiguration.java:293)
  at org.frameworkset.spi.remote.http.ClientConfiguration.afterPropertiesSet(ClientConfiguration.java:440)
但SSLConnectionSocketFactory这个类确认是有的,能够找到,何解?
wenthywang
wenthywang
你好 大概看了下 还是不错的orm 但我更喜欢sql类型的操作 如果你这个能改成sql类型 应该会更好 我暂时在用es-sql
持续关注中
bboss
bboss
欢迎大家参与working
bboss
bboss

引用来自“红薯”的评论

姿势不对,不是应该贴 gitee 的地址吗?:)
姿势已纠正,请红薯老大鉴别👏
红薯
红薯
姿势不对,不是应该贴 gitee 的地址吗?:)
bboss elasticsearch v5.0.3.9.5 发布

bboss elasticsearch v5.0.3.9.5发布。 bboss elasticsearch特性 bboss es是一个不错的elasticsearch java客户端、高性能Elasticsearch ORM开发库。bboss es类似于mybatis,使用xml文件管理e...

bboss
2018/03/02
598
1
bboss es 5.0.3.9.1 发布,高性能Elasticsearch ORM开发库

高性能Elasticsearch ORM开发库bboss es 5.0.3.9.1发布 bboss es是一款基于query dsl语法的Elasticsearch ORM开发库,底层基于http restful。使用bboss es,可以快速编写出访问和操作elastic...

bboss
2018/01/30
1K
4
高性能Elasticsearch ORM开发库bboss es 5.0.3.7.8发布

bboss es v5.0.3.7.8已发布。bboss elasticsearch是一套基于query dsl语法操作访问分布式搜索引擎elasticsearch的o/r mapping开发库,底层基于es restful api。使用bboss es,可以快速编写出...

bboss
2017/11/16
1K
4
bboss elasticsearch v5.0.6.0 发布

bboss elasticsearch v5.0.6.0 发布 bboss elasticsearch是一款高性能的elasticsearch orm java客户端框架,具备以下主要特性: 简单易用:基于xml配置和管理dsl,在dsl脚本中可以使用变量、...

bboss
2018/04/20
975
2
bboss elasticsearch v5.0.6.2 发布

The best elasticsearch highlevel java rest api-----bboss bboss elasticsearch v5.0.6.2 发布 v5.0.6.2新增功能及改进: 1.升级最新的bboss版本到5.0.5.7 2.新增bboss es rest boot模块,......

bboss
2018/04/29
519
1

没有更多内容

加载失败,请刷新页面

加载更多

java框架学习日志-13(Mybatis基本概念和简单的例子)

在mybatis初次学习Mybatis的时候,遇到了很多问题,虽然阿里云的视频有教学,但是视频教学所使用的软件和我自己使用的软件不用,我自己用的数据库是oracle数据库,开发环境是idea。而且视频中...

白话
今天
2
0
Java基础:String、StringBuffer和StringBuilder的区别

1 String String:字符串常量,字符串长度不可变。Java中String是immutable(不可变)的。 String类的包含如下定义: /** The value is used for character storage. */private final cha...

watermelon11
今天
2
0
mogodb服务

部署MongoDB 官网: https://www.mongodb.com/download-center/community 创建mongo数据目录 mkdir /data/mongodb 二进制部署 wget -c https://fastdl.mongodb.org/linux/mongodb-linux-x8......

以谁为师
昨天
5
0
大神教你Debian GNU/Linux 9.7 “Stretch” Live和安装镜像开放下载

Debian项目团队于昨天发布了Debian GNU/Linux 9 "Stretch" 的第7个维护版本更新,重点修复了APT软件管理器中存在的安全漏洞。在敦促每位用户尽快升级系统的同时,Debian团队还发布了Debian ...

linux-tao
昨天
4
0
PHP 相关配置

1. php-fpm的pool 编辑php-fpm配置文件php-fpm.con vim /usr/local/php/etc/php-fpm.conf //在[global]部分增加以下内容 include = etc/php-fpm.d/*.conf # 相当与Nginx的虚拟主机文件 “vho......

Yue_Chen
昨天
2
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部