Django-全文檢索工具h(yuǎn)aystack-whoosh-jieba

一:使用的工具

  • haystack是django的開源搜索框架畴椰,該框架支持Solr, Elasticsearch, Whoosh, **Xapian搜索引擎祠锣,不用更改代碼,直接切換引擎昵宇,減少代碼量梯醒。
  • 搜索引擎使用Whoosh,這是一個(gè)由純Python實(shí)現(xiàn)的全文搜索引擎郑原,沒有二進(jìn)制文件等唉韭,比較小巧,配置比較簡(jiǎn)單犯犁,當(dāng)然性能自然略低属愤。
  • 中文分詞Jieba,由于Whoosh自帶的是英文分詞酸役,對(duì)中文的分詞支持不是太好住诸,故用jieba替換whoosh的分詞組件。
  • 其他:Python 3.4.4, Django 1.8.3涣澡,Debian 4.2.6_3

二:配置說明

現(xiàn)在假設(shè)我們的項(xiàng)目叫做Project,有一個(gè)myapp的app贱呐,簡(jiǎn)略的目錄結(jié)構(gòu)如下。

  • Project
    • Project
      • settings.py
    • blog
      • models.py

models.py的內(nèi)容假設(shè)如下:

from django.db import models
from django.contrib.auth.models import User

class Note(models.Model):
    user = models.ForeignKey(User)
    pub_date = models.DateTimeField()
    title = models.CharField(max_length=200)
    body = models.TextField()

    def __str__(self):
        return self.title

1. 首先安裝各工具

pip install whoosh django-haystack jieba

2. 添加 Haystack 到Django的 INSTALLED_APPS

配置Django項(xiàng)目的settings.py里面的 INSTALLED_APPS添加Haystack,例子:

INSTALLED_APPS = [ 
        'django.contrib.admin',
        'django.contrib.auth', 
        'django.contrib.contenttypes', 
        'django.contrib.sessions', 
        'django.contrib.sites', 

          # Added. haystack先添加入桂,
          'haystack', 
          # Then your usual apps... 自己的app要寫在haystakc后面
          'blog',
]

點(diǎn)我看英文原版

3. 修改 你的 settings.py奄薇,以配置引擎

本教程使用的是Whoosh,故配置如下:

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

其中顧名思義抗愁,ENGINE為使用的引擎必須要有馁蒂,如果引擎是Whoosh,則PATH必須要填寫蜘腌,其為Whoosh 索引文件的存放文件夾沫屡。
其他引擎的配置見官方文檔

4.創(chuàng)建索引

如果你想針對(duì)某個(gè)app例如mainapp做全文檢索,則必須在mainapp的目錄下面建立search_indexes.py文件撮珠,文件名不能修改沮脖。內(nèi)容如下:

import datetime
from haystack import indexes
from myapp.models import Note

class NoteIndex(indexes.SearchIndex, indexes.Indexable):
    text = indexes.CharField(document=True, use_template=True)

    author = indexes.CharField(model_attr='user')
    pub_date = indexes.DateTimeField(model_attr='pub_date')

    def get_model(self):
        return Note

    def index_queryset(self, using=None):
        """Used when the entire index for model is updated."""
        return self.get_model().objects.filter(pub_date__lte=datetime.datetime.now())

每個(gè)索引里面必須有且只能有一個(gè)字段為document=True,這代表haystack 和搜索引擎將使用此字段的內(nèi)容作為索引進(jìn)行檢索(primary field)芯急。其他的字段只是附屬的屬性倘潜,方便調(diào)用,并不作為檢索數(shù)據(jù)志于。

注意:如果使用一個(gè)字段設(shè)置了document=True,則一般約定此字段名為text废睦,這是在SearchIndex類里面一貫的命名伺绽,以防止后臺(tái)混亂,當(dāng)然名字你也可以隨便改,不過不建議改奈应。

并且澜掩,haystack提供了use_template=Truetext字段,這樣就允許我們使用數(shù)據(jù)模板去建立搜索引擎索引的文件杖挣,使用方便(官方推薦肩榕,當(dāng)然還有其他復(fù)雜的建立索引文件的方式,目前我還不知道)惩妇,數(shù)據(jù)模板的路徑為yourapp/templates/search/indexes/yourapp/note_text.txt株汉,例如本例子為blog/templates/search/indexes/blog/note_text.txt文件名必須為要索引的類名_text.txt,其內(nèi)容為

