Haystack

1.什麼是Haystack

　　Haystack是django的開源全文搜索框架(全文檢索不一樣於特定字段的模糊查詢，使用全文檢索的效率更高 )，該框架支持Solr,Elasticsearch,Whoosh, **Xapian搜索引擎它是一個可插拔的後端（很像Django的數據庫層），因此幾乎你全部寫的代碼均可以在不一樣搜索引擎之間便捷切換html

全文檢索不一樣於特定字段的模糊查詢，使用全文檢索的效率更高，而且可以對於中文進行分詞處理python
haystack：django的一個包，能夠方便地對model裏面的內容進行索引、搜索，設計爲支持whoosh,solr,Xapian,Elasticsearc四種全文檢索引擎後端，屬於一種全文檢索的框架git
whoosh：純Python編寫的全文搜索引擎，雖然性能比不上sphinx、xapian、Elasticsearc等，可是無二進制包，程序不會莫名其妙的崩潰，對於小型的站點，whoosh已經足夠使用github
jieba：一款免費的中文分詞包，若是以爲很差用可使用一些收費產品sql
搜索引擎就比如一個數據庫，搜索引擎將mgsql中的數據複製一份到搜索引擎。查詢的時候直接經過搜索引擎來快速查詢數據的結果。

2.安裝

pip install django-haystack
pip install whoosh
pip install jieba

3.配置

1 添加Haystack到INSTALLED_APPS數據庫

　　跟大多數Django的應用同樣，你應該在你的設置文件(一般是settings.py)添加Haystack到INSTALLED_APPS. 示例： django

INSTALLED_APPS = [ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.sites',  # 添加
    'haystack',  # 你的app
    'blog', ]

2 修改settings.pyjson

　　在你的settings.py中，你須要添加一個設置來指示站點配置文件正在使用的後端，以及其它的後端設置。 HAYSTACK——CONNECTIONS是必需的設置，而且應該至少是如下的一種：後端

Solr示例

HAYSTACK_CONNECTIONS = { 'default': { 'ENGINE': 'haystack.backends.solr_backend.SolrEngine', 'URL': 'http://127.0.0.1:8983/solr'
        # ...or for multicore...
        # 'URL': 'http://127.0.0.1:8983/solr/mysite',
 }, }

Elasticsearch示例

HAYSTACK_CONNECTIONS = { 'default': { 'ENGINE': 'haystack.backends.elasticsearch_backend.ElasticsearchSearchEngine', 'URL': 'http://127.0.0.1:9200/', 'INDEX_NAME': 'haystack', }, }

Whoosh示例

#須要設置PATH到你的Whoosh索引的文件系統位置

import os HAYSTACK_CONNECTIONS = { 'default': { 'ENGINE': 'haystack.backends.whoosh_backend.WhooshEngine', 'PATH': os.path.join(os.path.dirname(__file__), 'whoosh_index'), }, }

# 自動更新索引
HAYSTACK_SIGNAL_PROCESSOR = 'haystack.signals.RealtimeSignalProcessor'

Xapian示例

#首先安裝Xapian後端（http://github.com/notanumber/xapian-haystack/tree/master）
#須要設置PATH到你的Xapian索引的文件系統位置。

import os HAYSTACK_CONNECTIONS = { 'default': { 'ENGINE': 'xapian_backend.XapianEngine', 'PATH': os.path.join(os.path.dirname(__file__), 'xapian_index'), }, }

4.處理數據

建立索引

若是你想針對某個app例如blog作全文檢索，則必須在blog的目錄下面創建search_indexes.py文件，文件名不能修改 api

from haystack import indexes from app01.models import Article  class ArticleIndex(indexes.SearchIndex, indexes.Indexable): #類名必須爲須要檢索的Model_name+Index，這裏須要檢索Article，因此建立ArticleIndex
    text = indexes.CharField(document=True, use_template=True)#建立一個text字段 
    #其它字段
    desc = indexes.CharField(model_attr='desc') content = indexes.CharField(model_attr='content')  def get_model(self):#重載get_model方法，必需要有！
        return Article  def index_queryset(self, using=None): return self.get_model().objects.all()

