Django + DRF + Elasticsearch 实现搜索功能

 

django使用haystack来调用Elasticsearch搜索引擎

 如何使用django来调用Elasticsearch实现全文的搜索

  Haystack为Django提供了模块化的搜索。它的特色是统一的,熟悉的API,可让你在不修改代码的状况下使用不一样的搜索后端(好比 Solr, Elasticsearch, Whoosh, Xapian 等等)。html

环境:django ==1.11.11python

1.首先安装相关的依赖包:(这里原做者使用的是drf-haystack,若是项目没有使用drf组件,应该选用haystack包)数据库

pip install drf-haystack pip install elasticsearch==2.4.1

# drf-haystack官方文档:https://drf-haystack.readthedocs.io/en/latest/django

2.在django项目配置文件settings.py中注册应用:后端

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

3.在django项目配置文件settings.py中指定搜索的后端:(指定使用那个搜索引擎,服务器地址的配置,索引库的名称等配置)api

# Haystack
HAYSTACK_CONNECTIONS = { 'default': { 'ENGINE': 'haystack.backends.elasticsearch_backend.ElasticsearchSearchEngine', # 指定使用 elasticsearch 为搜索引擎, 若是搜索内容包含中文, 须要将 elasticsearch 配置支持中文分词
        'URL': 'http://your_ip:9200/',  # 此处为elasticsearch运行的服务器ip地址,端口号默认为9200
     # elasticsearch创建的索引库的名称
     'INDEX_NAME': 'demo',
     # 保存索引文件的路径
     # 'PATH': os.path.join(BASE_DIR, 'elastic_index'), # 若是搜索引擎是whoosh, 还须要设置PATH参数
},
}
# 当添加、修改、删除数据时,自动生成索引
HAYSTACK_SIGNAL_PROCESSOR = 'haystack.signals.RealtimeSignalProcessor'

 # 指定搜索结果每页的条数 这里设置成了1条
 HAYSTACK_SEARCH_RESULTS_PER_PAGE = 1服务器

注意:框架

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

4.建立索引类:(在须要进行索引的应用的目录下建立文件search_indexes.py, 在该文件内建立该索引类,转载者注模块化

 

from haystack import indexes
from
.models import Demo
# 原做者在代码中没有给出模型代码,这个模型里拥有的字段就是须要提供搜索的字段,建议保留模型字段中自增的主键字段id, 在我实际项目开发中发现若是不保留就没法实现搜索 # 索引模型类的名称必须是 模型类名称 + Index
class DemoIndex(indexes.SearchIndex, indexes.Indexable): """ 索引数据模型类 """ text = indexes.CharField(document=True, use_template=True) # 通常此字段约定为text
   default_image_url = indexes.CharField(model_attr='default_image_url')
def get_model(self): """返回创建索引的模型类""" return Demomodel def index_queryset(self, using=None): """返回要创建索引的数据查询集""" return self.get_model().objects.filter(is_launched=True) """ 说明: 1.在DemoIndex创建的字段,均可以借助haystack由elasticsearch搜索引擎查询。 2.其中text字段声明为document=True,表名该字段是主要进行关键字查询的字段, 该字段的索引值能够由多个数据库模型类字段组成(是多个字段,不是多个数据库模型类,转者注),具体由哪些模型类字段组成,咱们用use_template=True表示后续经过模板来指明,其余字段都是经过model_attr选项指明引用数据库模型类的特定字段。 3.在 REST framework中,索引类的字段会做为查询结果返回数据的来源, """

5. 在templates目录中建立text字段使用的模板文件:

templates/search/indexes/demo/demo_text.txt文件中定义

(关于路径的定义和文件的命名的说明:templates是项目原来的html文件的目录,search是在其下新建的,名称必定,indexes名称也必定,demo是应用的名称,demo_text.txt 就是须要进行索引的模型类名的小写 + "_" + 索引类中定义的字段名称(text) + ".txt" 转载者注)

在demo_text.txt文件中 指定为模型类中那些字段创建索引

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

而后使用命令手动建立索引:

  进入manage.py所在的目录执行命令:

    python manage.py rebuild_index

 

6.建立haystack序列化器:(返回查询到的查询集数据)

from drf_haystack.serializers import HaystackSerializer class DemoSerializer(serializers.ModelSerializer): """ 序列化器 """
    class Meta: model = Demo 
     # 返回除了搜索字段外的所须要的其余字段数据, 能够将全部须要返回的字段数据写上,便于提取 fields
= ('id', 'name') class DemoIndexSerializer(HaystackSerializer): """ SKU索引结果数据序列化器 """
   # 变量名称必须为 object 不然没法返回 object = DemoSerializer(read_only=True)# 只读,不能够进行反序列化 class Meta: index_classes = [DemoIndex] # 索引类的名称,能够有多个
     
# text 由索引类进行返回, object 由序列化类进行返回,第一个参数必须是text
fields = ('text', object, 'default_image_url')

注意:fields属性的字段名与DemoIndex类的字段对应。

 

7.建立视图

from drf_haystack.viewsets import HaystackViewSet class DemoSearchViewSet(HaystackViewSet):
  index_models
= [Demo]#这里能够写入多个已经进行了索引的模型类
  
  serializer_class = DemoIndexSerializer
  # 这里是经过父类默认的方法进行返回了数据, 能够在视图中对数据进行筛选和处理,详细的使用方法能够去查看官方文档,drf-haystack官方文档:https://drf-haystack.readthedocs.io/en/latest/
  • 该视图会返回搜索结果的列表数据,因此若是能够为视图增长REST framework的分页功能。
  • 咱们在配置文件已经定义了分页配置,因此此搜索视图会进行分页。

8. 添加路由,使用经过REST framework的router来定义路由

router = DefaultRouter() router.register('/', views.DemoSearchViewSet, base_name='demo_search') ... urlpatterns += router.urls

9.测试

http://127.0.0.1:8000/?text=something

若是在配置完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)

原文地址:  http://www.cnblogs.com/x931890193/p/9385312.html

相关文章
相关标签/搜索