{{ object.title }}
{{ object.user.get_full_name }}
{{ object.body }}

這個(gè)數(shù)據(jù)模板的作用是對(duì)Note.title, Note.user.get_full_name,Note.body這三個(gè)字段建立索引,當(dāng)檢索的時(shí)候會(huì)對(duì)這三個(gè)字段做全文檢索匹配歌殃。

5.在URL配置中添加SearchView乔妈,并配置模板

urls.py中配置如下url信息,當(dāng)然url路由可以隨意寫氓皱。

(r'^search/', include('haystack.urls')),

其實(shí)haystack.urls的內(nèi)容為路召,

from django.conf.urls import url
from haystack.views import SearchView

urlpatterns = [
    url(r'^$', SearchView(), name='haystack_search'),
]

SearchView()視圖函數(shù)默認(rèn)使用的html模板為當(dāng)前app目錄下,路徑為myapp/templates/search/search.html
所以需要在blog/templates/search/下添加search.html文件波材,內(nèi)容為

{% extends 'base.html' %}

{% block content %}
    <h2>Search</h2>

    <form method="get" action=".">
        <table>
            {{ form.as_table }}
            <tr>
                <td> </td>
                <td>
                    <input type="submit" value="Search">
                </td>
            </tr>
        </table>

        {% if query %}
            <h3>Results</h3>

            {% for result in page.object_list %}
                <p>
                    <a href="{{ result.object.get_absolute_url }}">{{ result.object.title }}</a>
                </p>
            {% empty %}
                <p>No results found.</p>
            {% endfor %}

            {% if page.has_previous or page.has_next %}
                <div>
                    {% if page.has_previous %}<a href="?q={{ query }}&page={{ page.previous_page_number }}">{% endif %}? Previous{% if page.has_previous %}</a>{% endif %}
                    |
                    {% if page.has_next %}<a href="?q={{ query }}&page={{ page.next_page_number }}">{% endif %}Next ?{% if page.has_next %}</a>{% endif %}
                </div>
            {% endif %}
        {% else %}
            {# Show some example queries to run, maybe query syntax, something else? #}
        {% endif %}
    </form>
{% endblock %}

很明顯股淡,它自帶了分頁。

6.最后一步廷区,重建索引文件

使用python manage.py rebuild_index或者使用update_index命令唯灵。

好,下面運(yùn)行項(xiàng)目躲因,進(jìn)入該url搜索一下試試吧早敬。

下面要做的,使用jieba分詞

1 將文件whoosh_backend.py(該文件路徑為python路徑/lib/python3.4/site-packages/haystack/backends/whoosh_backend.py
)拷貝到app下面大脉,并重命名為whoosh_cn_backend.py搞监,例如blog/whoosh_cn_backend.py。修改如下
添加from jieba.analyse import ChineseAnalyzer
修改為如下

schema_fields[field_class.index_fieldname] =
    TEXT(stored=True, analyzer=ChineseAnalyzer(),
            field_boost=field_class.boost)

2 在settings.py中修改引擎镰矿,如下

import os
HAYSTACK_CONNECTIONS = {
    'default': {
        'ENGINE': 'blog.whoosh_cn_backend.WhooshEngine',
        'PATH': os.path.join(BASE_DIR, 'whoosh_index'
    },
}

3 重建索引琐驴,在進(jìn)行搜索中文試試吧。

索引自動(dòng)更新

如果沒有索引自動(dòng)更新秤标,那么每當(dāng)有新數(shù)據(jù)添加到數(shù)據(jù)庫绝淡,就要手動(dòng)執(zhí)行update_index命令是不科學(xué)的。自動(dòng)更新索引的最簡(jiǎn)單方法在
settings.py添加一個(gè)信號(hào)苍姜。

HAYSTACK_SIGNAL_PROCESSOR =
            "haystack.signals.RealtimeSignalProcesso"

官方文檔

http://tenlee2012.github.io/2016/04/21/Django

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末牢酵,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子衙猪,更是在濱河造成了極大的恐慌馍乙,老刑警劉巖布近,帶你破解...
    沈念sama閱讀 206,968評(píng)論 6 482
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異丝格,居然都是意外死亡撑瞧,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,601評(píng)論 2 382
  • 文/潘曉璐 我一進(jìn)店門显蝌,熙熙樓的掌柜王于貴愁眉苦臉地迎上來预伺,“玉大人,你說我怎么就攤上這事曼尊〕昃鳎” “怎么了?”我有些...
    開封第一講書人閱讀 153,220評(píng)論 0 344
  • 文/不壞的土叔 我叫張陵涩禀,是天一觀的道長料滥。 經(jīng)常有香客問我,道長艾船,這世上最難降的妖魔是什么葵腹? 我笑而不...
    開封第一講書人閱讀 55,416評(píng)論 1 279
  • 正文 為了忘掉前任,我火速辦了婚禮屿岂,結(jié)果婚禮上践宴,老公的妹妹穿的比我還像新娘。我一直安慰自己爷怀,他們只是感情好阻肩,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,425評(píng)論 5 374
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著运授,像睡著了一般烤惊。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上吁朦,一...
    開封第一講書人閱讀 49,144評(píng)論 1 285
  • 那天柒室,我揣著相機(jī)與錄音,去河邊找鬼逗宜。 笑死雄右,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的纺讲。 我是一名探鬼主播擂仍,決...
    沈念sama閱讀 38,432評(píng)論 3 401
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼熬甚!你這毒婦竟也來了逢渔?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 37,088評(píng)論 0 261
  • 序言:老撾萬榮一對(duì)情侶失蹤乡括,失蹤者是張志新(化名)和其女友劉穎复局,沒想到半個(gè)月后冲簿,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 43,586評(píng)論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡亿昏,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,028評(píng)論 2 325
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了档礁。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片角钩。...
    茶點(diǎn)故事閱讀 38,137評(píng)論 1 334
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖呻澜,靈堂內(nèi)的尸體忽然破棺而出递礼,到底是詐尸還是另有隱情,我是刑警寧澤羹幸,帶...
    沈念sama閱讀 33,783評(píng)論 4 324
  • 正文 年R本政府宣布脊髓,位于F島的核電站,受9級(jí)特大地震影響栅受,放射性物質(zhì)發(fā)生泄漏将硝。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,343評(píng)論 3 307
  • 文/蒙蒙 一屏镊、第九天 我趴在偏房一處隱蔽的房頂上張望依疼。 院中可真熱鬧,春花似錦而芥、人聲如沸律罢。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,333評(píng)論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽误辑。三九已至,卻和暖如春歌逢,著一層夾襖步出監(jiān)牢的瞬間巾钉,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,559評(píng)論 1 262
  • 我被黑心中介騙來泰國打工趋翻, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留睛琳,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 45,595評(píng)論 2 355
  • 正文 我出身青樓踏烙,卻偏偏與公主長得像师骗,于是被迫代替她去往敵國和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子讨惩,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,901評(píng)論 2 345

推薦閱讀更多精彩內(nèi)容

  • 感覺網(wǎng)絡(luò)上關(guān)于Django全文搜索的中文文章太少辟癌,并且講的也不是很到位,就是簡(jiǎn)單介紹了怎么配置荐捻,并沒有說這樣配置有...
    tenlee閱讀 8,000評(píng)論 3 16
  • 1. 全文檢索 什么是全文檢索全文檢索就是針對(duì)所有內(nèi)容進(jìn)行動(dòng)態(tài)匹配搜索的概念黍少,針對(duì)特定的關(guān)鍵詞進(jìn)行建立索引并精確匹...
    依舊丶森閱讀 809評(píng)論 0 3
  • 全文檢索概述 全文檢索就是針對(duì)所有內(nèi)容進(jìn)行動(dòng)態(tài)匹配搜索的概念寡夹,針對(duì)特定的關(guān)鍵詞進(jìn)行建立索引并精確匹配達(dá)到性能優(yōu)化的...
    云Shen不知處閱讀 387評(píng)論 0 0
  • 全文檢索就是針對(duì)所有內(nèi)容進(jìn)行動(dòng)態(tài)匹配搜索的概念,針對(duì)特定的關(guān)鍵詞建立索引并精確匹配達(dá)到性能優(yōu)化的目的 最常見的全文...
    梅花九弄丶閱讀 1,525評(píng)論 0 1
  • # Python 資源大全中文版 我想很多程序員應(yīng)該記得 GitHub 上有一個(gè) Awesome - XXX 系列...
    aimaile閱讀 26,444評(píng)論 6 428