jkes下載 - jkes原始碼下載

jkes

其他源碼

v1.1.0

下載

Jkes

Jkes是一個基於Java、Kafka、ElasticSearch的搜尋框架。 Jkes提供了註解驅動的JPA風格的物件/文檔映射，使用rest api用於文檔搜尋。

安裝

可以參考jkes-integration-test專案快速掌握jkes框架的使用方法。 jkes-integration-test是我們用來測試功能完整性的一個Spring Boot Application。

安裝jkes-index-connector和jkes-delete-connector到Kafka Connect類別路徑
安裝Smart Chinese Analysis Plugin

sudo bin/elasticsearch-plugin install analysis-smartcn

配置

引入jkes-spring-data-jpa依賴
新增配置

 @ EnableAspectJAutoProxy
@ EnableJkes
@ Configuration
public class JkesConfig {

  @ Bean
  public PlatformTransactionManager transactionManager ( EntityManagerFactory factory , EventSupport eventSupport ) {

    return new SearchPlatformTransactionManager ( new JpaTransactionManager ( factory ), eventSupport );
  }
}

提供JkesProperties Bean

 @ Component
@ Configuration
public class JkesConf extends DefaultJkesPropertiesImpl {

    @ PostConstruct
    public void setUp () {
        Config . setJkesProperties ( this );
    }

    @ Override
    public String getKafkaBootstrapServers () {
        return "k1-test.com:9292,k2-test.com:9292,k3-test.com:9292" ;
    }

    @ Override
    public String getKafkaConnectServers () {
        return "http://k1-test.com:8084,http://k2-test.com:8084,http://k3-test.com:8084" ;
    }

    @ Override
    public String getEsBootstrapServers () {
        return "http://es1-test.com:9200,http://es2-test.com:9200,http://es3-test.com:9200" ;
    }

    @ Override
    public String getDocumentBasePackage () {
        return "com.timeyang.jkes.integration_test.domain" ;
    }

    @ Override
    public String getClientId () {
        return "integration_test" ;
    }

}

這裡可以很靈活，如果使用Spring Boot，可以使用@ConfigurationProperties提供配置

增加索引管理端點因為我們不知道客戶端使用的哪種web技術，所以索引端點需要在客戶端新增。例如在Spring MVC中，可以如下加入索引端點

 @ RestController
@ RequestMapping ( "/api/search" )
public class SearchEndpoint {

    private Indexer indexer ;

    @ Autowired
    public SearchEndpoint ( Indexer indexer ) {
        this . indexer = indexer ;
    }

    @ RequestMapping ( value = "/start_all" , method = RequestMethod . POST )
    public void startAll () {
        indexer . startAll ();
    }

    @ RequestMapping ( value = "/start/{entityClassName:.+}" , method = RequestMethod . POST )
    public void start ( @ PathVariable ( "entityClassName" ) String entityClassName ) {
        indexer . start ( entityClassName );
    }

    @ RequestMapping ( value = "/stop_all" , method = RequestMethod . PUT )
    public Map < String , Boolean > stopAll () {
        return indexer . stopAll ();
    }

    @ RequestMapping ( value = "/stop/{entityClassName:.+}" , method = RequestMethod . PUT )
    public Boolean stop ( @ PathVariable ( "entityClassName" ) String entityClassName ) {
        return indexer . stop ( entityClassName );
    }

    @ RequestMapping ( value = "/progress" , method = RequestMethod . GET )
    public Map < String , IndexProgress > getProgress () {
        return indexer . getProgress ();
    }

}

快速開始

索引API

使用com.timeyang.jkes.core.annotation包下相關註解標記實體

 @ lombok . Data
@ Entity
@ Document
public class Person extends AuditedEntity {

    // @Id will be identified automatically
    // @Field(type = FieldType.Long)
    @ Id
    @ GeneratedValue ( strategy = GenerationType . IDENTITY )
    private Long id ;

    @ MultiFields (
            mainField = @ Field ( type = FieldType . Text ),
            otherFields = {
                    @ InnerField ( suffix = "raw" , type = FieldType . Keyword ),
                    @ InnerField ( suffix = "english" , type = FieldType . Text , analyzer = "english" )
            }
    )
    private String name ;

    @ Field ( type = FieldType . Keyword )
    private String gender ;

    @ Field ( type = FieldType . Integer )
    private Integer age ;

    // don't add @Field to test whether ignored
    // @Field(type = FieldType.Text)
    private String description ;

    @ Field ( type = FieldType . Object )
    @ ManyToOne ( fetch = FetchType . EAGER )
    @ JoinColumn ( name = "group_id" )
    private PersonGroup personGroup ;

}

 @ lombok . Data
