Django集成Elasticsearch实现商品搜索:从Docker部署到DRF-Haystack配置详解
本文详细讲解如何在Django项目中集成Elasticsearch搜索引擎。内容涵盖通过Docker安装配置Elasticsearch及IK分词器,利用Haystack和drf-haystack封装REST framework接口。重点阐述索引类定义、模板配置、序列化器与视图集的开发,并解决drf-haystack与新版REST framework兼容性问题,提供完整的代码示例与配置指南。
Docker部署Elasticsearch
第一步,利用Docker环境安装Elasticsearch及其相关扩展插件,为后续搜索功能提供底层支持。
首先尝试从网络仓库拉取所需的镜像文件。
sudo docker image pull delron/elasticsearch-ik:2.4.6-1.0
若网络受限,也可通过本地加载镜像文件的方式完成安装。
sudo docker load -i elasticsearch-ik-2.4.6_docker.tar
接下来需要修改Elasticsearch的配置文件,具体操作是编辑 elasticsearc-2.4.6/config/elasticsearch.yml 文件的第54行,将 network.host 的值更改为本机的IP地址。
network.host: 127.0.0.1
配置完成后,创建并启动Docker容器以运行Elasticsearch服务。
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
Haystack对接Elasticsearch配置
第二步,使用Haystack库对接Elasticsearch,以便在Django项目中调用搜索功能。
首先进行必要的库安装。
pip install drf-haystack
pip install elasticsearch==2.4.1
需要注意的是,drf-haystack是专为在Django REST framework中集成haystack而设计的封装库;若仅在普通Django项目中使用haystack,则只需安装 django-haystack 即可。
安装完成后,需在Django项目的设置文件中注册haystack应用。
INSTALLED_APPS = [
...
'haystack',
...
]
随后进行具体的参数配置。
在项目的配置文件中指定haystack所使用的搜索引擎后端,确保其能正确连接Elasticsearch。
# Haystack
HAYSTACK_CONNECTIONS = {
'default': {
'ENGINE': 'haystack.backends.elasticsearch_backend.ElasticsearchSearchEngine',
'URL': 'http://127.0.0.1:9200/', # 此处为elasticsearch运行的服务器ip地址,端口号固定为9200
'INDEX_NAME': 'meiduo', # 指定elasticsearch建立的索引库的名称
},
}
# 当添加、修改、删除数据时,自动生成索引
HAYSTACK_SIGNAL_PROCESSOR = 'haystack.signals.RealtimeSignalProcessor'
接下来需要创建索引类,用于定义搜索引擎对哪些数据字段建立索引。
核心任务是明确指定让搜索引擎对哪些字段建立索引,以便进行高效检索。
在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)
在索引类中,设置 document=True 表示该字段是主要进行关键字查询的目标字段。
设置 use_template=True 表示通过模板文件来动态指明索引值由哪些模型类字段组合而成。
第五步,在 templates 目录中创建用于 text 字段的模板文件。
具体路径为在 templates/search/indexes/goods/sku_text.txt 文件中定义索引模板内容。
{{ object.name }}
{{ object.caption }}
{{ object.id }}
文件路径遵循固定规则:templates/search/indexes/建立索引的应用名/文件名.txt。
通过配置模板,利用SKU模型的name、caption以及id字段来进行关键字索引查询。
第六步,手动生成初始索引数据。
python manage.py rebuild_index
第七步,创建用于处理搜索结果的序列化器。
在 goods/serializers.py 文件中创建基于haystack的序列化器类。
from drf_haystack.serializers import HaystackSerializer
class SKUIndexSerializer(HaystackSerializer):
"""
SKU索引结果数据序列化器
"""
object = SKUSerializer(read_only=True)
class Meta:
index_classes = [SKUIndex]
fields = ('text', 'object')
这里需要特别说明序列化器的作用。
使用 SKUIndexSerializer 序列化器主要用来检查前端传入的 text 参数,并在检索出数据后,利用该序列化器将结果返回给前端。
在 SKUIndexSerializer 序列化器中,object 字段用于指定向前端返回数据时序列化的具体对象字段。
第八步,创建处理搜索请求的视图。
在 goods/views.py 文件中定义具体的搜索视图逻辑。
from drf_haystack.viewsets import HaystackViewSet
class SKUSearchViewSet(HaystackViewSet):
"""
SKU搜索
"""
index_models = [SKU]
serializer_class = SKUIndexSerializer
第九步,定义访问路由。
利用REST framework提供的router机制来注册并定义搜索接口路由。
router = DefaultRouter()
router.register('skus/search', views.SKUSearchViewSet, base_name='skus_search')
urlpatterns += router.urls
常见问题与解决方案
在此提供一个常见Bug的解决方案说明。
如果在配置完haystack并启动程序后,遇到如下异常报错,这通常是因为当前版本的drf-haystack尚未完全适配最新版本的REST framework框架。
importError: cannot import name '_get_count'
解决方法是手动修改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)
以上即为Django项目集成Elasticsearch搜索引擎的完整实例教程,希望能为读者提供有价值的参考,欢迎继续支持本站获取更多技术分享。
本站声明
本文内容仅供参考,不代表本站观点。转载或引用请注明出处。如发现内容问题,请通过联系我们页面反馈。













