Haystack入门教程

搜索是一个日益重要的话题。用户越来越依赖于搜索从噪声信息中分离和快速找到有用信息。此外，搜索搜索可以洞察那些东西是受欢迎的，改善网站上难以查找的东西。

为此，Haystack试图整合自定义搜索，使其尽可能简单的灵活和强大到足以处理更高级的用例。
Haystack是一个可重复的应用(也就是说，它值依赖与自身的代码，并只专注于搜索)，它很好地扮演着您控制的应用程序和第三方应用的角色（比如，django.contrib.*我们不用修改它的源代码）。

Haystack也是一个可插拔的后端（很像Django的数据库层），所以几乎你所有写的代码都可以在不同搜索引擎之间便捷切换。

这个教程假设你了解Django各主要部分（models/forms/views/settings/URLconfs）和典型案例使用。还有的更高级设置可用的快捷方式，以及钩，但是这些不会在这里覆盖。
作为示例的目的，我们会在简单的note应用上添加搜索功能。在myapp/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()

<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__unicode__</span><span class="hljs-params">(self)</span>:</span>
    <span class="hljs-keyword">return</span> self.title

最后，在使用Haystack之前，你需要从选择一个搜索后端开始。这里有一个安装搜索引擎的快速指南，稍后你会看到每一个引擎的官方说明。

安装

使用你最喜欢的Python包管理来从PyPI安装应用，例如。

pip install django-haystack

配置

添加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',
<span class="hljs-comment"># Added.</span>
<span class="hljs-string">'haystack'</span>,

<span class="hljs-comment"># Then your usual apps...</span>
<span class="hljs-string">'blog'</span>,

]

