Haystack爲Django提供了模塊化的搜索。它的特色是統一的，熟悉的API，可讓你在不修改代碼的狀況下使用不一樣的搜索後端（好比 Solr, Elasticsearch, Whoosh, Xapian 等等）。html
環境:django ==1.11.11python
1.首先安裝相關的依賴包:(這裏原做者使用的是drf-haystack,若是項目沒有使用drf組件,應該選用haystack包)數據庫
pip install drf-haystack pip install elasticsearch==2.4.1
# drf-haystack官方文檔:https://drf-haystack.readthedocs.io/en/latest/django
2.在django項目配置文件settings.py中註冊應用:後端
INSTALLED_APPS = [ ... 'haystack', ... ]
3.在django項目配置文件settings.py中指定搜索的後端:(指定使用那個搜索引擎,服務器地址的配置,索引庫的名稱等配置)api
# Haystack HAYSTACK_CONNECTIONS = { 'default': { 'ENGINE': 'haystack.backends.elasticsearch_backend.ElasticsearchSearchEngine', # 指定使用 elasticsearch 爲搜索引擎, 若是搜索內容包含中文, 須要將 elasticsearch 配置支持中文分詞 'URL': 'http://your_ip:9200/', # 此處爲elasticsearch運行的服務器ip地址，端口號默認爲9200
# elasticsearch創建的索引庫的名稱
'INDEX_NAME': 'demo',
# 保存索引文件的路徑
# 'PATH': os.path.join(BASE_DIR, 'elastic_index'), # 若是搜索引擎是whoosh, 還須要設置PATH參數
},
}
# 當添加、修改、刪除數據時，自動生成索引
HAYSTACK_SIGNAL_PROCESSOR = 'haystack.signals.RealtimeSignalProcessor'
# 指定搜索結果每頁的條數 這裏設置成了1條
HAYSTACK_SEARCH_RESULTS_PER_PAGE = 1服務器
注意：框架
HAYSTACK_SIGNAL_PROCESSOR 的配置保證了在Django運行起來後，有新的數據產生時，haystack仍然可讓Elasticsearch實時生成新數據的索引elasticsearch
4.建立索引類:(在須要進行索引的應用的目錄下建立文件search_indexes.py, 在該文件內建立該索引類,轉載者注模塊化
from haystack import indexes
from .models import Demo
# 原做者在代碼中沒有給出模型代碼,這個模型裏擁有的字段就是須要提供搜索的字段,建議保留模型字段中自增的主鍵字段id, 在我實際項目開發中發現若是不保留就沒法實現搜索 # 索引模型類的名稱必須是 模型類名稱 + Index class DemoIndex(indexes.SearchIndex, indexes.Indexable): """ 索引數據模型類 """ text = indexes.CharField(document=True, use_template=True) # 通常此字段約定爲text
default_image_url = indexes.CharField(model_attr='default_image_url') def get_model(self): """返回創建索引的模型類""" return Demomodel def index_queryset(self, using=None): """返回要創建索引的數據查詢集""" return self.get_model().objects.filter(is_launched=True) """ 說明: 1.在DemoIndex創建的字段，均可以藉助haystack由elasticsearch搜索引擎查詢。 2.其中text字段聲明爲document=True，表名該字段是主要進行關鍵字查詢的字段， 該字段的索引值能夠由多個數據庫模型類字段組成(是多個字段,不是多個數據庫模型類,轉者注)，具體由哪些模型類字段組成，咱們用use_template=True表示後續經過模板來指明,其餘字段都是經過model_attr選項指明引用數據庫模型類的特定字段。 3.在 REST framework中，索引類的字段會做爲查詢結果返回數據的來源, """
5. 在templates目錄中建立text字段使用的模板文件:
templates/search/indexes/demo/demo_text.txt文件中定義
(關於路徑的定義和文件的命名的說明:templates是項目原來的html文件的目錄,search是在其下新建的,名稱必定,indexes名稱也必定,demo是應用的名稱,demo_text.txt 就是須要進行索引的模型類名的小寫 + "_" + 索引類中定義的字段名稱(text) + ".txt" 轉載者注)
在demo_text.txt文件中 指定爲模型類中那些字段創建索引
{{ object.name }} {{ object.id }}
而後使用命令手動建立索引:
進入manage.py所在的目錄執行命令:
python manage.py rebuild_index
6.建立haystack序列化器:(返回查詢到的查詢集數據)
from drf_haystack.serializers import HaystackSerializer class DemoSerializer(serializers.ModelSerializer): """ 序列化器 """ class Meta: model = Demo
# 返回除了搜索字段外的所須要的其餘字段數據, 能夠將全部須要返回的字段數據寫上,便於提取 fields = ('id', 'name') class DemoIndexSerializer(HaystackSerializer): """ SKU索引結果數據序列化器 """
# 變量名稱必須爲 object 不然沒法返回 object = DemoSerializer(read_only=True)# 只讀,不能夠進行反序列化 class Meta: index_classes = [DemoIndex] # 索引類的名稱,能夠有多個
# text 由索引類進行返回, object 由序列化類進行返回,第一個參數必須是text
fields = ('text', object, 'default_image_url')
注意:fields屬性的字段名與DemoIndex類的字段對應。
7.建立視圖
from drf_haystack.viewsets import HaystackViewSet class DemoSearchViewSet(HaystackViewSet):
index_models = [Demo]#這裏能夠寫入多個已經進行了索引的模型類
serializer_class = DemoIndexSerializer
# 這裏是經過父類默認的方法進行返回了數據, 能夠在視圖中對數據進行篩選和處理,詳細的使用方法能夠去查看官方文檔,drf-haystack官方文檔:https://drf-haystack.readthedocs.io/en/latest/
- 該視圖會返回搜索結果的列表數據，因此若是能夠爲視圖增長REST framework的分頁功能。
- 咱們在配置文件已經定義了分頁配置，因此此搜索視圖會進行分頁。
8. 添加路由,使用經過REST framework的router來定義路由
router = DefaultRouter() router.register('/', views.DemoSearchViewSet, base_name='demo_search') ... urlpatterns += router.urls
9.測試
http://127.0.0.1:8000/?text=something
若是在配置完haystack並啓動程序後，出現以下異常，是由於drf-haystack尚未適配最新版本的REST framework框架
