全文搜索框架Haystack
Haystack
Haystack是django的开源全文搜索框架(全文检索不同于特定字段的模糊查询，使用全文检索的效率更高 )，该框架支持Solr、Elasticsearch、Whoosh、Xapian搜索引擎它是一个可插拔的后端（很像Django的数据库层），所以几乎你所有写的代码都可以在不同搜索引擎之间便捷切换
- 全文检索不同于特定字段的模糊查询，使用全文检索的效率更高，并且能够对于中文进行分词处理
- haystack：django的一个包，可以方便地对model里面的内容进行索引、搜索，设计为支持whoosh、solr、Xapian、Elasticsearc四种全文检索引擎后端，属于一种全文检索的框架
- whoosh：纯Python编写的全文搜索引擎，虽然性能比不上sphinx、xapian、Elasticsearc等，但是无二进制包，程序不会莫名其妙的崩溃，对于小型的站点，whoosh已经足够使用
- jieba：一款免费的中文分词包，如果觉得不好用可以使用一些收费产品
django-haystack的使用
安装
pip install django-haystack # 安装搜索框架
pip install whoosh # 安装whoosh搜索引擎
pip install jieba # 利用jieba实现中文的分词
注册
添加Haystack到INSTALLED_APPS，跟大多数Django的应用一样，首先要在设置文件(通常是settings.py)添加Haystack到INSTALLED_APPS. 示例：
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.sites',
# 注册haystack
'haystack',
# 注册项目中的应用
'blog',
]
配置搜索引擎
在settings.py中，添加一个 HAYSTACK——CONNECTIONS设置来指示使用的搜索引擎。并且应该至少是以下的一种：
Solr示例
HAYSTACK_CONNECTIONS = {
'default': {
'ENGINE': 'haystack.backends.solr_backend.SolrEngine',
'URL': 'http://127.0.0.1:8983/solr'
# 或者
# '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索引的文件系统位置
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索引的文件系统位置。
HAYSTACK_CONNECTIONS = {
'default': {
'ENGINE': 'xapian_backend.XapianEngine',
'PATH': os.path.join(os.path.dirname(__file__), 'xapian_index'),
},
}
处理数据
创建索引
如果你想针对某个app例如blog做全文检索
首先创建对应的模型表 models.py
class Article(models.Model):
title = models.CharField(max_length=32)
desc = models.CharField(max_length=255)
content = models.TextField()
然后必须在应用的目录下面建立search_indexes.py文件，文件名不能修改
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类里面一贯的命名，以防止后台混乱，当然名字你也可以随便改，不过不建议改。
另外，我们在text字段上提供了use_template=True。这允许我们使用一个数据模板（而不是容易出错的级联）来构建文档搜索引擎索引。你应该在模板目录下建立新的模板search/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这三个字段建立索引，当检索的时候会对这三个字段做全文检索匹配
设置视图
添加SearchView到你的URLconf
在你的URLconf中添加下面一行：
(r'^search/', include('haystack.urls')),
这会拉取Haystack的默认URLconf，它由单独指向SearchView实例的URLconf组成。你可以通过传递几个关键参数或者完全重新它来改变这个类的行为。
搜索模板
在search文件夹下创建默认模板search/search.html。下面的模板只是简单的展示了搜索的效果。
<!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 %}
{# {{ result.object.title }}
#}
// highlight是自定义的标签，对搜索结果中的关键字进行高亮显示，max_length 2 是指定被高亮处理后的长度
<a href="/{{ result.object.id }}/">{% highlight result.object.title with query max_length 2%}</a><br/>
{# {{ result.object.content|safe }}
#}
<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 }}&page={{ page.previous_page_number }}">{% endif %}« 上一页
{% if page.has_previous %}</a>{% endif %}
|
{% if page.has_next %}<a href="?q={{ query }}&page={{ page.next_page_number }}">{% endif %}下一页 »
{% if page.has_next %}</a>{% endif %}
</div>
{% endif %}
{% endif %}
</body>
</html>
需要注意的是page.object_list实际上是SearchResult对象的列表。这些对象返回索引的所有数据。它们可以通过{{result.object}}来访问。所以{{ result.object.title}}实际使用的是数据库中Article对象来访问title字段的。
重建索引
现在你已经配置好了所有的事情，是时候把数据库中的数据放入索引了。Haystack附带的一个命令行管理工具，启动cmd，切的对应的文件夹中，执行下面的命令：
python3 manage.py rebuild_index
创建搜索栏
上面的模板只是对搜索结果展示的模板，下面定义一个搜索模板，并定义对应的视图函数和路由。
view.py: # 视图函数
def index(request):
return render(request,'index.html')
index.html: # 搜索页面
<form method='get' action="/search/" target="_blank">
<input type="text" name="q">
<input type="submit" value="查询">
form>
经过上面的配置已经可以对文章进行检索了，但是因为Haystack只支持对英文的分词，不支持中文，所以接下来要引入另一个模块。
使用jieba分词
jeiba是Python的中文分词组件，它的特点是支持三种分词模式：
- 精确模式，试图将句子最精确地切开，适合文本分析；
- 全模式，把句子中所有的可以成词的词语都扫描出来, 速度非常快，但是不能解决歧义；
- 搜索引擎模式，在精确模式的基础上，对长词再次切分，提高召回率，适合用于搜索引擎分词。
首先创建一个ChineseAnalyzer.py文件，并把它保存在haystack的安装文件夹下，路径为你安装的python路径内(如：“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，打开文件编辑导入上面添加的模块并把所有的搜索引擎该为我们上面定义的搜索引擎。
# 复制whoosh_backend.py文件，改名为whoosh_cn_backend.py
# 导入我们自定义的模块
from .ChineseAnalyzer import ChineseAnalyzer
# 把文件内所有的搜索引擎替换掉
查找
analyzer=StemmingAnalyzer()
改为
analyzer=ChineseAnalyzer()
修改完文件后，在配置文件中也需要进行响应的修改：
# 需要设置PATH到你的Whoosh索引的文件系统位置
HAYSTACK_CONNECTIONS = {
'default': {
# 因为上面修改了搜索引擎文件，这里也要进行对应的修改把whoosh_backend改为whoosh_cn_backend
'ENGINE': 'haystack.backends.whoosh_backend.WhooshEngine',
'PATH': os.path.join(os.path.dirname(__file__), 'whoosh_index'),
},
}
这样修改后就可以对文章进行中文搜索了。
优化
上面最后的结果对搜索出来的标题不符合的部分也进行了.号代替，这样对搜索后结果的选择很不合理
1、可以直接修改源代码：
D:\Python\Lib\site-packages\haystack\utils文件下的highlighting.py文件进行修改。
class Highlighter(object):
... ...
def highlight(self, text_block):
self.text_block = strip_tags(text_block)
highlight_locations = self.find_highlightable_words()
start_offset, end_offset = self.find_window(highlight_locations)
# 把这里的起始位置该为0，后标题显示开头不会用 . 号代替
start_offset = 0
return self.render_html(highlight_locations, start_offset, end_offset)
... ...
这里修改的是源码，一般不建议进行修改，或者修改前对文件进行备份。
2、利用自定义标签：
把D:\Python3\Lib\site-packages\haystack\templatetags\highlight.py和D:\Python37-32\Lib\site-packages\haystack\utils\highlighting.py的源码拷贝到自己项目的自定义标签文件夹中(templatetags)，按照上面的方式进行修改。
前后端分离
增加更多变量
from haystack.views import SearchView
from .models import *
class MySeachView(SearchView):
# 我们通过重写extra_context来添加额外的context内容
# 通过看源码，extra_context 默认返回的是空，然后再get_context方法里面，把extra_context
# 返回的内容加到我们self.context字典里
def extra_context(self):
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
# 或者直接重写create_response来返回对应的数据，让前端进行渲染
def create_response(self):
"""
Generates the actual HttpResponse to send back to the user.
"""
context = self.get_context()
data_list=[]
data_dict={}
for i in context['page'].object_list:
data_dict['id']=i.object.id
data_dict['name']=i.object.name
data_dict['content'] = i.object.content
data_list.append(data_dict)
# print(context['page'].object_list)
#
return JsonResponse(data_list,safe=False,json_dumps_params={'ensure_ascii':False})
#路由修改
url(r'^search/', search_views.MySeachView(), name='haystack_search'),