Django haystack实现全文搜索代码示例


Posted in Python onNovember 28, 2020

一、使用的工具

haystack是django的开源搜索框架,该框架支持Solr,Elasticsearch,Whoosh,*Xapian*搜索引擎,不用更改代码,直接切换引擎,减少代码量。

搜索引擎使用Whoosh,这是一个由纯Python实现的全文搜索引擎,没有二进制文件等,比较小巧,配置比较简单,当然性能自然略低。

中文分词Jieba,由于Whoosh自带的是英文分词,对中文的分词支持不是太好,故用jieba替换whoosh的分词组件。

其他:Python 3.4.4, Django 1.8.3,Debian 4.2.6_3

二、配置说明

现在假设我们的项目叫做Project,有一个myapp的app,简略的目录结构如下。

- Project
- Project
- settings.py
- blog
- models.py

此models.py的内容假设如下:

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. 首先安装各工具

pipinstall whoosh django-haystack jieba

2. 添加 Haystack 到Django的INSTALLED_APPS

配置Django项目的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.创建索引

如果你想针对某个app例如mainapp做全文检索,则必须在mainapp的目录下面建立search_indexes.py文件,文件名不能修改。内容如下:

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

每个索引里面必须有且只能有一个字段为document=True,这代表haystack 和搜索引擎将使用此字段的内容作为索引进行检索(primary field)。其他的字段只是附属的属性,方便调用,并不作为检索数据。

注意:如果使用一个字段设置了document=True,则一般约定此字段名为text,这是在SearchIndex类里面一贯的命名,以防止后台混乱,当然名字你也可以随便改,不过不建议改。

并且,haystack提供了use_template=True在text字段,这样就允许我们使用数据模板去建立搜索引擎索引的文件,使用方便(官方推荐,当然还有其他复杂的建立索引文件的方式,目前我还不知道),数据模板的路径为yourapp/templates/search/indexes/yourapp/note_text.txt,例如本例子为blog/templates/search/indexes/blog/note_text.txt文件名必须为要索引的类名_text.txt,其内容为

{{ object.title }}
{{ object.user.get_full_name }}
{{ object.body }}

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

5.在URL配置中添加SearchView,并配置模板

在urls.py中配置如下url信息,当然url路由可以随意写。

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

其实haystack.urls的内容为,

from django.conf.urls import url
from haystack.views import SearchView

urlpatterns = [
  url(r'^$', SearchView(), name='haystack_search'),
]

SearchView()视图函数默认使用的html模板为当前app目录下,路径为myapp/templates/search/search.html
所以需要在blog/templates/search/下添加search.html文件,内容为

{% 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 }}" rel="external nofollow" >{{ 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 }}" rel="external nofollow" >{% endif %}« Previous{% if page.has_previous %}</a>{% endif %}
          |
          {% if page.has_next %}<a href="?q={{ query }}&page={{ page.next_page_number }}" rel="external nofollow" >{% 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命令。

好,下面运行项目,进入该url搜索一下试试吧。

三、下面要做的,使用jieba分词第一步

将文件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)

第二步

在settings.py中修改引擎,如下

