Django添加全文搜索功能入门篇

时间 2019-12-07

原文原文链接

感受网络上关于Django全文搜索的中文文章太少，而且讲的也不是很到位，就是简单介绍了怎么配置，并无说这样配置有什么用，因此依然很迷茫。因此但愿我这篇文章可以帮助到后来人。html

转载说明来源 http://tenlee2012.github.io/2...添加全文搜索功能入门/python

1、使用的工具

haystack是django的开源搜索框架，该框架支持Solr, Elasticsearch, Whoosh, *Xapian*搜索引擎，不用更改代码，直接切换引擎，减小代码量。git
搜索引擎使用Whoosh，这是一个由纯Python实现的全文搜索引擎，没有二进制文件等，比较小巧，配置比较简单，固然性能天然略低。github
中文分词Jieba，因为Whoosh自带的是英文分词，对中文的分词支持不是太好，故用jieba替换whoosh的分词组件。数据库
其余：Python 3.4.4, Django 1.8.3，Debian 4.2.6_3django

2、配置说明

如今假设咱们的项目叫作Project,有一个myapp的app，简略的目录结构以下。api

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

pip install whoosh django-haystack jieba

2. 添加 Haystack 到Django的 INSTALLED_APPS

配置Django项目的settings.py里面的 INSTALLED_APPS添加Haystack,例子：app

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 }}">{{ 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 }}">{% endif %}« Previous{% if page.has_previous %}</a>{% endif %}
                    |
                    {% if page.has_next %}<a href="?q={{ query }}&page={{ page.next_page_number }}">{% 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搜索一下试试吧。

3、下面要作的，使用`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的源码。