Haystack的安装与使用

Haystack的安装与使用1 什么是 HaystackHays 是 django 的开源全文搜索框架 全文检索不同于特定字段的模糊查询 使用全文检索的效率更高 该框架支持 Solr Elasticsearc Whoosh Xapian 搜索引擎它是一个可插拔的后端 很像 Django 的数据库层 所以几乎你所有写的代码都可以在不同搜索引擎之间便捷切换全文检索不同于特定字段的模糊查询 使用全文检索的效率更高 并且

1.什么是Haystack

Haystack是django的开源全文搜索框架(全文检索不同于特定字段的模糊查询,使用全文检索的效率更高 ),该框架支持Solr,Elasticsearch,Whoosh, Xapian搜索引擎它是一个可插拔的后端(很像Django的数据库层),所以几乎你所有写的代码都可以在不同搜索引擎之间便捷切换

  • 全文检索不同于特定字段的模糊查询,使用全文检索的效率更高,并且能够对于中文进行分词处理
  • haystack:django的一个包,可以方便地对model里面的内容进行索引、搜索,设计为支持whoosh,solr,Xapian,Elasticsearc四种全文检索引擎后端,属于一种全文检索的框架
  • whoosh:纯Python编写的全文搜索引擎,虽然性能比不上sphinx、xapian、Elasticsearc等,但是无二进制包,程序不会莫名其妙的崩溃,对于小型的站点,whoosh已经足够使用
  • jieba:一款免费的中文分词包,如果觉得不好用可以使用一些收费产品

2.安装

pip install django-haystack pip install whoosh pip install jieba 

3.配置

添加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', # 你的app 'blog', ] 

修改settings.py

在你的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文件,文件名不能修改

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这三个字段建立索引,当检索的时候会对这三个字段做全文检索匹配

5.设置视图

添加SearchView到你的URLconf

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

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

这会拉取Haystack的默认URLconf,它由单独指向SearchView实例的URLconf组成。你可以通过传递几个关键参数或者完全重新它来改变这个类的行为。

搜索模板

你的搜索模板(默认在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附带的一个命令行管理工具使它变得很容易。

简单的运行./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> 
版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请联系我们举报,一经查实,本站将立刻删除。

发布者:全栈程序员-站长,转载请注明出处:https://javaforall.net/231405.html原文链接:https://javaforall.net

(0)
上一篇 2025年12月15日 下午1:01
下一篇 2025年12月15日 下午1:22


相关推荐

  • 手机一键装windows系统_git could not create work tree

    手机一键装windows系统_git could not create work treeGit简介Git是目前世界上最先进的分布式版本控制系统。可以简单理解为一种管理的工具,通过git可以将github上的代码拉到本地或者把电脑里的代码push到github。Windows环境下Git的下载与安装地址:https://git-scm.com/download这里选择64位的下载完成后,双击即可进入安装界面选择自己想要安装的位置,默认C盘,这里选择了D盘一些组件:(这里选择在桌面上创建git的图标Additionalicons–OntheDesktop,其他的默认即

    2022年8月25日
    8
  • vim 设置搜索高亮_vim取消搜索后高亮持续

    vim 设置搜索高亮_vim取消搜索后高亮持续高亮有两种方法1)临时高亮vimfile文件输入:sethlsearch2)永久高亮vim~/.vimrc文件中添加sethlsearch取消搜索高亮:setnohlsearch或者简写的:noh

    2026年2月24日
    7
  • 打破数据质量瓶颈:用n8n实现30秒专业数据质量报告自动化

    打破数据质量瓶颈:用n8n实现30秒专业数据质量报告自动化

    2026年3月15日
    4
  • datagrip mac 激活码_在线激活2022.02.16

    (datagrip mac 激活码)2021最新分享一个能用的的激活码出来,希望能帮到需要激活的朋友。目前这个是能用的,但是用的人多了之后也会失效,会不定时更新的,大家持续关注此网站~https://javaforall.net/100143.htmlIntelliJ2021最新激活注册码,破解教程可免费永久激活,亲测有效,上面是详细链接哦~FZ…

    2022年4月1日
    72
  • mac版idea2021激活码【在线注册码/序列号/破解码】

    mac版idea2021激活码【在线注册码/序列号/破解码】,https://javaforall.net/100143.html。详细ieda激活码不妨到全栈程序员必看教程网一起来了解一下吧!

    2022年3月18日
    46
  • 灰度测试是什么意思

    灰度测试是什么意思本文章 百度 论坛 知乎等处查询 了解灰度测试 方便学习 本文章只限学习 文章可能内容多 我进行了网上查询终结 还需细看整理 如有重复内容请见谅 我也正在了解 方便手机携带查看 灰度测试就是指如果软件要在不久的将来推出一个全新的功能 或者做一次比较重大的改版的话 要先进行一个小范围的尝试工作 然后再慢慢放量 直到这个全新的功能覆盖到所有的系统用户 也就是说在新功能上线的黑白之间有一个灰 所以这种方法也通常被称为灰度测试 类似于我们通常所说的内测 灰度测试就是将自己的产品首先拿出来给一部分目标人群使用

    2026年3月17日
    3

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

关注全栈程序员社区公众号