　　爲何要建立索引？索引就像是一本書的目錄，能夠爲讀者提供更快速的導航與查找。在這裏也是一樣的道理，當數據量很是大的時候，若要從這些數據裏找出全部的知足搜索條件的幾乎是不太可能的，將會給服務器帶來極大的負擔。因此咱們須要爲指定的數據添加一個索引（目錄），在這裏是爲Note建立一個索引，索引的實現細節是咱們不須要關心的，至於爲它的哪些字段建立索引，怎麼指定 ,下面開始講解每一個索引裏面必須有且只能有一個字段爲 document=True，這表明haystack 和搜索引擎將使用此字段的內容做爲索引進行檢索(primary field)。其餘的字段只是附屬的屬性，方便調用，並不做爲檢索數據

注意：若是使用一個字段設置了document=True，則通常約定此字段名爲text，這是在ArticleIndex類裏面一向的命名，以防止後臺混亂，固然名字你也能夠隨便改，不過不建議改。另外，咱們在字段上提供了。這容許咱們使用一個數據模板（而不是容易出錯的級聯）來構建文檔搜索引擎索引。你應該在模板目錄下創建新的模板，並將下面內容放在裏面。 textuse_template=Truesearch/indexes/blog/article_text.txt

#在目錄「templates/search/indexes/應用名稱/」下建立「模型類名稱_text.txt」文件

{{ object.title }} {{ object.desc }} {{ object.content }}

這個數據模板的做用是對Note.title, Note.user.get_full_name,Note.body這三個字段創建索引，當檢索的時候會對這三個字段作全文檢索匹配

5.設置視圖

添加`SearchView`到你的`URLconf`

在你的URLconf中添加下面一行：

先後端不分離url
url(r'^search/', include('haystack.urls')),

先後端分離url
path('search/', MySearchView(), name='haystack_search'),

這會拉取Haystack的默認URLconf，它由單獨指向SearchView實例的URLconf組成。你能夠經過傳遞幾個關鍵參數或者徹底從新它來改變這個類的行爲。

先後端分離後臺重寫create_response方法，

from haystack.views import SearchView class MySearchView(SearchView):

    def create_response(self): context = super().get_context() keyword = self.request.GET.get('q', None)  # 關鍵字爲q
        if not keyword: return JsonResponse({'message': '沒有相關信息'}) else: data_list = [{'id': i.object.id, 'name': i.object.name, 'model_img': 'http://api.modelbox.cn:8000/media/' + str(i.object.model_img), 'download_num': i.object.download_num, 'collect_num': i.object.download_num} for i in context['page'].object_list] return JsonResponse(data_list, safe=False, json_dumps_params={'ensure_ascii': False})

搜索模板

你的搜索模板(默認在search/search.html)將可能很是簡單。下面的足夠讓你的搜索運行(你的template/block應該會不一樣)

<!DOCTYPE html>
<html>
<head>
    <title></title>
    <style> span.highlighted { color: red; } </style>
