使用Java Rest Client操作Elasticsearch

心已赠人 2022-04-06 10:38 310阅读 0赞

Elasticsearch作为一个成熟的开源框架，对主流的多种客户端语言都支持，比如Java，JavaScript ，PHP，.Net，Python，Ruby，CURL当然还有一些小众的语言，虽然es官网没支持，但是个人开发者也有一些开源的，具体的可在es官网clients地址查看：

https://www.elastic.co/guide/en/elasticsearch/client/index.html

开发过程中，基本最常用的就是Java和curl的方式了，因为es本身就是使用java语言开发的，所以对Java的支持应该是最到位了，此外es也支持rest ful的DSL的访问方式，我们可以在linux上轻松的使用curl命令来对es进行增删改查，curl的操作方式大多数都是临时的，实际开发的我们还是用编程语言来访问的：  
  
es支持Java API的访问方式，支持非常全面，唯一的缺点就是依赖有点多，代码稍臃肿，有时候我们想简单的开发一个非常小的功能，又不想使用java笨重的客户端方式，应该怎么办？  
  
上文说到es支持rest的访问方式，那么我们完全可以使用httpclient或者jsoup来直接发送http请求不就行了吗？其实是可以的，使用httpclient和jsoup来发送curl的命令也能操作es，获取结果。这里面有一个需要注意的地方。  
  
httpclient和jsoup都不直接支持发送DELETE方法带参数的请求，这一点是个小缺陷，如果这个不支持，意味着一些删除操作比如delete by query可能支持不太好。jsoup是完全不支持，而在httpclient里面我们可以通过继承重写HttpEntityEnclosingRequestBase来满足，删除请求带参数体，下面来看下如何使用：  
  
继承重写的代码：

package tools;
    
    import org.apache.http.client.methods.HttpEntityEnclosingRequestBase;
    
    import java.net.URI;
    
    public class MyHttpDelete extends HttpEntityEnclosingRequestBase {
       
        //
        public static final String METHOD_NAME = "DELETE";
        //
        public String getMethod() {
       
            return METHOD_NAME;
        }
        //
        public MyHttpDelete(final String uri) {
       
            super();
            setURI(URI.create(uri));
        }
        //
        public MyHttpDelete(final URI uri) {
       
            super();
            setURI(uri);
        }
        //
        public MyHttpDelete() {
       
            super();
        }
    }

然后使用httpclient发送一个删除请求：

//实例化http，删除id=1001的一条数据
        val client = HttpClients.createDefault()
        val httpdelete = new MyHttpDelete("http://localhost:9200/test_index/logs/_query")
        val s = new StringEntity("{  \"query\": {   \"query_string\": {     \"query\":  id:1001    "       }  }} ",ContentType.APPLICATION_JSON)
        httpdelete.setEntity(s)
        val rs=client.execute(httpdelete)//执行删除
        //解析响应结果
        val json = EntityUtils.toString(rs.getEntity(), "UTF-8")
        //释放资源
        client.close()

httpclient还是比较强大的，但是上面的代码还是有点复杂，而且涉及连接的地方是有问题的，我们都知道es一般都是多台机器组成集群，而使用原生的httpclient请求建立的链接只能是某一台机器的ip这样一来，如果这台机器挂掉这个客户端程序就完全不能使用了，所以风险还是比较大的，不过也不用担心，es官网也提供了ES Java RestClient的方式来访问es，这个库底层用的也是httpclient的组件，只不过es官网做了封装，支持多机器ip，以及对请求方法做了简化，所以想减少项目的依赖，又对支持功能要求比较健壮，我们就可以使用这个库来开发我们的业务。  
  
官网文档地址：  
  
\[url\]https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/index.html\[/url\]  
  
  
maven依赖：

<dependency>
        <groupId>org.elasticsearch.client</groupId>
        <artifactId>rest</artifactId>
        <version>5.5.1</version>
    </dependency>

下面来看下，如何使用ES的RestClient来操作ES：

//初始化RestClient实例
     static  RestClient restClient = RestClient.builder(
                new HttpHost("192.168.10.5", 9200, "http"),
                new HttpHost("192.168.10.6", 9200, "http"),
                new HttpHost("192.168.10.7", 9200, "http")).build()
    
    
      // （1） 执行一个基本的方法，验证es集群是否搭建成功
    
       Response response = restClient.performRequest("GET", "/", Collections.singletonMap("pretty", "true"));
            System.out.println(EntityUtils.toString(response.getEntity()));
    
      //输出结果：
      {
       
      "name" : "nd2",
      "cluster_name" : "search",
      "version" : {
       
        "number" : "2.3.4",
        "build_hash" : "e455fd0c13dceca8dbbdbb1665d068ae55dabe3f",
        "build_timestamp" : "2016-06-30T11:24:31Z",
        "build_snapshot" : false,
        "lucene_version" : "5.5.0"
      },
      "tagline" : "You Know, for Search"
    }
    
    // （2）验证es的某个索引是否存在
    
    Response response = restClient.performRequest("HEAD","/product/pdt",Collections.<String, String>emptyMap());
            System.out.println(response.getStatusLine().getReasonPhrase().equals("OK"));
    
    //输出结果：
    
    true
    
    
    // (3) 删除某个索引的指定条件的数据
    
    
      Map<String, String> paramMap = new HashMap<String, String>();
                paramMap.put("q", "id:"+id);
                paramMap.put("pretty", "true");
                Response response = restClient.performRequest("DELETE",  + "product/pdt/_query", paramMap);
                System.out.println(EntityUtils.toString(response.getEntity()));
    
    
    //输出结果：
    
    {
       
      "took" : 0,
      "timed_out" : false,
      "_indices" : {
       
        "_all" : {
       
          "found" : 1,
          "deleted" : 0,
          "missing" : 0,
          "failed" : 0
        }
      },
      "failures" : [ ]
    }

总结：  
  
ES官网提供的RestClient还支持nio实现的异步非阻塞的方式多线程多送请求，通过回调函数来处理响应的结果，当然了权限认证，超时中断，失败重试，线程数都有对应的设置选项，感兴趣的朋友可自行查阅尝试。  
  
通过对比我们发现官网封装的RestClient使用起来更加简单和健壮，比起来没有包装的httpclient原生的方式更加符合生产环境的标准，对于不想熟悉标准的java api的es操作方法，又想通过java来访问es的朋友们，RestClient是一个不错的选择。  
  
\[b\]\[color=green\]\[size=large\] 有什么问题可以扫码关注微信公众号：我是攻城师(woshigcs)，在后台留言咨询。 技术债不能欠，健康债更不能欠， 求道之路，与君同行。 \[/size\]\[/color\]\[/b\] \[img\]http://dl2.iteye.com/upload/attachment/0104/9948/3214000f-5633-3c17-a3d7-83ebda9aebff.jpg\[/img\]