haystack+whoosh

haystack: 全文检索框架(对检索引擎包装下，抹掉差异 提供统一接口，方便码农)。该框架支持Elasticsearch,Whoosh, Xapian，Solr搜索引擎。
Elasticsearch：据说是java写的。Elastic(有弹性的，灵活 可伸展的)，大概说明其 操作的灵活性。
Xapian: apian蜜蜂，X apian，大概使用蜜蜂的嗅探能力，来说明其搜索范围之广。

whoosh：检索引擎。(单词原意：飞快的移动。大概是说 其检索的速度很快，咻的一下 就找到了)

检索引擎(whoosh)的作用: 对 表中的某些字段 进行 关键词分析，在 关键词 和 表中其它记录s 之间 建立联系(索引表)。

---

1. 安装django-haystack, whoosh, jieba(切换到项目目录下)

$ cd ~/PycharmProjects/dailyfresh
$ pip install whoosh 
$ pip install django-haystack
$ pip install jieba 

2. 在Django项目的settings.py里面的INSTALLED_APPS添加Haystack

add 'haystack' to INSTALLED_APPS

3. 修改settings.py文件, 配置引擎

配置haystack使用什么引擎，以及配置检索文件的存放路径

# 配置 全文检索框架(haystack)使用 检索引擎(whoosh)
HAYSTACK_CONNECTIONS = {
    'default': {
        # 使用whoosh引擎
        # haystack 通过 下面路径 中的 WhooshEngine类，来使用whoosh检索引擎
        # WhooshEngine的路径 venv/lib/site-packages/haystack/backends/whoosh_backend.py WhooshEngine类
        'ENGINE': 'haystack.backends.whoosh_backend.WhooshEngine',
        # 索引文件的 存放路径，所有的 索引文件 都存放在 该目录下。生成索引文件时，自动 在目录(BASE_DIR)下 创建目录(whoosh_index)
        'PATH': os.path.join(BASE_DIR, 'whoosh_index'),
    }
}

# 检索引擎(whoosh)的作用: 对 表中的某些字段 进行 关键词分析，在 关键词 和 表中其它记录s 之间 建立联系(索引表)
# 表中 字段内容 发生变化时，索引 也应发生变化 来适应 字段内容的变化。

# 当表中数据 发生变化(添加 删除 修改)时，自动生成 新的索引(替换 旧的索引)
HAYSTACK_SIGNAL_PROCESSOR = 'haystack.signals.RealtimeSignalProcessor'

4. 对某个django的app创建索引

在goods应用 目录下面建立search_indexes.py文件，文件名不能更改。(goods是你某个app的名称，可替换为 具体的app名称)
在search_indexes.py文件中，只需更改3处地方：
1）导入 需要建立索引的模型类(GoodsSKU)
2）索引类的名称（命名规则：模型类+Index）
3）get_model返回的 模型类(改为 你想建立索引的模型类)

# 定义索引类

from haystack import indexes

# 导入模型类
from apps.goods.models import GoodsSKU



# 对某个类的 某些数据 建立索引
# 索引类 类名 的格式：模型类名+Index
class GoodsSKUIndex(indexes.SearchIndex, indexes.Indexable):
    # text: 索引字段。document=True: 指定 该text为 索引字段。
    # use_template=True 指定 对表中的哪些字段进行关键词分析 建立索引文件。对字段的说明，是 放在一个文件中的。
    text = indexes.CharField(document=True, use_template=True)

    def get_model(self):
        # 返回 需要检索的 模型类
        return GoodsSKU

    # 返回 数据。对该数据 建立索引。
    def index_queryset(self, using=None):
        return self.get_model().objects.all()

5. 对哪些字段建立索引

创建目录templates/search/indexes/goods/，在templates/search/indexes/goods/目录下, 新建文件goodssku_text.txt。(goods为 APP名。goodssku为模型名，并且 全部 改为小写。模型名的 后缀_text.txt，不能更改)

# object代表 GoodsSKU模型名,
# 因为文件名已经指定了 模型类的路径和名称
# name, desc, goods, detail为字段名
# 根据表中的哪些字段 建立 索引数据

