Django rest framework 使用haystack對接Elasticsearch

Elasticsearch 介紹

ElasticSearch是一個基於Lucene的搜索服務器。它提供了一個分布式多用戶能力的全文搜索引擎，基於RESTful web接口。Elasticsearch是用Java開發的，並作為Apache許可條款下的開放源碼發布，是當前流行的企業級搜索引擎。設計用於雲計算中，能夠達到實時搜索，穩定，可靠，快速，安裝使用方便。

首先安裝 java 環境

https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html

　　

配置java環境變量

(1)新建->變量名"JAVA_HOME"，變量值"C:\Java\jdk1.8.0_05"（即JDK的安裝路徑） 
(2)編輯->變量名"Path"，在原變量值的最后面加上“;%JAVA_HOME%\bin;%JAVA_HOME%\jre\bin” 
(3)新建->變量名“CLASSPATH”,變量值“.;%JAVA_HOME%\lib;%JAVA_HOME%\lib\dt.jar;%JAVA_HOME%\lib\tools.jar”

 下載  elasticsearch-rtf

https://github.com/medcl/elasticsearch-rtf

 啟動 elasticsearch

 進入bin 下執行

elasticsearch.bat

drf中使用

Haystack為Django提供了模塊化的搜索。它的特點是統一的，熟悉的API，可以讓你在不修改代碼的情況下使用不同的搜索后端（比如 Solr, Elasticsearch, Whoosh, Xapian 等等）。

我們在django中可以通過使用haystack來調用Elasticsearch搜索引擎。

drf-haystack官方文檔: https://drf-haystack.readthedocs.io/en/latest/

環境:django ==1.11.11

1.首先安裝相關的依賴包:(這里原作者使用的是drf-haystack,如果項目沒有使用drf組件,應該選用haystack包)

pip install drf-haystack 
pip install elasticsearch==2.4.1

 

2.在django項目配置文件settings.py中注冊應用:　　

INSTALLED_APPS = [
    ...
    'haystack',
    ...
]

 

3.在django項目配置文件settings.py中指定搜索的后端:(指定使用那個搜索引擎,服務器地址的配置,索引庫的名稱等配置)　　

# Haystack
HAYSTACK_CONNECTIONS = {
    'default': {
        'ENGINE': 'haystack.backends.elasticsearch_backend.ElasticsearchSearchEngine',
        # 端口號固定為9200
        'URL': 'http://192.168.247.128:9200/', # 此處為elasticsearch運行的服務器ip地址，端口號固定為9200
        # 指定elasticsearch建立的索引庫的名稱
        'INDEX_NAME': 'meiduo_mall',
        # 保存索引文件的路徑
        # 'PATH': os.path.join(BASE_DIR, 'elastic_index'), # 如果搜索引擎是whoosh, 還需要設置PATH參數
    },
}　　
# 當添加、修改、刪除數據時，自動生成索引
HAYSTACK_SIGNAL_PROCESSOR = 'haystack.signals.RealtimeSignalProcessor'

　　

注意：

HAYSTACK_SIGNAL_PROCESSOR 的配置保證了在Django運行起來后，有新的數據產生時，haystack仍然可以讓Elasticsearch實時生成新數據的索引

4 創建索引類　　

通過創建索引類，來指明讓搜索引擎對哪些字段建立索引，也就是可以通過哪些字段的關鍵字來檢索數據。

在goods應用目錄下新建一個search_indexes.py(固定的)文件，用於存放索引類。search_indexes.py 這個文件名是固定的，你需要對那個應用進行檢索，就在那個應用下創建

代碼如下

from haystack import indexes

from .models import goods


class SKUIndex(indexes.SearchIndex, indexes.Indexable):
    """
    索引類， 告訴haystack在建立數據索引的時候使用
    """
    text = indexes.CharField(document=True, use_template=True)

    def get_model(self):
        """把那個表建立索引"""
        return goods

    def index_queryset(self, using=None):
        """返回要建立索引的數據查詢集"""
        return self.get_model().objects.filter()

說明：

在SKUIndex建立的字段，都可以借助haystack由elasticsearch搜索引擎查

其中text字段我們聲明為document=True，表名該字段是主要進行關鍵字查詢的字段， 該字段的索引值可以由多個數據庫模型類字段組成，具體由哪些模型類字段組成，我們用use_template=True表示后續通過模板來

指明。其他字段都是通過model_attr選項指明引用數據庫模型類的特定字段。

在REST framework中，索引類的字段會作為查詢結果返回數據的來源。

5 在templates下面新建目錄search/indexes/goods/goodssku_text.txt

 goods是和應用的名字對應上，而goodssku是和get_model中對象的名字（小寫）對應上的

