django 對接elasticsearch實現全文檢索

本文demo代碼請加群獲取

第一步：安裝elasticsearch環境（docker安裝）

拉取鏡像

docker image pull delron/elasticsearch-ik:2.4.6-1.0

運行容器

docker run -d -p 9200:9200 -p 9300:9300 --name search delron/elasticsearch-ik:2.4.6-1.0

第二步：首先安裝相關的依賴包

pip3 install drf-haystack 
pip3 install elasticsearch
pip3 install djangorestframework

第三步：在django項目配置文件settings.py中注冊應用

INSTALLED_APPS = [
    ...
    'app01.apps.App01Config',        
    'haystack',
    'rest_framework'
]

第四步：在django項目配置文件settings.py中指定搜索的后端

HAYSTACK_CONNECTIONS = {
    'default': {
        'ENGINE': 'haystack.backends.elasticsearch_backend.ElasticsearchSearchEngine',
        'URL': 'http://172.16.209.100:9200/',  # 此處為elasticsearch運行的服務器ip地址，端口號固定為9200
        'INDEX_NAME': 'test',  # 指定elasticsearch建立的索引庫的名稱
    },
}

# 當添加、修改、刪除數據時，自動生成索引
HAYSTACK_SIGNAL_PROCESSOR = 'haystack.signals.RealtimeSignalProcessor'
 # 指定搜索結果每頁的條數
 # HAYSTACK_SEARCH_RESULTS_PER_PAGE = 1

第五步：創建索引類

在此之前要先創建model類，並插入數據

from django.db import models
class Book(models.Model):
    nid=models.AutoField(primary_key=True)
    name=models.CharField(max_length=32)
    publish=models.CharField(max_length=32)
    price=models.DecimalField(max_digits=5,decimal_places=2)
#插入多條數據

在需要進行索引的應用的目錄下創建文件search_indexes.py, 在該文件內創建該索引類

我在app01應用下創建：search_indexes.py

# 索引模型類的名稱必須是 模型類名稱 + Index
from haystack import indexes
from .models import Book
class BookIndex(indexes.SearchIndex, indexes.Indexable):
    text = indexes.CharField(document=True, use_template=True)
    def get_model(self):
        """返回建立索引的模型類"""
        return Book
    def index_queryset(self, using=None):
        """返回要建立索引的數據查詢集"""
        return self.get_model().objects.all()
"""
說明: 
1.在BookIndex建立的字段，都可以借助haystack由elasticsearch搜索引擎查詢。
2.其中text字段聲明為document=True，表名該字段是主要進行關鍵字查詢的字段， 該字段的索引值可以由多個數據庫模型類字段組成(是多個字段,不是多個數據庫模型類,轉者注)，具體由哪些模型類字段組成，我們用use_template=True表示后續通過模板來指明。
3.在 REST framework中，索引類的字段會作為查詢結果返回數據的來源, 
"""

第六步：在templates目錄中創建text字段使用的模板文件

創建文件templates/search/indexes/app01/book_text.txt文件中定義

{{ object.name }}
{{ object.publish }}

第七步：手動更新索引

python manage.py rebuild_index   #數據庫有多少條數據，全部會被同步到es中

第八步：創建haystack序列化器

from drf_haystack.serializers import HaystackSerializer
from rest_framework.serializers import ModelSerializer

from app01 import models

from app01.search_indexes import BookIndex
class BookSerializer(ModelSerializer):
    class Meta:
        model=models.Book
        fields='__all__'
class BookIndexSerializer(HaystackSerializer):
    object = BookSerializer(read_only=True) # 只讀,不可以進行反序列化

    class Meta:
        index_classes = [BookIndex]# 索引類的名稱
        fields = ('text', 'object')# text 由索引類進行返回, object 由序列化類進行返回,第一個參數必須是text

第九步：創建視圖類

from drf_haystack.viewsets import HaystackViewSet
from app01.models import Book
from app01.serializers import BookIndexSerializer
class BookSearchView(HaystackViewSet):
    index_models = [Book]

    serializer_class = BookIndexSerializer
#該視圖會返回搜索結果的列表數據，所以如果可以為視圖增加REST framework的分頁功能。
#我們在配置文件已經定義了分頁配置，所以此搜索視圖會進行分頁

第十步：添加路由

from django.conf.urls import url
from django.contrib import admin
from rest_framework import routers

from app01.views import BookSearchView
router = routers.DefaultRouter()
router.register("book/search", BookSearchView, base_name="book-search")
urlpatterns = [
    url(r'^admin/', admin.site.urls),
]

urlpatterns += router.urls

第十一步：測試

http://127.0.0.1:8000/?text=北  #查詢出名字中和出版社中有北的數據