drf_haystack_elasticsearch完整应用示例

1.使用 Docker 安装 Elasticsearch

1.获取Elasticsearch-ik镜像

在命令行中添加如下命令:

# 从仓库拉取镜像
sudo docker image pull delron/elasticsearch-ik:2.4.6-1.0

# 或者是: 
# 解压教学资料中本地镜像
sudo docker load -i elasticsearch-ik-2.4.6_docker.tar

2.配置 Elasticsearch-ik
将教学资料中的elasticsearc-2.4.6目录拷贝到home目录下。
修改/home/elasticsearc-2.4.6/config/elasticsearch.yml第54行。
更改 ip 地址为本机真实 ip 地址。

3.使用 Docker 运行 Elasticsearch-ik

sudo docker run -dti --name=elasticsearch --network=host -v /home/elasticsearch-2.4.6/config:/usr/elasticsearch/config delron/elasticsearch-ik:2.4.6-1.0

2. Haystack 介绍和安装配置

1.Haystack 介绍

Haystack 是在 Django 中对接搜索引擎的框架，搭建了用户和搜索引擎之间的沟通桥梁。
我们在 Django 中可以通过使用 Haystack 来调用 Elasticsearch 搜索引擎。
Haystack 可以在不修改代码的情况下使用不同的搜索后端（比如 Elasticsearch、Whoosh、Solr等等）。
2.Haystack 安装

# 联网安装haystack和elasticsearch

pip install django-haystack

pip install elasticsearch==2.4.1

3.Haystack 注册应用

INSTALLED_APPS = [
     # 全文检索
    'haystack', 
]

4.Haystack 配置

在配置文件中配置 Haystack 为搜索引擎后端

# Haystack
HAYSTACK_CONNECTIONS = {
    'default': {
        'ENGINE': 'haystack.backends.elasticsearch_backend.ElasticsearchSearchEngine',
        'URL': 'http://172.16.238.128:9200/', # Elasticsearch服务器ip地址，端口号固定为9200
        'INDEX_NAME': 'meiduo_mall', # Elasticsearch建立的索引库的名称
    },
}

# 当添加、修改、删除数据时，自动生成索引
HAYSTACK_SIGNAL_PROCESSOR = 'haystack.signals.RealtimeSignalProcessor'

重要提示：

HAYSTACK_SIGNAL_PROCESSOR 配置项保证了在 Django 运行起来后，有新的数据产生时，Haystack 仍然可以让 Elasticsearch 实时生成新数据的索引

2. Haystack 建立数据索引
3. 1.创建索引类

通过创建索引类，来指明让搜索引擎对哪些字段建立索引，也就是可以通过哪些字段的关键字来检索数据。
本项目中对 模型类中的信息进行全文检索，所以在 子应用 应用中新建 search_indexes.py 文件，用于存放索引类。

from haystack import indexes
from Headlines.models import Article


class ArticleIndex(indexes.SearchIndex, indexes.Indexable):
    """文章索引模型类"""
    text = indexes.CharField(document=True, use_template=True)
    id = indexes.IntegerField(model_attr='id')
    createtime = indexes.DateTimeField(model_attr='createtime')
    content = indexes.CharField(model_attr='content')
    title = indexes.CharField(model_attr='title')

    def get_model(self):
        """返回建立索引的模型类"""
        return Article

    def index_queryset(self, using=None):
        """返回要建立索引的数据查询集"""
        return self.get_model().objects.all()

索引类 SKUIndex 说明：
在 SKUIndex 建立的字段，都可以借助 Haystack 由 Elasticsearch 搜索引擎查询。
其中 text 字段我们声明为 document=True，表名该字段是主要进行关键字查询的字段。
text字段的索引值可以由多个数据库模型类字段组成，具体由哪些模型类字段组成，我们用 use_template=True 表示后续通过模板来指明。

2.创建 text 字段索引值模板文件
在 templates 目录中创建 text 字段使用的模板文件
具体在 templates/search/indexes/Headlines/article_text.txt 文件中定义

{{ object.id }}
{{ object.title }}
{{ object.channel }}
{{ object.labels }}
{{ object.content }}

模板文件说明：当将关键词通过text参数名传递时
此模板指明 SKU 的id、name、caption作为text字段的索引值来进行关键字索引查询。

3.手动生成初始索引
在命令行中添加如下命令, 来手动生成索引表:

python manage.py rebuild_index

4. 添加后端逻辑
   views.py

from drf_haystack.viewsets import HaystackViewSet
# 搜索文章
class SearchArticleViewSet(HaystackViewSet):
    # GET  /Headlines/search/?text=<搜索关键字>
    # 这里可以写多个模型，相应的：serializer里也可以写多个index_classes
    index_models = [Article]
    serializer_class = SearchArticleIndexSerializer

serializers.py

from drf_haystack import serializers as HSER
# 搜索文章
class SearchArticleIndexSerializer(HSER.HaystackSerializer):

    class Meta:
        index_classes = [ArticleIndex]  # 索引类的名称,可以有多个
        fields = ('text', 'content', 'id', 'title', 'createtime')

urls.py

# 搜索文章路由
from rest_framework.routers import DefaultRouter
from Headlines.views import SearchArticleViewSet

router = DefaultRouter()
router.register(r'Headlines/search', SearchArticleViewSet, base_name='search')
urlpatterns += router.urls