Haystack 全文检索

一、Haystack简介

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

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

二、Haystack 安装

pip install django-haystack
pip install whoosh
pip install jieba

三、Haystack 配置

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.sites',
     # 添加
    'haystack',
]

在你的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'),
    },
}

四、处理数据

创建索引
如果你想针对某个app例如app01做全文检索，则必须在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。这允许我们使用一个数据模板（而不是容易出错的级联）来构建文档搜索引擎索引。在目录templates/search/indexes/应用名称/下创建模型类名称_text.txt文件
目录结构

templates
    ├── search   # 目录
    └── search.html # 搜索模板
    │   ├── indexes  # 目录
    │       ├── app01    #  根据项目app名称对应创建目录
    └──     └── article_text.txt   #  根据表名小写+_text.txt

全文检索article_text.txt文件设置的检索字段内容

{{ object.name }}
{{ object.desc }}
{{ object.content }}

models.py

from django.db import models


class Article(models.Model):
    name = models.CharField(max_length=32)
    desc = models.CharField(max_length=128)
    content = models.TextField()

五、设置视图

添加SearchView到你的URLconf

path('search/', include('haystack.urls')),

1.搜索模板

你的搜索模板(默认在search/search.html)将可能非常简单。下面的足够让你的搜索运行(你的template/block应该会不同)

需要注意的是page.object_list实际上是SearchResult对象的列表。这些对象返回索引的所有数据。它们可以通过{{result.object}}来访问。所以{{ result.object.title}}实际使用的是数据库中Article对象来访问title字段的。

2.重建索引

数据库写入新数据执行./manage.py rebuild_index。你会得到有多少模型进行了处理并放进索引的统计。

注意：可能会报错：

Error fetching command 'build_solr_schema': The 'solr' backend requires the installation of 'pysolr'. Please refer to the documentation. Command 'build_solr_schema' skipped

解决：pip install pysolr

六、使用jieba分词

1.在app里建立ChineseAnalyzer.py文件

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()

2.保存在haystack的安装文件夹下，路径如E:\python3\Lib\site-packages\haystack\backends这一步是改变源代码，使其能够实现对中文分词。

#修改whoosh_backend.py文件
#导入模块
from .ChineseAnalyzer import ChineseAnalyzer 
查找
analyzer=field_class.analyzer or StemmingAnalyzer()
改为
analyzer=field_class.analyzer or ChineseAnalyzer()

2.1 view.py

def test(request):
    return render(request, 'index.html')

2.2 index.html 模版中创建搜索栏

<form method='get' action="/search/" target="_blank">
    <input type="text" name="q">
    <input type="submit" value="查询">
</form>

2.3 urls.py

path('test/', views.test),

七、其它配置

1.增加更多变量

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
# 路由修改  
path('^search/', search_views.MySeachView(), name='haystack_search'),

2.高亮显示

{% highlight result.summary with query %}  
# 这里可以限制最终{{ result.summary }}被高亮处理后的长度  
{% highlight result.summary with query max_length 40 %}  

#html中
    <style>
        span.highlighted {
            color: red;
        }
    </style>

八、Haystack 前后端分离重写方法

view.py 视图

rom haystack.views import SearchView
from django.http import JsonResponse

class MysearchView(SearchView):
    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})

urls.py 路由

path('search/', search.MysearchView()),
posted @   沈忻凯  阅读(160)  评论(0)  编辑  收藏  举报
编辑推荐：
· 从 HTTP 原因短语缺失研究 HTTP/2 和 HTTP/3 的设计差异
· AI与.NET技术实操系列：向量存储与相似性搜索在 .NET 中的实现
· 基于Microsoft.Extensions.AI核心库实现RAG应用
· Linux系列：如何用heaptrack跟踪.NET程序的非托管内存泄露
· 开发者必知的日志记录最佳实践
阅读排行：
· TypeScript + Deepseek 打造卜卦网站：技术与玄学的结合
· Manus的开源复刻OpenManus初探
· 写一个简单的SQL生成工具
· AI 智能体引爆开源社区「GitHub 热点速览」
· C#/.NET/.NET Core技术前沿周刊 | 第 29 期（2025年3.1-3.9）
点击右上角即可分享
微信分享提示