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

感受網絡上關於Django全文搜索的中文文章太少，而且講的也不是很到位，就是簡單介紹了怎麼配置，並無說這樣配置有什麼用，因此依然很迷茫。因此但願我這篇文章可以幫助到後來人。

轉載說明來源 http://tenlee2012.github.io/2...添加全文搜索功能入門/

1、使用的工具

• 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

2、配置說明

如今假設咱們的項目叫作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. 首先安裝各工具

pip install 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 }}">{{ 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的源碼。