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

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

　　Haystack为Django提供了模块化的搜索。它的特点是统一的，熟悉的API，可以让你在不修改代码的情况下使用不同的搜索后端（比如 Solr, Elasticsearch, Whoosh, Xapian 等等）。

环境:django ==1.11.11

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

pip install drf-haystack
pip install elasticsearch==2.4.1

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

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

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

# Haystack
HAYSTACK_CONNECTIONS = {
    'default': {
        'ENGINE': 'haystack.backends.elasticsearch_backend.ElasticsearchSearchEngine', # 指定使用elasticsearch 为搜索引擎
        'URL': 'http://your_ip:9200/',  # 此处为elasticsearch运行的服务器ip地址，端口号固定为9200
　　　　　# 指定elasticsearch建立的索引库的名称,elastic search 会建立一个非关系型的数据库,这个名称可以根据需要自行确定,但是不能和服务器上已有的库名冲突
　　　　　'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

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

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

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

from drf_haystack.serializers import HaystackSerializer

class DemoSerializer(serializers.ModelSerializer):
    """
    序列化器
    """
    class Meta:
        model = Demo 
        fields = ('id', 'name')

class DemoIndexSerializer(HaystackSerializer):
    """
    SKU索引结果数据序列化器
    """
    data_obj = DemoSerializer(read_only=True)# 只读,不可以进行反序列化

    class Meta:
        index_classes = [DemoIndex] # 索引类的名称,可以有多个
        fields = ('text', 'data_obj') # text 由索引类进行返回, data_obj 由序列化类进行返回

7.创建视图

from drf_haystack.viewsets import HaystackViewSet

class DemoSearchViewSet(HaystackViewSet):
　　index_models = [Demo]#这里可以写入多个已经进行了索引的模型类
　　
　　serializer_class = DemoIndexSerializer

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

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