两个视图基类
APIView
rest_framework.views.APIView
APIView是rest framework提供的所有视图的基类,继承自Django的View父类
APIView与View的不同:
- 传入到视图方法中的是rest framework的Request对象,而不是Django的HttpRequest对象
- 视图方法可以返回rest framework的Response对象,视图会为响应数据设置(render)符合前端要求的格式
- 任何APIException异常都会被捕获到,并且处理成合适的响应信息
- 在进行dispatch()分发前,会对请求进行身份验证、权限检查、访问频率限制
支持定义的属性:
- authentication_classes列表或元组,身份认证类
- permission_classes列表或元组,权限检查类
- throttle_classes列表或元组,频率限制类
在APIView中仍以常规的类视图定义方法来实现get()、post()或其他请求方式的方法
例如:
from rest_framework.views import APIView
from rest_framework.response import Response
# url(r'^books/$', views.BookListView.as_view()),
class BookListView(APIView):
def get(self, request):
books = BookInfo.objects.all()
serializer = BookInfoSerializer(books, many=True)
return Response(serializer.data)
GenericAPIView(通用视图类)
rest_framework.generics.GenericAPIView
继承自APIView,主要增加了操作序列化器和数据库查询的方法,作用是为下面Mixin扩展类的执行提供方法支持。通常在使用时可搭配一个或多个Mixin扩展类
提供的关于序列化器使用的属性与方法
-
属性
- serializer_class指明视图使用的序列化器
-
方法
-
get_serializer_class(self)
当出现一个视图类中调用多个序列化器时,则可以通过条件判断在get_serializer_class方法中通过返回不同的序列化器类名让视图方法执行不同的序列化器对象。
返回序列化器类,默认返回serializer_class,可以重写,如:
def get_serializer_class(self): if self.request.user.is_staff: return FullAccountSerializer return BasicAccountSerializer
-
get_serializer(self, args,*kwargs)
返回序列化器对象,主要用来提供给Mixin扩展类使用,如果我们在视图中想要获取序列化器对象,也可以直接调用此方法
注意:该方法在提供序列化器对象的时候,会向序列化器对象的context属性补充三个数据:request、format、view,这三个数据对象可以在定义序列化器时使用
- request 当前视图的请求对象
- format 当前请求期望返回的数据格式
- view 当前请求的类视图对象
-
提供的关于数据库查询的属性与方法
-
属性
- queryset 指明使用的数据查询集
-
方法
-
get_queryset(self)
返回视图使用的查询集,主要用来提供给Mixin扩展类使用,是列表视图与详情视图获取数据的基础,默认返回queryset属性,可以重写,如:
def get_queryset(self): user = self.request.user return user.accounts.all()
-
get_object(self)
返回详情视图所需的模型类数据对象,主要用来提供给Mixin扩展类使用
在视图中可以调用该方法获取详情信息的模型类对象
若详情访问的模型类对象不存在,会返回404
该方法会默认使用APIView提供的check_object_permissions方法检查当前对象是否有权限被访问,如
# url(r'^books/(?P<pk>\d+)/$', views.BookDetailView.as_view()), class BookDetailView(GenericAPIView): queryset = BookInfo.objects.all() serializer_class = BookInfoSerializer def get(self, request, pk): book = self.get_object() # get_object()方法根据pk参数查找queryset中的数据对象 serializer = self.get_serializer(book) return Response(serializer.data)
-
其他可以设置的属性
- pagination_class 指明分页控制类
- filter_backends 指明过滤控制类