全文检索：haystack+elasticsearch

Posted 2021-01-26 omak

优点：
1.查询速度快
2.支持中文分词
准备工作：安装es软件
1.拷贝到ubuntu
2.docker load -i 文件路径
3.配置
修改ip地址
4.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

1.安装
2.注册
3.配置，可以修改ip、库名称
4.建立索引类：可修改模型类、查询集
5.建立模板：search/indexes/应用名称/模型类小写_text.txt
6.定义可搜索的属性：{{object.属性名称}}
7.生成初始索引数据：python manage.py rebuild_index
8.定义序列化器：指定object使用的序列化器，object表示查询到的对象，当前为SKU对象
9.定义视图：指定模型类
10.调用查询

具体步骤

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

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

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

network.host: 自己机器的IP地址

创建docker容器运行（config文件的路径要改为自己本机的路径）

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

2）注册应用

INSTALLED_APPS = [
    ...
    ‘haystack‘,
]

3）配置

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

# Haystack
HAYSTACK_CONNECTIONS = {
    ‘default‘: {
        ‘ENGINE‘: ‘haystack.backends.elasticsearch_backend.ElasticsearchSearchEngine‘,
        # 端口号固定为9200
        ‘URL‘: ‘http://es的IP:9200/‘,
        # 指定elasticsearch建立的索引库的名称
        ‘INDEX_NAME‘: ‘meiduo_mall‘,
    },
}

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

4）创建索引类

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

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

from haystack import indexes

from .models import SKU


class SKUIndex(indexes.SearchIndex, indexes.Indexable):
    """
    SKU索引数据模型类
    """
    text = indexes.CharField(document=True, use_template=True)

    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表示后续通过模板来指明。

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

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

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

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

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

6）手动生成初始索引

python manage.py rebuild_index

7）创建序列化器

在goods/serializers.py中创建haystack序列化器

from drf_haystack.serializers import HaystackSerializer
from .search_indexes import SKUIndex

class SKUIndexSerializer(HaystackSerializer):
    """
    SKU索引结果数据序列化器
    """
    object = SKUSerializer(read_only=True)

    class Meta:
        index_classes = [SKUIndex]
        fields = (
            ‘text‘,  # 用于接收查询关键字
            ‘object‘  # 用于返回查询结果
        )

1. 下面的搜索视图使用SKUIndexSerializer序列化器用来检查前端传入的参数text，并且检索出数据后再使用这个序列化器返回给前端；

2. SKUIndexSerializer序列化器中的object字段是用来向前端返回数据时序列化的字段。

8）创建视图

在goods/views.py中创建视图

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

from drf_haystack.viewsets import HaystackViewSet
from .serializers import SKUIndexSerializer

class SKUSearchViewSet(HaystackViewSet):
    """
    SKU搜索
    """
    index_models = [SKU]

    serializer_class = SKUIndexSerializer
　　pagination_class = StandardResultsSetPagination

9）定义路由

在goods/urls.py中通过REST framework的router来定义路由

from rest_framework.routers import DefaultRouter

...

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

urlpatterns += router.urls

如果在配置完haystack并启动程序后，出现如下异常，是因为drf-haystack还没有适配最新版本的REST framework框架

可以通过修改REST framework框架代码，补充_get_count函数定义即可

文件路径 虚拟环境下的 lib/python3.6/site-packages/rest_framework/pagination.py

def _get_count(queryset):
    """
    Determine an object count, supporting either querysets or regular lists.
    """
    try:
        return queryset.count()
    except (AttributeError, TypeError):
        return len(queryset)

分页：

from rest_framework.pagination import PageNumberPagination


class StandardResultsSetPagination(PageNumberPagination):
    page_size = 2
    page_size_query_param = ‘page_size‘
    max_page_size = 20