修改你的`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'),
    },
}

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

Simple

simple后台使用数据库本身基本的匹配。不建议在生成中使用，但他会返回结果。

HAYSTACK_CONNECTIONS = {
    'default': {
        'ENGINE': 'haystack.backends.simple_backend.SimpleEngine',
    },
}

处理数据

创建`SearchIndexes`

SearchIndexes对象是Haystack决定那些数据应该放入索引和处理流数据的方式。你可以把它们看作是Django的Models或Forms，它们是基于字段和数据操作/存储的。

你通常为你期望索引的每一个Model都创建一个唯一的SearchIndex。虽然你可以在不同的model中重复使用相同的SearchIndex，只要你小心的做并且字段名很规范。

为了建立SearchIndex，所有的都是indexes.SearchIndex和indexe.Indexable的子类。定义要存储数据的字段，定义get_model方法。

我们会在下面创建和Note模型对应的NoteIndex。这个代码通常在search_indexes.py中。尽管这不是必须的。这使得Haystack能自动的检测到它。NoteIndex应该看起来像：

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

<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">get_model</span><span class="hljs-params">(self)</span>:</span>
    <span class="hljs-keyword">return</span> Note

<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">index_queryset</span><span class="hljs-params">(self, using=None)</span>:</span>
    <span class="hljs-string">"""Used when the entire index for model is updated."""</span>
    <span class="hljs-keyword">return</span> self.get_model().objects.filter(pub_date__lte=datetime.datetime.now())

每个SerachIndex需要有一个（仅有一个）一个字段document=True.这个指示着Haystack和搜索引擎把那个字段作为主要的检索。

当你选择document=True字段时，它应该在你的SearchIndex类里面始终如一，以避免后端的混淆。一个便捷的命名是text。
在所有的样例中这个text字段名并没有什么特殊。它也可以是其他任何命名，你可以叫它pink_polka_dot也是没有关系的。只是简单便利的交做text。

另外，我们在text字段上提供了use_template=True。这允许我们使用一个数据模板（而不是容易出错的级联）来构建文档搜索引擎索引。你应该在模板目录下建立新的模板search/indexes/myapp/note_text.txt，并将下面内容放在里面。

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

此外，我们增加了其他字段（author和pub_date）。当我们提供额外的过滤选项的时候这是很有用的。来至Haystack的多个SearchField类能处理大多数的数据。

一个常见的主题是允许管理员用户在未来添加内容，而不马上在网站展示，直到未来某个时间点。我们特别自定义了index_queryset方法来防止未来的这些项添加到索引。

设置视图

添加`SearchView`到你的`URLconf`

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

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

这会拉取Haystack的默认URLconf，它由单独指向SearchView实例的URLconf组成。你可以通过传递几个关键参数或者完全重新它来改变这个类的行为。

搜索模板

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

{% extends 'base.html' %}

{% block content %}
<h2>Search</h2>

<span class="hljs-tag">&lt;<span class="hljs-name">form</span> <span class="hljs-attr">method</span>=<span class="hljs-string">"get"</span> <span class="hljs-attr">action</span>=<span class="hljs-string">"."</span>&gt;</span>
    <span class="hljs-tag">&lt;<span class="hljs-name">table</span>&gt;</span>
        {{ form.as_table }}
        <span class="hljs-tag">&lt;<span class="hljs-name">tr</span>&gt;</span>
            <span class="hljs-tag">&lt;<span class="hljs-name">td</span>&gt;</span>&amp;nbsp;<span class="hljs-tag">&lt;/<span class="hljs-name">td</span>&gt;</span>
            <span class="hljs-tag">&lt;<span class="hljs-name">td</span>&gt;</span>
                <span class="hljs-tag">&lt;<span class="hljs-name">input</span> <span class="hljs-attr">type</span>=<span class="hljs-string">"submit"</span> <span class="hljs-attr">value</span>=<span class="hljs-string">"Search"</span>&gt;</span>
            <span class="hljs-tag">&lt;/<span class="hljs-name">td</span>&gt;</span>
        <span class="hljs-tag">&lt;/<span class="hljs-name">tr</span>&gt;</span>
    <span class="hljs-tag">&lt;/<span class="hljs-name">table</span>&gt;</span>

    {% if query %}
        <span class="hljs-tag">&lt;<span class="hljs-name">h3</span>&gt;</span>Results<span class="hljs-tag">&lt;/<span class="hljs-name">h3</span>&gt;</span>

        {% for result in page.object_list %}
            <span class="hljs-tag">&lt;<span class="hljs-name">p</span>&gt;</span>
                <span class="hljs-tag">&lt;<span class="hljs-name">a</span> <span class="hljs-attr">href</span>=<span class="hljs-string">"{{ result.object.get_absolute_url }}"</span>&gt;</span>{{ result.object.title }}<span class="hljs-tag">&lt;/<span class="hljs-name">a</span>&gt;</span>
            <span class="hljs-tag">&lt;/<span class="hljs-name">p</span>&gt;</span>
        {% empty %}
            <span class="hljs-tag">&lt;<span class="hljs-name">p</span>&gt;</span>No results found.<span class="hljs-tag">&lt;/<span class="hljs-name">p</span>&gt;</span>
        {% endfor %}

        {% if page.has_previous or page.has_next %}
            <span class="hljs-tag">&lt;<span class="hljs-name">div</span>&gt;</span>
                {% if page.has_previous %}<span class="hljs-tag">&lt;<span class="hljs-name">a</span> <span class="hljs-attr">href</span>=<span class="hljs-string">"?q={{ query }}&amp;amp;page={{ page.previous_page_number }}"</span>&gt;</span>{% endif %}&amp;laquo; Previous{% if page.has_previous %}<span class="hljs-tag">&lt;/<span class="hljs-name">a</span>&gt;</span>{% endif %}
                |
                {% if page.has_next %}<span class="hljs-tag">&lt;<span class="hljs-name">a</span> <span class="hljs-attr">href</span>=<span class="hljs-string">"?q={{ query }}&amp;amp;page={{ page.next_page_number }}"</span>&gt;</span>{% endif %}Next &amp;raquo;{% if page.has_next %}<span class="hljs-tag">&lt;/<span class="hljs-name">a</span>&gt;</span>{% endif %}
            <span class="hljs-tag">&lt;/<span class="hljs-name">div</span>&gt;</span>
        {% endif %}
    {% else %}
        {# Show some example queries to run, maybe query syntax, something else? #}
    {% endif %}
<span class="hljs-tag">&lt;/<span class="hljs-name">form</span>&gt;</span>

{% endblock %}

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

重建索引

这是最后一步，现在你已经配置好了所有的事情，是时候把数据库中的数据放入索引了。Haystack附带的一个命令行管理工具使它变得很容易。

简单的运行./manage.py rebuild_index。你会得到有多少模型进行了处理并放进索引的统计。

使用标准的SearchIndex。你的索引内容只在你运行./manage.py update_index或重新开始./manage.py rebuild_index更新。

你应该把更新任务放在计划任务里面

另外，如果你只是低流量或者你的搜索引擎能处理，RealtimeSignalProcessor自动为你处理更新或删除。

完毕！

现在可以访问的查询区域，输入一个查询，然后检索出结果了！恭喜你！

下一步是什么？

这个教程仅仅触及了Haystack的表面，SearchQuerySet是Haystack搜索的支柱为其提供强大功能。QuerySet就像api(参考SearchQuerySet API).你能使用更加复杂的SearchForms/SearchViews，给用户更好的界面.和最佳实践提供了深入了解Haystack的不明显或高级用法.

Se More中文gitbook

      </div>
    </div>