@ Entity
@ Document ( type = "person_group" , alias = "person_group_alias" )
public class PersonGroup extends AuditedEntity {
    @ Id
    @ GeneratedValue ( strategy = GenerationType . IDENTITY )
    private Long id ;
    private String name ;
    private String interests ;
    @ OneToMany ( fetch = FetchType . EAGER , cascade = CascadeType . ALL , mappedBy = "personGroup" , orphanRemoval = true )
    private List < Person > persons ;
    private String description ;

    @ DocumentId
    @ Field ( type = FieldType . Long )
    public Long getId () {
        return id ;
    }

    @ MultiFields (
            mainField = @ Field ( type = FieldType . Text ),
            otherFields = {
                    @ InnerField ( suffix = "raw" , type = FieldType . Keyword ),
                    @ InnerField ( suffix = "english" , type = FieldType . Text , analyzer = "english" )
            }
    )
    public String getName () {
        return name ;
    }

    @ Field ( type = FieldType . Text )
    public String getInterests () {
        return interests ;
    }

    @ Field ( type = FieldType . Nested )
    public List < Person > getPersons () {
        return persons ;
    }

    /**
     * 不加Field注解，测试序列化时是否忽略
     */
    public String getDescription () {
        return description ;
    }
}

當更新實體時，文件會被自動索引到ElasticSearch；刪除實體時，文件會自動從ElasticSearch刪除。

搜尋API

啟動搜尋服務jkes-search-service，搜尋服務是一個Spring Boot Application，提供rest搜尋api，預設運行在9000連接埠。

URI query

 curl -XPOST localhost:9000/api/v1/integration_test_person_group/person_group/_search?from=3&size=10

Nested query

 integration_test_person_group/person_group/_search?from=0&size=10
{
  "query": {
    "nested": {
      "path": "persons",
      "score_mode": "avg",
      "query": {
        "bool": {
          "must": [
            {
              "range": {
                "persons.age": {
                  "gt": 5
                }
              }
            }
          ]
        }
      }
    }
  }
}

match query

 integration_test_person_group/person_group/_search?from=0&size=10
{
  "query": {
      "match": {
        "interests": "Hadoop"
      }
    }
}

bool query

 {
  "query": {
    "bool" : {
      "must" : {
        "match" : { "interests" : "Hadoop" }
      },
      "filter": {
        "term" : { "name.raw" : "name0" }
      },
      "should" : [
        { "match" : { "interests" : "Flink" } },
        {
            "nested" : {
                "path" : "persons",
                "score_mode" : "avg",

                "query" : {
                    "bool" : {
                        "must" : [
                        { "match" : {"persons.name" : "name40"} },
                        { "match" : {"persons.interests" : "interests"} }
                        ],
                        "must_not" : {
                            "range" : {
                              "age" : { "gte" : 50, "lte" : 60 }
                            }
                          }
                    }
                }
            }
        }

      ],
      "minimum_should_match" : 1,
      "boost" : 1.0
    }

  }

}

Source filtering

 integration_test_person_group/person_group/_search
{
    "_source": false,
    "query" : {
        "match" : { "name" : "name17" }
    }
}

 integration_test_person_group/person_group/_search
{
    "_source": {
            "includes": [ "name", "persons.*" ],
            "excludes": [ "date*", "version", "persons.age" ]
        },
    "query" : {
        "match" : { "name" : "name17" }
    }
}

prefix

 integration_test_person_group/person_group/_search
{ 
  "query": {
    "prefix" : { "name" : "name" }
  }
}

wildcard

 integration_test_person_group/person_group/_search
{
    "query": {
        "wildcard" : { "name" : "name*" }
    }
}

regexp

 integration_test_person_group/person_group/_search
{
    "query": {
        "regexp":{
            "name": "na.*17"
        }
    }
}

Jkes工作原理

索引工作原理：

