Django集成搜索引擎Elasticserach的方法示例
1.背景
当用户在搜索框输入关键字后,我们要为用户提供相关的搜索结果。可以选择使用模糊查询like关键字实现,但是like关键字的效率极低。查询需要在多个字段中进行,使用like关键字也不方便,另外分词的效果也不理想。
全文检索方案
- 全文检索即在指定的任意字段中进行检索查询。
- 全文检索方案需要配合搜索引擎来实现。
搜索引擎原理
- 搜索引擎进行全文检索时,会对数据库中的数据进行一遍预处理,单独建立起一份索引结构数据。
- 索引结构数据类似字典的索引检索页,里面包含了关键词与词条的对应关系,并记录词条的位置。
- 搜索引擎进行全文检索时,将关键字在索引数据中进行快速对比查找,进而找到数据的真实存储位置。
2.Elasticsearch介绍
实现全文检索的搜索引擎,首选的是Elasticsearch。
- Elasticsearch是用Java实现的,开源的搜索引擎。
- 它可以快速地储存、搜索和分析海量数据。维基百科、StackOverflow、Github等都采用它。
- Elasticsearch的底层是开源库Lucene。但是,没法直接使用Lucene,必须自己写代码去调用它的接口。
分词说明
搜索引擎在对数据构建索引时,需要进行分词处理。
分词是指将一句话拆解成多个单字或词,这些字或词便是这句话的关键词。
Elasticsearch不支持对中文进行分词建立索引,需要配合扩展elasticsearch-analysis-ik来实现中文分词处理。
3.集成Elasticsearch
3.1.Haystack介绍和安装配置
- Haystack是在Django中对接搜索引擎的框架,搭建了用户和搜索引擎之间的沟通桥梁。
- 我们在Django中可以通过使用Haystack来调用Elasticsearch搜索引擎。
- Haystack可以在不修改代码的情况下使用不同的搜索后端(比如Elasticsearch、Whoosh、Solr等等)。
Haystack安装
$pipinstalldjango-haystack $pipinstallelasticsearch==2.4.1
Haystack注册应用和路由
在django的配置文件中注册。
INSTALLED_APPS=['haystack',#全文检索注册]
在总路由中新建haystack的路由。
urlpatterns=[url(r'^search/',include('haystack.urls')),]
Haystack配置
在配置文件中配置Haystack为搜索引擎后端
#Haystack HAYSTACK_CONNECTIONS={ 'default':{ 'ENGINE':'haystack.backends.elasticsearch_backend.ElasticsearchSearchEngine', 'URL':'http://192.168.103.158:9200/',#Elasticsearch服务器ip地址,端口号固定为9200 'INDEX_NAME':'serach_mall',#Elasticsearch建立的索引库的名称 }, } #当添加、修改、删除数据时,自动生成索引 HAYSTACK_SIGNAL_PROCESSOR='haystack.signals.RealtimeSignalProcessor' #搜索的每页大小 HAYSTACK_SEARCH_RESULTS_PER_PAGE=3
HAYSTACK_SIGNAL_PROCESSOR配置项保证了在Django运行起来后,有新的数据产生时,Haystack仍然可以让Elasticsearch实时生成新数据的索引。
3.2Haystack建立数据索引
1.创建索引类
通过创建索引类,来指明让搜索引擎对哪些字段建立索引,也就是可以通过哪些字段的关键字来检索数据。
本项目中对模型类SKU信息进行全文检索,所以在该模型类的应用(goods)中新建search_indexes.py文件,用于存放索引类。索引类必须继承haystack.indexes.SearchIndex与haystack.indexes.Indexable.
fromhaystackimportindexes from.modelsimportSKU classSKUIndex(indexes.SearchIndex,indexes.Indexable): """SKU索引数据模型类""" text=indexes.CharField(document=True,use_template=True) defget_model(self): """返回建立索引的模型类""" returnSKU defindex_queryset(self,using=None): """返回要建立索引的数据查询集""" returnself.get_model().objects.filter(is_launched=True)
索引类SKUIndex说明:
- 在SKUIndex建立的字段,都可以借助Haystack由Elasticsearch搜索引擎查询。
- 其中text字段我们声明为document=True,表名该字段是主要进行关键字查询的字段。
- text字段的索引值可以由多个数据库模型类字段组成,具体由哪些模型类字段组成,我们用use_template=True表示后续通过模板来指明。
2.创建text字段索引值模板文件
在项目templates目录中创建text字段使用的模板文件
具体在templates/search/indexes/goods/sku_text.txt文件中定义,其中goods为应用名,sku_text.txt中的sku为模型类小写。
{{object.id}} {{object.name}} {{object.caption}}
模板文件说明:当将关键词通过text参数名传递时
此模板指明SKU的id、name、caption作为text字段的索引值来进行关键字索引查询。
3.手动生成初始索引
$pythonmanage.pyrebuild_index
第一次需要生成索引需要执行上述命令,后续会自动生成索引。
3.3全文检索测试
准备测试表单
- 请求方法:GET
- 请求地址:/search/
- 请求参数:q
... ...
然后在templates/search/目录下新建search.html接收和渲染全文检索的结果.
3.4渲染搜索结果
Haystack返回的数据包括:
- query:搜索关键字
- paginator:分页paginator对象
- page:当前页的page对象(遍历page中的对象,可以得到result对象)
- result.objects:当前遍历出来的SKU对象。
{%forresultinpage%} {#object取得才是sku对象#}
{{result.object.name}} ¥{{result.object.price}} {{result.object.comments}}评价
没有找到您要查询的商品。
{%endfor%}