二十四、搜索引擎功能实现（商品部分）

1、搜索引擎的配置

<1>用Docker安装Elasticsearch及其扩展

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

sudo docker image pull delron/elasticsearch-ik:2.4.6-1.0
# 或者加载提供给大家的镜像文件
sudo docker load -i elasticsearch-ik-2.4.6_docker.tar

• 将资料中的elasticsearch的配置文件复制到用户家目录，修改elasticsearch的配置文件 ~/elasticsearc-2.4.6/config/elasticsearch.yml第54行，更改ip地址为本机ip地址

network.host: 192.168.254.145

• 创建docker容器运行

sudo 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

2、使用haystack对接Elasticsearch

Haystack为Django提供了模块化的搜索。它的特点是统一的，熟悉的API，可以让你在不修改代码的情况下使用不同的搜索后端（比如 Solr, Elasticsearch, Whoosh, Xapian 等等）。我们在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://192.168.254.145:9200/',  # 此处为elasticsearch运行的服务器ip地址，端口号固定为9200
        'INDEX_NAME': 'meiduo',  # 指定elasticsearch建立的索引库的名称
    },
}

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

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

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

1>在SKUIndex建立的字段，都可以借助haystack由elasticsearch搜索引擎查询。
2>其中text字段我们声明为document=True，表明该字段是主要进行关键字查询的字段， 该字段的索引值可以由多个数据库模型类字段组成，具体由哪些模型类字段组成，我们用use_template=True表示后续通过模板来指明。
3>在REST framework中，索引类的字段会作为查询结果返回数据的来源。

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

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

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

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

<6>手动生成初始索引

python manage.py rebuild_index

<7>创建序列化器

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

from drf_haystack.serializers import HaystackSerializer
from rest_framework import serializers
from goods.models import SKU
from goods.search_indexes import SKUIndex


class CategoryListSerializers(serializers.ModelSerializer):

    class Meta:
        model = SKU
        fields = "__all__"


class SKUSearchSeriazliers(HaystackSerializer):
    object = CategoryListSerializers()  # SKU商品数据对象序列化返回

    class Meta:
        index_classes = [SKUIndex]
        fields = ('text', 'object')

说明：
1>下面的搜索视图使用SKUIndexSerializer序列化器用来检查前端传入的参数text，并且检索出数据后再使用这个序列化器返回给前端；
2>SKUIndexSerializer序列化器中的object字段是用来向前端返回数据时序列化的字段。

  Haystack通过Elasticsearch检索出匹配关键词的搜索结果后，还会在数据库中取出完整的数据库模型类对象，放到搜索结果的object属性中，并将结果通过SKUIndexSerializer序列化器进行序列化。所以我们可以通过声明搜索结果的object字段以CategoryListSerializers序列化的形式进行处理，明确要返回的搜索结果中每个数据对象包含哪些字段。如，通过上面两个序列化器，最终的返回结果形式如下：

[
    {
        "text": "华为 HUAWEI P10 Plus 6GB+128GB 钻雕蓝 移动联通电信4G手机 双卡双待\nwifi双天线设计！徕卡人像摄影！P10徕卡双摄拍照，低至2988元！\n11",
        "object": {
            "id": 11,
            "name": "华为 HUAWEI P10 Plus 6GB+128GB 钻雕蓝 移动联通电信4G手机 双卡双待",
            "price": "3788.00",
            "default_image_url": "http://image.meiduo.site:8888/group1/M00/00/02/CtM3BVrRdG6AYdapAAcPaeOqMpA1594598",
            "comments": 2
        }
    },
    {
        "text": "华为 HUAWEI P10 Plus 6GB+128GB 玫瑰金 移动联通电信4G手机 双卡双待\nwifi双天线设计！徕卡人像摄影！P10徕卡双摄拍照，低至2988元！\n14",
        "object": {
            "id": 14,
            "name": "华为 HUAWEI P10 Plus 6GB+128GB 玫瑰金 移动联通电信4G手机 双卡双待",
            "price": "3788.00",
            "default_image_url": "http://image.meiduo.site:8888/group1/M00/00/02/CtM3BVrRdMSAaDUtAAVslh9vkK04466364",
            "comments": 1
        }
    }
]

<8>创建视图

在goods/views.py中创建视图

from drf_haystack.viewsets import HaystackViewSet
from goods.models import GoodsCategory, SKU
from goods.serializers import SKUSearchSeriazliers


class SKUSearchViewSet(HaystackViewSet):
    index_models = [SKU]
    pagination_class = PageNum  # 分页属性
    serializer_class = SKUSearchSeriazliers

注意：
该视图会返回搜索结果的列表数据，所以如果可以为视图增加REST framework的分页功能。
我们在实现商品列表页面时已经定义了全局的分页配置，所以此搜索视图会使用全局的分页配置。

返回的数据举例如下：

{
    "count": 10,
    "next": "http://api.meiduo.site:8000/skus/search/?page=2&text=%E5%8D%8E",
    "previous": null,
    "results": [
        {
            "text": "华为 HUAWEI P10 Plus 6GB+64GB 钻雕金 移动联通电信4G手机 双卡双待\nwifi双天线设计！徕卡人像摄影！P10徕卡双摄拍照，低至2988元！\n9",
            "id": 9,
            "name": "华为 HUAWEI P10 Plus 6GB+64GB 钻雕金 移动联通电信4G手机 双卡双待",
            "price": "3388.00",
            "default_image_url": "http://10.211.55.5:8888/group1/M00/00/02/CtM3BVrRcUeAHp9pAARfIK95am88523545",
            "comments": 0
        },
        {
            "text": "华为 HUAWEI P10 Plus 6GB+128GB 钻雕金 移动联通电信4G手机 双卡双待\nwifi双天线设计！徕卡人像摄影！P10徕卡双摄拍照，低至2988元！\n10",
            "id": 10,
            "name": "华为 HUAWEI P10 Plus 6GB+128GB 钻雕金 移动联通电信4G手机 双卡双待",
            "price": "3788.00",
            "default_image_url": "http://10.211.55.5:8888/group1/M00/00/02/CtM3BVrRchWAMc8rAARfIK95am88158618",
            "comments": 5
        }
    ]
}

<9>定义路由

通过REST framework的router来定义路由

from django.conf.urls import url
from rest_framework.routers import DefaultRouter
from goods import views
...
router = DefaultRouter()
router.register("skus/search", views.SKUSearchViewSet,base_name="sku_search")
urlpatterns += router.urls

<10>测试

我们可以GET方法访问如下链接进行测试

http://api.meiduo.site:8000/skus/search/?text=wifi

3、bug说明：

• 如果在配置完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)