Django添加全文搜索功能入門篇

感覺網(wǎng)絡(luò)上關(guān)于Django全文搜索的中文文章太少,并且講的也不是很到位,就是簡單介紹了怎么配置晦譬,并沒有說這樣配置有什么用,所以依然很迷茫互广。所以希望我這篇文章能夠幫助到后來人敛腌。

轉(zhuǎn)載說明來源 http://tenlee2012.github.io/2016/04/21/Django添加全文搜索功能入門/

一:使用的工具

  • haystack是django的開源搜索框架,該框架支持Solr, Elasticsearch, Whoosh, **Xapian搜索引擎惫皱,不用更改代碼像樊,直接切換引擎,減少代碼量旅敷。
  • 搜索引擎使用Whoosh生棍,這是一個(gè)由純Python實(shí)現(xiàn)的全文搜索引擎,沒有二進(jìn)制文件等媳谁,比較小巧涂滴,配置比較簡單,當(dāng)然性能自然略低晴音。
  • 中文分詞Jieba柔纵,由于Whoosh自帶的是英文分詞,對中文的分詞支持不是太好锤躁,故用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é)構(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)建索引

如果你想針對某個(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類里面一貫的命名徙融,以防止后臺混亂,當(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ù)模板的作用是對Note.title, Note.user.get_full_name,Note.body這三個(gè)字段建立索引鹊杖,當(dāng)檢索的時(shí)候會對這三個(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)更新索引的最簡單方法在
settings.py添加一個(gè)信號闯团。

HAYSTACK_SIGNAL_PROCESSOR =
            "haystack.signals.RealtimeSignalProcesso"

官方文檔


看了這入門篇辛臊,你現(xiàn)在應(yīng)該大概能配置一個(gè)簡單的全文搜索了吧,如果想自定義怎么辦房交? 建議閱讀官方文檔和github的源碼彻舰。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市涌萤,隨后出現(xiàn)的幾起案子淹遵,更是在濱河造成了極大的恐慌口猜,老刑警劉巖负溪,帶你破解...
    沈念sama閱讀 206,311評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異济炎,居然都是意外死亡川抡,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,339評論 2 382
  • 文/潘曉璐 我一進(jìn)店門须尚,熙熙樓的掌柜王于貴愁眉苦臉地迎上來崖堤,“玉大人,你說我怎么就攤上這事耐床∶茚#” “怎么了?”我有些...
    開封第一講書人閱讀 152,671評論 0 342
  • 文/不壞的土叔 我叫張陵撩轰,是天一觀的道長胯甩。 經(jīng)常有香客問我昧廷,道長,這世上最難降的妖魔是什么偎箫? 我笑而不...
    開封第一講書人閱讀 55,252評論 1 279
  • 正文 為了忘掉前任木柬,我火速辦了婚禮,結(jié)果婚禮上淹办,老公的妹妹穿的比我還像新娘眉枕。我一直安慰自己,他們只是感情好怜森,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,253評論 5 371
  • 文/花漫 我一把揭開白布速挑。 她就那樣靜靜地躺著,像睡著了一般塔插。 火紅的嫁衣襯著肌膚如雪梗摇。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,031評論 1 285
  • 那天想许,我揣著相機(jī)與錄音伶授,去河邊找鬼。 笑死流纹,一個(gè)胖子當(dāng)著我的面吹牛糜烹,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播漱凝,決...
    沈念sama閱讀 38,340評論 3 399
  • 文/蒼蘭香墨 我猛地睜開眼疮蹦,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了茸炒?” 一聲冷哼從身側(cè)響起愕乎,我...
    開封第一講書人閱讀 36,973評論 0 259
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎壁公,沒想到半個(gè)月后感论,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 43,466評論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡紊册,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 35,937評論 2 323
  • 正文 我和宋清朗相戀三年比肄,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片囊陡。...
    茶點(diǎn)故事閱讀 38,039評論 1 333
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡芳绩,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出撞反,到底是詐尸還是另有隱情妥色,我是刑警寧澤,帶...
    沈念sama閱讀 33,701評論 4 323
  • 正文 年R本政府宣布遏片,位于F島的核電站嘹害,受9級特大地震影響鳍侣,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜吼拥,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,254評論 3 307
  • 文/蒙蒙 一倚聚、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧凿可,春花似錦惑折、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,259評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至敛助,卻和暖如春粗卜,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背纳击。 一陣腳步聲響...
    開封第一講書人閱讀 31,485評論 1 262
  • 我被黑心中介騙來泰國打工续扔, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人焕数。 一個(gè)月前我還...
    沈念sama閱讀 45,497評論 2 354
  • 正文 我出身青樓纱昧,卻偏偏與公主長得像,于是被迫代替她去往敵國和親堡赔。 傳聞我的和親對象是個(gè)殘疾皇子识脆,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,786評論 2 345

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