django框架使用elasticsearch实现全文检索

1. 首先你的服务器上要安装有docker，具体如何安装，我的另一篇博客有
2. 安装elasticsearch环境（docker安装）
   1. 拉取镜像
      docker image pull delron/elasticsearch-ik:2.4.6-1.0
   2. 运行容器
      docker run -d -p 9200:9200 -p 9300:9300 --name search delron/elasticsearch-ik:2.4.6-1.0
3. 首先安装相关的依赖包
   pip3 install drf-haystack 用于drf框架
   pip3 install elasticsearch
4. 在django项目配置文件settings.py中注册应用
   INSTALLED_APPS = [
   …
   ‘haystack’，
   …
   注册的app
   ]
5. 在django项目配置文件settings.py中指定搜索的后端

# elasticsearch配置
HAYSTACK_CONNECTIONS = {
    'default': {
        'ENGINE': 'haystack.backends.elasticsearch_backend.ElasticsearchSearchEngine',
        'URL': 'http://47.111.87.61:9200/',  # 此处为elasticsearch运行的服务器ip地址，端口号固定为9200
        'INDEX_NAME': 'test',  # 指定elasticsearch建立的索引库的名称
    },
}

# 当添加、修改、删除数据时，自动生成索引
HAYSTACK_SIGNAL_PROCESSOR = 'haystack.signals.RealtimeSignalProcessor'
 # 指定搜索结果每页的条数 这一条可以屏蔽掉，因为分页时使用的是django的分压器
# HAYSTACK_SEARCH_RESULTS_PER_PAGE = 10

6. 创建索引类
   6.1. 在此之前要先创建model类，并插入数据(就是你要建立一个数据库)

class Member(BaseModel):
    """会员信息"""

    level = models.CharField(max_length=20,verbose_name='会员等级')
    price = models.DecimalField(max_digits=10, decimal_places=2, verbose_name='价格')
    confession_num = models.IntegerField(default=10, verbose_name='表白次数')
    receive_confession_num = models.IntegerField(default=10, verbose_name='接受表白次数')
    desc = models.TextField(null=True, blank=True, verbose_name='会员介绍')

    class Meta:
        db_table = 'tb_member'
        verbose_name = '会员信息'
        verbose_name_plural = verbose_name

6.2. 我在users应用下创建：search_indexes.py

from haystack import indexes
from users.models import Member

# 索引模型类的名称必须是 模型类名称 + Index
class MemberIndex(indexes.SearchIndex, indexes.Indexable):
    text = indexes.CharField(document=True, use_template=True)
    # 返回的字段
    confession_num = indexes.IntegerField(model_attr='confession_num')
    receive_confession_num = indexes.IntegerField(model_attr='receive_confession_num') # 假装是外键
    level = indexes.CharField(model_attr='level')
    id = indexes.IntegerField(model_attr='id')
    
    def get_model(self):
        """返回建立索引的模型类"""
        return Member

    def index_queryset(self, using=None):
        """返回要建立索引的数据查询集"""
        # return self.get_model().objects.all()
        return self.get_model().objects.filter(is_deleted=False)

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

7. 在templates目录中创建text字段使用的模板文件
   setting中：

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [os.path.join(BASE_DIR, 'templates/')], # 找位置创建templates文件夹
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages',
            ],
        },
    },
]

然后创建文件templates/search/indexes/users/member_text.txt文件中定义：
{{ object.level }}
{{ object.desc }}
注意：创建的文件夹名称自己找规律
8. 手动更新索引
python manage.py rebuild_index #数据库有多少条数据，全部会被同步到es中
9. 创建haystack序列化器

from drf_haystack.serializers import HaystackSerializer
from users.search_indexes import MemberIndex

class MemberIndexSerializer(HaystackSerializer):
    """注意这个序列化器只读，不许写入"""
    receive_confession_num = serializers.SerializerMethodField() # 假装是外键
    
    class Meta:
        index_classes = [MemberIndex]# 索引类的名称
        fields = ('text', 'confession_num', 'receive_confession_num', 'id', 'level')# text 由索引类进行返回, 第一个参数必须是text

	def get_receive_confession_num(self, obj):
        return obj.receive_confession_num

10. 创建视图类

from drf_haystack.viewsets import HaystackViewSet
from users.serializer import MemberIndexSerializer
from users.models import User, Member
from haystack.query import SearchQuerySet

class MemberReadAPIView(HaystackViewSet):
    """会员等级搜索"""
	permission_classes = [IsAuthenticated] # 验证是否登录
    index_models = [Member]
    serializer_class = MemberIndexSerializer
    queryset = SearchQuerySet().order_by('-id') # 根据字段进行排序
#该视图会返回搜索结果的列表数据，所以如果可以为视图增加REST framework的分页功能。
#我们在配置文件已经定义了分页配置，所以此搜索视图会进行分页

11. 路由

from django.urls import path
from rest_framework import routers
from . import views

router = routers.DefaultRouter()
router.register("user/memberread", views.MemberReadAPIView, basename="user/memberread")

urlpatterns = [
    path('user/register', views.CreateUserView.as_view()),
    path('user/login', views.LoginAPIView.as_view()),
    path('user/logout', views.LogoutAPIView.as_view()),
    path('user/info', views.UserAPIView.as_view()),
    path('user/loginimage', views.LoginInfoImageAPIView.as_view()),
]

urlpatterns += router.urls

12. 测试
    
    
    django-haystack官网：链接地址