應用啟動時，Jkes掃描所有標註@Document註解的實體，為它們建立元資料。
基於建構的元數據，建立index和mapping Json格式的配置，然後透過ElasticSearch Java Rest Client將建立/更新index配置。
為每個文檔建立/更新Kafka ElasticSearch Connector ，用於建立/更新文檔
為整個專案啟動/更新Jkes Deleter Connector ，用於刪除文檔
攔截資料操作方法。將* save(*)方法傳回的資料包裝為SaveEvent儲存到EventContainer ；使用(* delete*(..)方法的參數，產生一個DeleteEvent/DeleteAllEvent儲存到EventContainer 。
攔截事務。在交易提交後使用JkesKafkaProducer發送SaveEvent中的實體到Kafka，Kafka會使用我們提供的JkesJsonSerializer序列化指定的數據，然後發送到Kafka。
與SaveEvent不同， DeleteEvent會直接被序列化，然後傳送到Kafka，而不是只傳送一份數據
與SaveEvent和DeleteEvent不同， DeleteAllEvent不會傳送資料到Kafka，而是直接透過ElasticSearch Java Rest Client刪除對應的index ，然後重建索引，重新啟動Kafka ElasticSearch Connector

查詢工作原理：

查詢服務透過rest api提供
我們沒有直接使用ElasticSearch進行查詢，因為我們需要在後續版本使用機器學習進行搜尋排序，而直接與ElasticSearch進行耦合，會增加搜尋排序API的存取難度
查詢服務是一個Spring Boot Application，使用docker打包為映像
查詢服務提供多版本API，用於API演化和相容
查詢服務解析json請求，進行一些預處理後，使用ElasticSearch Java Rest Client轉送至ElasticSearch，將得到的回應進行解析，進一步處理後回到客戶端。
為了方便客戶端人員開發，查詢服務提供了一個查詢UI介面，開發人員可以在這個頁面得到預期結果後再把json請求體複製到程式中。

流程圖

模組介紹

jkes-core

jkes-core是整個jkes的核心部分。主要包括以下功能：

annotation包提供了jkes的核心註解
elasticsearch套件封裝了elasticsearch相關的操作，如為所有的文件建立/更新索引，更新mapping
kafka套件提供了Kafka 生產者，Kafka Json Serializer，Kafka Connect Client
metadata套件提供了核心的註解元資料的建構與結構化模型
event包提供了事件模型與容器
exception套件提供了常見的Jkes異常
http套件基於Apache Http Client封裝了常見的http json請求
support包暴露了Jkes核心配置支持
util套件提供了一些工具類，方便開發。如：Asserts, ClassUtils, DocumentUtils, IOUtils, JsonUtils, ReflectionUtils, StringUtils

jkes-boot

jkes-boot用於與一些第三方開源框架進行整合。

目前，我們透過jkes-spring-data-jpa ，提供了與spring data jpa的整合。透過使用Spring的AOP機制，對Repository方法進行攔截，產生SaveEvent/DeleteEvent/DeleteAllEvent儲存到EventContainer 。透過使用我們提供的SearchPlatformTransactionManager ，對常用的事務管理器(如JpaTransactionManager )進行包裝，提供事務攔截功能。

在後續版本，我們會提供與更多框架的整合。

jkes-spring-data-jpa說明：

ContextSupport類別用於從bean工廠取得Repository Bean
@EnableJkes讓客戶端能夠輕鬆開啟Jkes的功能，提供了與Spring一致的配置模型
EventSupport處理事件的細節，在儲存和刪除資料時產生對應事件存放到EventContainer ，在交易提交和回滾時處理對應的事件
SearchPlatformTransactionManager包裝了客戶端的事務管理器，在事務提交和回滾時加入了回调hook
audit套件提供了一個簡單的AuditedEntity父類，方便添加審計功能，版本資訊可用於結合ElasticSearch的版本機制保證不會索引過期文檔數據
exception封裝了常見異常
intercept包提供了AOP切點和切面
index包提供了全量索引功能。目前，我們提供了基於线程池的索引機制和基於ForkJoin的索引機制。在後續版本，我們會重構程式碼，增加基於阻塞队列的生产者-消费者模式，提供並發效能

jkes-services

jkes-services主要用來提供一些服務。目前， jkes-services提供了以下服務：

jkes-delete-connector
- jkes-delete-connector是一個Kafka Connector ，用於從kafka叢集取得索引刪除事件( DeleteEvent )，然後使用Jest Client刪除ElasticSearch中對應的文件。
- 借助於Kafka Connect的rest admin api，我們輕鬆實現了多租戶平台上的文件刪除功能。只要為每個專案啟動一個jkes-delete-connector ，就可以自動處理該專案的文件刪除工作。避免了每啟動一個新的項目，我們都得手動啟動一個Kafka Consumer來處理該項目的文檔刪除工作。儘管可以透過正規訂閱來減少這樣的工作，但還是非常不靈活
jkes-search-service
- jkes-search-service是一個restful的搜尋服務，提供了多版本的rest query api。查詢服務提供多版本API，用於API演化和相容
- jkes-search-service目前支援URI風格的搜尋和JSON請求體風格的搜尋。
- 我們沒有直接使用ElasticSearch進行查詢，因為我們需要在後續版本使用機器學習進行搜尋排序，而直接與ElasticSearch進行耦合，會增加搜尋排序的存取難度
- 查詢服務是一個Spring Boot Application，使用docker打包為映像
- 查詢服務解析json請求，進行一些預處理後，使用ElasticSearch Java Rest Client轉送至ElasticSearch，將得到的回應進行解析，進一步處理後回到客戶端。
- 為了方便客戶端人員開發，查詢服務提供了一個查詢UI介面，開發人員可以在這個頁面得到預期結果後再把json請求體複製到程式中。