</head>
<body> {% load highlight %} {% if query %} <h3>搜索結果以下：</h3> {% for result in page.object_list %} {# <a href="/{{ result.object.id }}/">{{ result.object.title }}</a><br/>#}
        <a href="/{{ result.object.id }}/">{%   highlight result.object.title with query max_length 2%}</a><br/>
        <p>{{ result.object.content|safe }}</p>
        <p>{% highlight result.content with query %}</p> {% empty %} <p>啥也沒找到</p> {% endfor %} {% if page.has_previous or page.has_next %} <div> {% if page.has_previous %} <a href="?q={{ query }}&amp;page={{ page.previous_page_number }}">{% endif %}&laquo; 上一頁 {% if page.has_previous %}</a>{% endif %} | {% if page.has_next %}<a href="?q={{ query }}&amp;page={{ page.next_page_number }}">{% endif %}下一頁 &raquo; {% if page.has_next %}</a>{% endif %} </div> {% endif %} {% endif %} </body>
</html>

須要注意的是page.object_list其實是SearchResult對象的列表。這些對象返回索引的全部數據。它們能夠經過{{result.object}}來訪問。因此{{ result.object.title}}實際使用的是數據庫中Article對象來訪問title字段的。

重建索引

如今你已經配置好了全部的事情，是時候把數據庫中的數據放入索引了。Haystack附帶的一個命令行管理工具使它變得很容易。

簡單的運行python ./manage.py rebuild_index。你會獲得有多少模型進行了處理並放進索引的統計。

6.使用jieba分詞

#創建ChineseAnalyzer.py文件
#保存在haystack的安裝文件夾下，路徑如「D:\python3\Lib\site-packages\haystack\backends」

import jieba from whoosh.analysis import Tokenizer, Token class ChineseTokenizer(Tokenizer): def __call__(self, value, positions=False, chars=False, keeporiginal=False, removestops=True, start_pos=0, start_char=0, mode='', **kwargs): t = Token(positions, chars, removestops=removestops, mode=mode, **kwargs) seglist = jieba.cut(value, cut_all=True) for w in seglist: t.original = t.text = w t.boost = 1.0
            if positions: t.pos = start_pos + value.find(w) if chars: t.startchar = start_char + value.find(w) t.endchar = start_char + value.find(w) + len(w) yield t def ChineseAnalyzer(): return ChineseTokenizer()

#複製whoosh_backend.py文件，更名爲whoosh_cn_backend.py
#注意：複製出來的文件名，末尾會有一個空格，記得要刪除這個空格
from .ChineseAnalyzer import ChineseAnalyzer 
查找
analyzer=StemmingAnalyzer()
改成
analyzer=ChineseAnalyzer()

7.在模版中建立搜索欄

<form method='get' action="/search/" target="_blank">
    <input type="text" name="q">
    <input type="submit" value="查詢">
</form>

8.其它配置

增長更多變量

from haystack.views import SearchView from .models import *  
      
class MySeachView(SearchView): def extra_context(self):       #重載extra_context來添加額外的context內容 
         context = super(MySeachView,self).extra_context() side_list = Topic.objects.filter(kind='major').order_by('add_date')[:8] context['side_list'] = side_list return context #路由修改
url(r'^search/', search_views.MySeachView(), name='haystack_search'),

高亮顯示

{% highlight result.summary with query %} # 這裏能夠限制最終{{ result.summary }}被高亮處理後的長度 {% highlight result.summary with query max_length 40 %} #html中 <style> span.highlighted { color: red;
        }
    </style>

Elasticsearch

簡介：

Elasticsearch 是一個分佈式可擴展的實時搜索和分析引擎,一個創建在全文搜索引擎 Apache Lucene(TM) 基礎上的搜索引擎.固然 Elasticsearch 並不只僅是 Lucene 那麼簡單，它不只包括了全文搜索功能，還能夠進行如下工做:

分佈式實時文件存儲，並將每個字段都編入索引，使其能夠被搜索。
可實現億級數據實時查詢
實時分析的分佈式搜索引擎。
能夠擴展到上百臺服務器，處理PB級別的結構化或非結構化數據。

安裝：

下載地址

注意：Elasticsearch是用Java開發的，最新版本的Elasticsearch須要安裝jdk1.8以上的環境

安裝包下載完，解壓，進入到bin目錄，啓動 elasticsearch.bat 便可

python操做ElasticSearch

from elasticsearch import Elasticsearch obj = Elasticsearch() # 建立索引（Index）
result = obj.indices.create(index='user', body={"userid":'1','username':'lqz'},ignore=400) # print(result) # 刪除索引 # result = obj.indices.delete(index='user', ignore=[400, 404]) # 插入數據 # data = {'userid': '1', 'username': 'lqz','password':'123'} # result = obj.create(index='news', doc_type='politics', id=1, body=data) # print(result) # 更新數據
''' 不用doc包裹會報錯 ActionRequestValidationException[Validation Failed: 1: script or doc is missing '''
# data ={'doc':{'userid': '1', 'username': 'lqz','password':'123ee','test':'test'}} # result = obj.update(index='news', doc_type='politics', body=data, id=1) # print(result)


# 刪除數據 # result = obj.delete(index='news', doc_type='politics', id=1)

# 查詢 # 查找全部文檔
query = {'query': {'match_all': {}}} # 查找名字叫作jack的全部文檔 # query = {'query': {'term': {'username': 'lqz'}}}

# 查找年齡大於11的全部文檔 # query = {'query': {'range': {'age': {'gt': 11}}}}
 allDoc = obj.search(index='news', doc_type='politics', body=query) print(allDoc['hits']['hits'][0]['_source'])

Haystack Python全文檢索框架