Haystack全文检索

1.什么是Haystack

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

引擎检索比mysql快很多,安装引擎后以后检索数据不必从mysql中查找,而是直接从引擎中搜索

- 全文检索不同于特定字段的模糊查询，使用全文检索的效率更高，并且能够对于中文进行分词处理
- 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

#类名必须是表模型+index
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.name }}
{{ object.desc }}
{{ object.content }}

这个数据模板的作用是对Note.title, Note.user.get_full_name,Note.body这三个字段建立索引，当检索的时候会对这三个字段做全文检索匹配

5.设置视图

添加SearchView到你的URLconf

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

from django.conf.urls import include
url(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.name }}</a><br/>#}
        #包括搜索内容往后显示两个字符
        <a href="/{{ result.object.id }}/">{%   highlight result.object.name with query max_length 2%}</a><br/>
        #显示所有content内容
{#        <p>{{ result.object.content|safe }}</p>#}
        #包括搜索内容往后显示10个字符
        <p>{% highlight result.object.content with query max_length 10%}</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(在pycharm中直接运行 rebuild_index)。

6.使用jieba分词

#默认haystack运用的是英文分词,要使用中文分词,我们要将我们的分词替换为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 }}被高亮处理后的长度,max_length 2 表示包括搜索内容往后显示两个字符
{% highlight result.summary with query max_length 2 %}  

#html中 高亮显示的颜色为红色
    <style>
        span.highlighted {
            color: red;
        }
    </style>

原文地址：https://www.cnblogs.com/lizeqian1994/p/10751559.html

时间： 2024-11-06 09:47:07

Haystack全文检索的相关文章

Haystack全文检索框架中使用jieba分词包

1.安装jieba pip install jieba 2.引入jieba cd 到haystack安装目录backends下, 新建文件ChineseAnalyzer.py,键入内容 import jieba from whoosh.analysis import Tokenizer, Token class ChineseTokenizer(Tokenizer): def __call__(self, value, positions=False, chars=False, keeporig

全文检索的配置

全文检索不同于特定字段的模糊查询,使用全文检索的效率再高,并且能够对于中文进行分词处理. haystack:全文检索框架,支持whoosh.solr.Xaplan.Elasticsearc四种全文检索引擎 whoosh:纯python编写的全文搜索引擎,虽然 性能比不上sphinx.xapian.elasticsearc等,但是无二进制包,程序不会莫名其妙的崩溃,对于小型的站点,whoosh已经足够使用, jieba:中文分词包 安装包: pip install django-haystackp

全文检索框架

第一步:安装全文检索框架django-haystack pip3 install django-haystack 第二步:安装搜索引擎 pip3 install whoosh 第三步:在settings配置app INSTALLED_APPS = [ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.mes

django之快速分页

本文介绍djanog两种分页,第一是普通分页,第二是使用haystack全文检索的分页. 1．django自带分页功能,这个功能非常好用.基本知识点:Django提供了数据分页的类,这些类被定义在django/core/paginator.py中对象Paginator用于对列进行一页n条数据的分页运算对象Page用于表示第m页的数据Paginator对象 方法init(列表,int):返回分页对象,参数为列表数据,每面数据的条数属性count:返回对象总数属性num_pages:返回页面总数属性

天天生鲜 - App设计

天天生鲜-思路数据库设计 天天生鲜-各个App 全文检索 天天生鲜-静态文件 一.项目目录 daily_fresh_demo - daily_fresh_demo - df_cart # 购物车功能 - df_goods # 商品功能 - df_order # 订单功能 - df_user # 用户功能(包括登录验证等相关功能) - static # 静态文件 - templates # 前段模板- whoosh_index # 全局索引文件 db.sqlite3 manage.py  注:这个

Django框架项目-电商web（未前后分离）

项目:电商订购网站 所用到框架: 语言:Python3.6.8 (Django==1.11.1) 数据库: MySql. redis 任务队列(异步处理): celery 分布式文件存储: FastDFS或者本地都行 搜索引擎(商品检索): django-haystack .whoosh web服务器配置: Nginx+ uwsgi 后台管理: django-admin 实现功能:用户模块,商品相关,购物车相关,订单相关 1. 需求分析 1.1 用户模块 注册页 注册时校验用户名是否已被注册.

编写 Django 应用单元测试

作者:HelloGitHub-追梦人物 文中所涉及的示例代码,已同步更新到 HelloGitHub-Team 仓库 我们博客功能越来越来完善了,但这也带来了一个问题,我们不敢轻易地修改已有功能的代码了! 我们怎么知道代码修改后带来了预期的效果?万一改错了,不仅新功能没有用,原来已有的功能都可能被破坏.此前我们开发一个新的功能,都是手工运行开发服务器去验证,不仅费时,而且极有可能验证不充分. 如何不用每次开发了新的功能或者修改了已有代码都得去人工验证呢?解决方案就是编写自动化测试,将人工验证的逻辑

haystack(django的全文检索模块)

haystack haystack是django开源的全文搜索框架 全文检索:标题可以检索,内容也可以检索 支持solr ,elasticsearch,whoosh 1.注册app 在setting.py的app中注册"haystack" 2.指定用哪个引擎(solr,elasticsearch,whoosh) 将配置文件放在setting文件中 在你的`settings.py`中,你需要添加一个设置来指示站点配置文件正在使用的后端,以及其它的后端设置. `HAYSTACK--CONN

全文检索框架Haystack,与 Whoosh搜索引擎的搭配以及相关配置

1. 安装Django项目下使用的django-haystack包, 以及搜索引擎whoosh包 pip install django-haystack pip install whoosh 2. Django项目文件中, settings添加haystack配置 # 全文检索框架的配置(haystack) HAYSTACK_CONNECTIONS = { 'default': { # 选择引擎(haystock包内的backend后端文件夹选中whoosh的相关配置文件的Engine函数) '