一:使用的工具
- 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
- Project
此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',
]
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=True
在text
字段,這樣就允許我們使用數(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"