import os
HAYSTACK_CONNECTIONS = {
  'default': {
    'ENGINE': 'blog.whoosh_cn_backend.WhooshEngine',
    'PATH': os.path.join(BASE_DIR, 'whoosh_index'
  },
}

第三步

重建索引,在进行搜索中文试试吧。

索引自动更新

如果没有索引自动更新,那么每当有新数据添加到数据库,就要手动执行update_index命令是不科学的。自动更新索引的最简单方法在settings.py添加一个信号。

 HAYSTACK_SIGNAL_PROCESSOR =
"haystack.signals.RealtimeSignalProcessor"

官方文档

看了这入门篇,你现在应该大概能配置一个简单的全文搜索了吧,如果想自定义怎么办? 建议阅读官方文档和github的源码。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Python 相关文章推荐
pygame学习笔记(5):游戏精灵
Apr 15 Python
在Python中操作列表之list.extend()方法的使用
May 20 Python
VSCode下好用的Python插件及配置
Apr 06 Python
django 发送手机验证码的示例代码
Apr 25 Python
django 在原有表格添加或删除字段的实例
May 27 Python
python框架中flask知识点总结
Aug 17 Python
详解Numpy中的广播原则/机制
Sep 20 Python
Python中的heapq模块源码详析
Jan 08 Python
Python中logging实例讲解
Jan 17 Python
python matplotlib实现将图例放在图外
Apr 17 Python
Python‘==‘ 及 ‘is‘相关原理解析
Sep 05 Python
Python3+PyCharm+Django+Django REST framework配置与简单开发教程
Feb 16 Python
windows下python 3.9 Numpy scipy和matlabplot的安装教程详解
Nov 28 #Python
关于Python 解决Python3.9 pandas.read_excel(‘xxx.xlsx‘)报错的问题
Nov 28 #Python
Python self用法详解
Nov 28 #Python
Python3.9最新版下载与安装图文教程详解(Windows系统为例)
Nov 28 #Python
python安装sklearn模块的方法详解
Nov 28 #Python
Django-silk性能测试工具安装及使用解析
Nov 28 #Python
python 实现学生信息管理系统的示例
Nov 28 #Python
You might like
php上传图片存入数据库示例分享
2014/03/11 PHP
PHP中4个加速、缓存扩展的区别和选用建议
2014/03/12 PHP
ThinkPHP模板判断输出Empty标签用法详解
2014/06/30 PHP
PHP实现的汉字拼音转换和公历农历转换类及使用示例
2014/07/01 PHP
利用PHP生成静态html页面的原理
2016/09/30 PHP
PHP实现基于面向对象的mysqli扩展库增删改查操作工具类
2017/07/18 PHP
php实现微信和支付宝支付的示例代码
2020/08/11 PHP
JavaScript Cookie的读取和写入函数
2009/12/08 Javascript
关于可运行代码无法正常执行的使用说明
2010/05/13 Javascript
深入理解JavaScript系列(8) S.O.L.I.D五大原则之里氏替换原则LSP
2012/01/15 Javascript
JS调用CS里的带参方法实例
2013/08/01 Javascript
jQuery中:checked选择器用法实例
2015/01/04 Javascript
jquery拖拽效果完整实例(附demo源码下载)
2016/01/14 Javascript
Angular2  NgModule 模块详解
2016/10/19 Javascript
React Native如何消除启动时白屏的方法
2017/08/08 Javascript
vue.js分页中单击页码更换页面内容的方法(配合spring springmvc)
2018/02/10 Javascript
vuex实现登录状态的存储,未登录状态不允许浏览的方法
2018/03/09 Javascript
使用angularjs.foreach时return的问题解决
2018/09/30 Javascript
NodeJs 模仿SIP话机注册的方法
2019/06/21 NodeJs
vue中touch和click共存的解决方式
2020/07/28 Javascript
[59:08]DOTA2上海特级锦标赛C组小组赛#2 LGD VS Newbee第一局
2016/02/27 DOTA
Python遍历zip文件输出名称时出现乱码问题的解决方法
2015/04/08 Python
Python使用while循环花式打印乘法表
2019/01/28 Python
Python函数装饰器常见使用方法实例详解
2019/03/30 Python
python 解决Fatal error in launcher:错误问题
2020/05/21 Python
Python基于爬虫实现全网搜索并下载音乐
2021/02/14 Python
跑鞋、网球鞋、网球拍、服装及装备:Holabird Sports
2016/09/19 全球购物
大学生就业自我鉴定
2013/10/26 职场文书
2014年毕业演讲稿范文
2014/05/13 职场文书
2014年库房工作总结
2014/11/26 职场文书
2019自荐信该如何写呢?
2019/07/05 职场文书
Golang二维切片初始化的实现
2021/04/08 Golang
vue中利用mqtt服务端实现即时通讯的步骤记录
2021/07/01 Vue.js
Linux7.6二进制安装Mysql8.0.27详细操作步骤
2021/11/27 MySQL
动画电影《擅长捉弄人的高木同学》6月10日上映!
2022/03/20 日漫
使用Nginx+Tomcat实现负载均衡的全过程
2022/05/30 Servers