Django中用haystack对接Elasticsearch来实现通过索引搜索

当用户在搜索框输入关键字进行搜索时，我们需要提供相关结果给用户

这种需求通过mysql中的模糊查询like可以实现，但是这种效率太慢，如果查询的字段多起来，更加耗时

此时我们可以借助Elasticsearch搜索殷勤来建立索引，提高查询效率

Elasticsearch

1-开源的 Elasticsearch 是目前全文搜索引擎的首选。

2-它可以快速地储存、搜索和分析海量数据。维基百科、Stack Overflow、Github 都采用它。

3-Elasticsearch 的底层是开源库 Lucene。但是，你没法直接用 Lucene，必须自己写代码去调用它的接口。Elastic 是
Lucene 的封装，提供了 REST API 的操作接口，开箱即用。

4- Elasticsearch 是用Java实现的

使用Docker安装Elasticsearch及其扩展

获取镜像，可以通过网络pull

docker image pull delron/elasticsearch-ik:2.4.6-1.0

或者加载下载成功的镜像文件

docker load -i elasticsearch-ik-2.4.6_docker.tar  # 相当于服务器

修改elasticsearch的配置文件 elasticsearc-2.4.6/config/elasticsearch.yml第54行，更改ip地址为本机ip地址

network.host: 本机IP地址

创建docker容器运行

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

使用haystack对接Elasticsearch

我们在django中可以通过使用haystack来调用Elasticsearch搜索引擎

1）安装

pip install drf-haystack

pip install elasticsearch==2.4.1  # 相当于客户端

drf-haystack是为了在REST
framework中使用haystack而进行的封装（如果在Django中使用haystack，则安装django-haystack即可）

2）注册应用

INSTALLED_APPS = [
    ...
    'haystack',
    ...
]

3）配置

在配置文件中配置haystack使用的搜索引擎后端

# Haystack
HAYSTACK_CONNECTIONS = {
    'default': {
        'ENGINE': 'haystack.backends.elasticsearch_backend.ElasticsearchSearchEngine',
        'URL': 'http://本机ip地址:9200/',  # 此处为elasticsearch运行的服务器ip地址，端口号固定为9200
        'INDEX_NAME': 'xxx',  # 指定elasticsearch建立的索引库的名称
    },
}
# 当数据发生添加、修改、删除数据时，自动生成索引
HAYSTACK_SIGNAL_PROCESSOR = 'haystack.signals.RealtimeSignalProcessor'

注意：

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

4）创建索引数据模型类

通过创建索引类，来指明让搜索引擎对哪些字段建立索引，也就是可以通过哪些字段的关键字来检索数据。

在子应用中新建search_indexes.py文件，用于存放索引类

# 创建索引数据模型类
class SKUIndex(indexes.SearchIndex, indexes.Indexable):
    # document=True:
    # 1-表示该字段为主要搜索查询的字段  2-表示该字段的索引值由模型类的多个字段组成
    # use_template:表示通过模板文件来指定该字段的索引由哪些模型字段组成
    text = indexes.CharField(document=True, use_template=True)

    # 单个模型字段组成的索引
    # model_attr="模型字段名":表示由什么模型字段建立索引
    id = indexes.IntegerField(model_attr='id')
    name = indexes.CharField(model_attr='name')
    price = indexes.CharField(model_attr='price')
    default_image_url = indexes.CharField(model_attr='default_image_url')
    comments = indexes.IntegerField(model_attr='comments')
    
    # 重写方法
    def get_model(self):
        """返回建立索引的模型类"""
        return SKU
    
    # 重写方法 返回可上架销售的商品信息
    def index_queryset(self, using=None):
        """返回要建立索引的数据查询集"""
        return self.get_model().objects.filter(is_launched=True)

在SKUIndex建立的字段，都可以借助haystack由elasticsearch搜索引擎查询。

其中text字段我们声明为document=True，表名该字段是主要进行关键字查询的字段，
该字段的索引值可以由多个数据库模型类字段组成，具体由哪些模型类字段组成，我们用use_template=True表示后续通过模板来指明。其他字段都是通过model_attr选项指明引用数据库模型类的特定字段。

在REST framework中，索引类的字段会作为查询结果返回数据的来源

6）在templates目录中创建text字段使用的模板文件

具体在templates/search/indexes/goods/sku_text.txt文件中定义

{{ object.name }}
{{ object.caption }}
{{ object.id }}

此模板指明当将关键词通过text参数名传递时，可以通过sku的name、caption、id来进行关键字索引查询。
7）手动生成初始索引

python manage.py rebuid_index

8）创建索引序列化器

在子应用/serializers.py中创建haystack序列化器

class SKUIndexSerializer(HaystackSerializer):
    """
    SKU索引结果数据序列化器
    """
    class Meta:
        index_classes = [SKUIndex]
        fields = ('text', 'id', 'name', 'price', 'default_image_url', 'comments')

注意fields属性的字段名与SKUIndex类的字段对应。
9）创建视图

在子应用/views.py中创建视图

from drf_haystack.viewsets import HaystackViewSet

class SKUSearchViewSet(HaystackViewSet):
    """
    SKU搜索
    """
    index_models = [SKU]  # 指定数据的查询范围

    serializer_class = SKUIndexSerializer  # 指定使用的序列化器

注意： 该视图会返回搜索结果的列表数据，所以如果可以为视图增加REST framework的分页功能。

10）定义路由

通过REST framework的router来定义路由

router = DefaultRouter()
router.register('skus/search', views.SKUSearchViewSet, base_name='skus_search')

...

urlpatterns += router.urls

END