(關於路徑的定義和文件的命名的說明:templates是項目原來的html文件的目錄,search是在其下新建的,名稱一定,indexes名稱也一定,goods是應用的名稱,goodssku_text.txt 就是需要進行索引的模型類名的小寫 + "_" + 索引類中定義的字段名稱(text) + ".txt" )

 具體在templates/search/indexes/goods/goods_text.txt文件中定義

{{ object.name }}
{{ object.caption }}
{{ object.id }}

此模板指明當將關鍵詞通過text參數名傳遞時，可以通過sku的name、caption、id來進行關鍵字索引查詢。

 

6 手動生成初始索引　　

python manage.py rebuild_index

 

7.創建haystack序列化器:(返回查詢到的查詢集數據)

goods/serializers.py

from rest_framework import serializers
from .models import SKU


class SKUSerializer(serializers.ModelSerializer):
    """
    SKU序列化器
    """

    class Meta:
        model = SKU
        fields = ('id', 'name', 'price', 'default_image_url', 'comments')

from drf_haystack.serializers import HaystackSerializer
from .search_indexes import SKUIndex

class SKUIndexSerializer(HaystackSerializer):
    """
    SKU索引結果數據序列化器
    """
    object = SKUSerializer(read_only=True)

    class Meta:
        index_classes = [SKUIndex]
        # text 由索引類進行返回, object 由序列化類進行返回,第一個參數必須是text
        fields = (
            'text',  # 用於接收查詢關鍵字
            'object',  # 用於返回查詢結果
            'id',
            'name',
            'price'
        )

 注意:fields屬性的字段名與DemoIndex類的字段對應。

 

8  創建視圖

 goods/views.py

from drf_haystack.viewsets import HaystackViewSet
from .serializers import SKUIndexSerializer
from .models import SKU

class SKUSearchViewSet(HaystackViewSet):
    """
    SKU搜索
    """
    index_models = [SKU]

    serializer_class = SKUIndexSerializer

 

 

這里是通過父類默認的方法進行返回了數據, 可以在視圖中對數據進行篩選和處理,詳細的使用方法可以去查看官方文檔,drf-haystack官方文檔:https://drf-haystack.readthedocs.io/en/latest/

注意：

• 該視圖會返回搜索結果的列表數據，所以如果可以為視圖增加REST framework的分頁功能。
• 我們在實現商品列表頁面時已經定義了全局的分頁配置，所以此搜索視圖會使用全局的分頁配置。

 

9 定義路由

通過REST framework的router來定義路由

router = DefaultRouter()
router.register('skus/search', views.SKUSearchViewSet, base_name='skus_search')
 
...
 
urlpatterns += router.urls

 

10 測試　　

http://api.meiduo.site:8000/skus/search/?text=wifi

http://api.meiduo.site:8000/skus/search/?id=1

http://api.meiduo.site:8000/skus/search/?name=iphone

 

如果在配置完haystack並啟動程序后，出現如下異常，是因為drf-haystack還沒有適配最新版本的REST framework框架

 

 

可以通過修改REST framework框架代碼，補充_get_count函數定義即可

文件路徑 虛擬環境下的 lib/python3.6/site-packages/rest_framework/pagination.py

def _get_count(queryset):
    """
    Determine an object count, supporting either querysets or regular lists.
    """
    try:
        return queryset.count()
    except (AttributeError, TypeError):
        return len(queryset)

 

再次測試　　

 返回的數據舉例如下：

{
    "count": 10,
    "next": "http://api.meiduo.site:8000/skus/search/?page=2&text=%E5%8D%8E",
    "previous": null,
    "results": [
        {
            "text": "華為 HUAWEI P10 Plus 6GB+64GB 鑽雕金 移動聯通電信4G手機 雙卡雙待\nwifi雙天線設計！徠卡人像攝影！P10徠卡雙攝拍照，低至2988元！\n9",
            "id": 9,
            "name": "華為 HUAWEI P10 Plus 6GB+64GB 鑽雕金 移動聯通電信4G手機 雙卡雙待",
            "price": "3388.00",
            "default_image_url": "http://10.211.55.5:8888/group1/M00/00/02/CtM3BVrRcUeAHp9pAARfIK95am88523545",
            "comments": 0
        },
        {
            "text": "華為 HUAWEI P10 Plus 6GB+128GB 鑽雕金 移動聯通電信4G手機 雙卡雙待\nwifi雙天線設計！徠卡人像攝影！P10徠卡雙攝拍照，低至2988元！\n10",
            "id": 10,
            "name": "華為 HUAWEI P10 Plus 6GB+128GB 鑽雕金 移動聯通電信4G手機 雙卡雙待",
            "price": "3788.00",
            "default_image_url": "http://10.211.55.5:8888/group1/M00/00/02/CtM3BVrRchWAMc8rAARfIK95am88158618",
            "comments": 5
        }
    ]
}