{{ object.name }}   # 根据商品的名称name 建立索引
{{ object.desc }}   #          简介desc 建立索引
{{ object.goods.detail }}   # 根据商品的详情detail 建立索引(详情在spu表中)

6. 命令生成索引文件

在项目目录下，执行命令：

$ python manage.py rebuild_index

如果成功生成索引文件，会在项目的根目录下，出现下图中的目录和文件。

成功生成索引文件 图

7. 添加 搜索框的表单，并设置

在templates/base.html中 添加搜索框表单。
form表单的method=‘get'不能改变，搜索栏的文本框的name="q"也是固定不变的。
action是 表单的 提交地址，对搜索的处理 交由 搜索引擎 进行处理。对表单action的配置，表单地址的配置 可随意更改，但是需要与项目目录下urls.py中的 全文检索框架的url配置 一致。

    

        {# 下面form表单的method 是'get'不能改变，搜索栏的文本框的name="q" 也是固定不变的 #}
        {# action 表单的 提交地址，对搜索的处理 交由 搜索引擎 进行处理 #}
        

            
            
        

    

8. 配置全文检索的url

在项目目录下urls.py中，添加 全文检索框架的url配置(url地址 要和 表单action地址 一致)

re_path(r'^search', include('haystack.urls')),  # 全文检索框架

9. 全文检索搜索过程

搜索到结果后，haystack会把搜索出来的结果 传递给 templates/search目录下的search.html, 传递的上下文 有：

haystack会对搜索的结果数据 进行分页，并把 当前页的page对象 传递给search.html。

• query: 搜索关键字.
• page: 当前页的page对象。遍历page对象，获取到的是SearchResult类的 实例对象，该对象的object属性 才是模型类的对象.page对象的object属性包含模型类的对象，这些模型类的对象是 搜索的结果。
• paginator: 当前分页的pagenitor对象.
  通过HAYSTACK_SEARCH_RESULTS_PER_PAGE 可以控制 每页显示搜索结果的数量。

10. 更改whoosh引擎 使用的 关键词分析 类

1）安装jieba
在项目目录下

pip install jieba

2. 更改whoosh默认的 关键词分析类

找到项目虚拟环境下haystack目录(venv/lib/python3.6/site-packages/haystack/backends/)。
在该目录下 新建文件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()

更改whoosh_backend.py中的词语分析类：

# 复制whoosh_backend.py并改名为whoosh_cn_backend.py
$ cp whoosh_backend.py whoosh_cn_backend.py

$ vi whoosh_cn_backend.py
# 添加from .ChineseAnalyzer import ChineseAnalyzer一行，导入ChineseAnalyzer方法

# 命令行模式搜索StemmingAnalyzer(), 将其修改为ChineseAnalyzer()

# :wq

更改settings.py中的 HAYSTACK_CONNECTIONS配置, 使其使用whoosh_cn_backend

# 配置 全文检索框架(haystack)使用 检索引擎(whoosh)
HAYSTACK_CONNECTIONS = {
    'default': {
        # 使用whoosh引擎
        # haystack 通过 下面路径 中的 WhooshEngine类，来使用whoosh检索引擎
        # WhooshEngine的路径 venv/lib/site-packages/haystack/backends/whoosh_backend.py WhooshEngine类
        # 'ENGINE': 'haystack.backends.whoosh_backend.WhooshEngine',
        'ENGINE': 'haystack.backends.whoosh_cn_backend.WhooshEngine',
        # 索引文件的 存放路径，所有的 索引文件 都存放在 该目录下。生成索引文件时，自动 在目录(BASE_DIR)下 创建目录(whoosh_index)
        'PATH': os.path.join(BASE_DIR, 'whoosh_index'),
    }
}

# 检索引擎(whoosh)的作用: 对 表中的某些字段 进行 关键词分析，在 关键词 和 表中其它记录s 之间 建立联系(索引表)

11. 重新生成索引文件

切换到项目目录下

$ python manage.py rebuild_index