数据接口

数据接口

1.定义：由服务器定义的向前端输送数据的渠道（方法）

2.接口分类

2.1 FBV - 基于函数的视图（接口）

>使用定义函数的方式，向前端输送数据

2.2 CBV - 基于类的视图（接口）

>使用定义类的方式，向前端输送数据

#写一个用类的视图提供楼盘的数据的接口
# --------------------方法一----------------------

class EstateView(ListCreateAPIView,RetrieveUpdateDestroyAPIView):       # 楼盘的类接口视图
    #ListCreateAPIView：用于写类接口视图的类，其中封装了向数据库获取数据的方法，以及将数据序列化，并返回json形式的数据(获取楼盘的所有数据列表，并拥有新增功能)
    #RetrieveUpdateDestroyAPIView:用于写类接口视图的类，其中封装了向数据库获取单个数据的方法，以及将数据序列化，并返回json形式的数据(可以实现获取，修改，删除全部功能)
    queryset = Estate.objects.all()     # 获取楼盘数据
    #根据不同类型的请求，选择不同的序列化器（不同类型的请求需要的数据不同，所以需要不同的序列化器）
    def get_serializer_class(self):
        if self.request.method in ('POST','PATCH', 'PUT'):
            return HouseInfoPostSerializer
        else:
            return HouseInfoSerializer
    
    #重写父类的get方法：浏览器输入不同的路径，选择返回不同视图类，提供不同的数据
    def get(self, request, *args, **kwargs):
        if 'pk' in kwargs:
            cls = RetrieveAPIView
        else:
            cls = ListCreateAPIView
        return cls.get(self, request, *args, **kwargs)
    
# 在urls文件中配置访问路径
path('houseinfos/', HouseInfoView.as_View())
path('houseinfos/', HouseInfoView.as_View())
    #如此接口就写好了

#写一个用类的视图提供楼盘的数据的接口
# --------------------方法二----------------------
#创建数据接口类，并继承ModelViewSet(模型视图集合，增删改查功能都有)
class EstateViewSet(ModeViewSet):
    # 获取楼盘数据
     queryset = Estate.objects.all()
    # 指定序列化器
     serializer_class = HouseInfoSerializerSet

# 将路径配置到urls文件中
router = SimpleRouter()
router.register('housetypes', HouseTypeViewSet)
router.register('houseinfos', HouseInfoViewSet)
urlpatterns += router.urls

#如此接口就写好了

2.设置数据分页显示功能

#在setting文件中配置全局分页，此方式仅适用于CBV模式
REST_FRAMEWORK = {
    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',  #默认使用页码分页
    'PAGE_SIZE': 5,     # 每页显示5条数据
    'DEFAULT_THROTTLE_CLASSES': (
        'rest_framework.throttling.AnonRateThrottle',
    )
}

# 不需要分页的接口需要在视图中添加阻止语句
pagination_class = None


#函数视图分页设置
# 创建游标分页类
class EstatePagination(CursorPagination):
    page_size_query_param = 'size' #设置查询参数
    max_page_size = 10  #设置每页最多显示记录数
    ordering = 'estateid'   #设置分页排序
   

3.设置数据缓存

3.1 设置函数视图的数据缓存

# 函数视图的数据缓存，在需要缓存的数据的视图函数上加@cache_page(timeout=300)

@cache_page(timeout=1209600)    # 给行政区域设置缓存 
@api_view(('GET', ))
def get_provinces(request):
    """获取省级行政区域"""

    queryset = District.objects\
        .filter(pid__isnull=True).only('distid', 'name')
    serializer = DistrictSimpleSerializer(queryset, many=True)
    return Response(serializer.data)

3.2 设置类视图的数据缓存

#-----------------方法一-------------------------
#导入第三方库rest_framework_extension,让视图类继承其中的混入类CacheResponseMixin(必须是第一父类)

class HouseTypeViewSet(CacheResponseMixin, ModelViewSet):
    queryset = HouseType.objects.all()
    serializer_class = HouseTypeSerializer
    pagination_class = None

#------------------方法二-----------------------
#给视图类添加缓存装饰器
#类中不同的获取数据的方法需要指定添加，由参数name指定
@method_decorator(decorator=cache_page(timeout=120), name='retrieve')
@method_decorator(decorator=cache_page(timeout=600), name='list')
class HouseTypeViewSet(ModelViewSet):
    queryset = HouseType.objects.all()
    serializer_class = HouseTypeSerializer
    pagination_class = None

4. 数据筛选和排序

#   view.py
# 4.1 导入做数据筛选,排序的第三方库django-filters，OridongFilter
from django_filters.rest_framework import DjangoFilterBackend
from rest_framework.filters import OrderingFilter

class HouseInfoViewSet(CacheResponseMixin, ModelViewSet):
    queryset = HouseInfo.objects.all().defer('priceunit', 'mainphoto', 'estate', 'userid', 'agent')
    serializer_class = HouseInfoSerializerSe
    # 4.2 指定过滤支持
    filter_backends = (DjangoFilterBackend, OrderingFilter) 
    # 4.3 #指定过滤集
    filter_class = HouseInfoViewFilter      #指定过滤集
    
#utils.py

# 4.4 自建过滤集
class HouseInfoViewFilter(django_filters.FilterSet):
    #设置以某字段的值的范围为过滤条件
    # 以房屋面积为搜索条件
    minarea = django_filters.filters.NumberFilter(field_name='area', lookup_expr='gte')
    maxarea = django_filters.filters.NumberFilter(field_name='area', lookup_expr='lte')
    # 以房屋面积单价为搜索条件
    minprice = django_filters.filters.NumberFilter(field_name='price', lookup_expr='gte')
    maxprice = django_filters.filters.NumberFilter(field_name='price', lookup_expr='lte')
    # 以房屋所在位置为搜索条件
   keystreet = django_filters.CharFilter(lookup_expr='contains')
    # keystreet = django_filters.CharFilter(method='find_by_keyword_of_street')


    # @staticmethod
    # def find_by_keyword_of_street(queryset,keyword, value):
    #     queryset = queryset.filter(Q(street__contains = value))
    #
    #     return queryse

5.数据限流

# 所有接口都需要限流，则在配置文件中进行配置
REST_FRAMEWORK = {
    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
    'PAGE_SIZE': 5,
    # 限流的配置
    'DEFAULT_THROTTLE_CLASSES': (
        'rest_framework.throttling.AnonRateThrottle',
    ),
    # 配置单位时间内的访问次数
    'DEFAULT_THROTTLE_RETES':{
        'anon': '5/min',
    },
}