【Django】REST_Framework框架——GenericAPIView类源码解析

本是古典何须时尚 2024-04-08 13:20 11阅读 0赞

![在这里插入图片描述][e6d03f4c52e74d08b07648934808bbbe.webp_pic_center]

## 一、GenericAPIView源码解析 ##

**GenericAPIView继承自 APIView，也就是在 APIView基础上再做了一层封装**

### 类属性 ###

> **queryset = None  
> serializer\_class = None  
> lookup\_field = ‘pk’  
> lookup\_url\_kwarg = None  
> filter\_backends = api\_settings.DEFAULT\_FILTER\_BACKENDS  
> pagination\_class = api\_settings.DEFAULT\_PAGINATION\_CLASS**

#### 1、queryset ####

**queryset是用来控制视图返回给前端的数据。如果没什么逻辑，可以直接写在视图的类属性中，如果逻辑比较复杂，也可以重写get\_queryset方法用来返回一个queryset对象。如果重写了get\_queryset，那么以后获取queryset的时候就需要通过调用get\_queryset方法。因为queryset\` 这个属性只会调用一次，以后所有的请求都是使用他的缓存。**

#### 2、serializer\_class ####

**serializer\_class用来验证和序列化、反序列化数据的。也是可以通过直接设置这个属性，也可以通过重写get\_serializer\_class来实现。**

#### 3、lookup\_field ####

**在检索的时候，根据什么参数进行检索。默认是pk，也就是主键。**

#### 4、lookup\_url\_kwarg ####

**在检索的url中的参数名称。默认没有设置，跟lookup\_field保持一致。**

#### 5、filter\_backends ####

**用于过滤查询集的过滤器后端类的列表。默认值与DEFAULT\_FILTER\_BACKENDS 设置的值相同。**

#### 6、pagination\_class ####

**当分页列出结果时应使用的分页类。默认值与 DEFAULT\_PAGINATION\_CLASS 设置的值相同，即 ‘rest\_framework.pagination.PageNumberPagination’。**

### 方法 ###

> **get\_object()  
> get\_queryset()  
> get\_serializer()  
> get\_serializer\_class()  
> get\_serializer\_context()  
> paginate\_queryset()  
> filter\_queryset()**

#### 1、get\_queryset() ####

> **get\_queryset默认是返回数据库全部数据，如果想返回其他数据，需要自定义**

def get_queryset(self):
            """
            Get the list of items for this view.
            This must be an iterable, and may be a queryset.
            Defaults to using `self.queryset`.
    
            This method should always be used rather than accessing `self.queryset`
            directly, as `self.queryset` gets evaluated only once, and those results
            are cached for all subsequent requests.
    
            You may want to override this if you need to provide different
            querysets depending on the incoming request.
    
            (Eg. return a list of items that is specific to the user)
            """
            assert self.queryset is not None, (
                "'%s' should either include a `queryset` attribute, "
                "or override the `get_queryset()` method."
                % self.__class__.__name__
            )
    
            queryset = self.queryset
            if isinstance(queryset, QuerySet):
                # Ensure queryset is re-evaluated on each request.
                queryset = queryset.all()
            return queryset

#### 2、get\_object() ####

> **该方法是用于在数据检索(通过pk查找)的时候，返回一条数据的。  
> 不需要重写get\_object()，直接调用**

def get_object(self):
            """
            Returns the object the view is displaying.
    
            You may want to override this if you need to provide non-standard
            queryset lookups.  Eg if objects are referenced using multiple
            keyword arguments in the url conf.
            """
            queryset = self.filter_queryset(self.get_queryset())
    
            # Perform the lookup filtering.
            lookup_url_kwarg = self.lookup_url_kwarg or self.lookup_field
    
            assert lookup_url_kwarg in self.kwargs, (
                'Expected view %s to be called with a URL keyword argument '
                'named "%s". Fix your URL conf, or set the `.lookup_field` '
                'attribute on the view correctly.' %
                (self.__class__.__name__, lookup_url_kwarg)
            )
    
            filter_kwargs = {
        self.lookup_field: self.kwargs[lookup_url_kwarg]}
            obj = get_object_or_404(queryset, **filter_kwargs)
    
            # May raise a permission denied
            self.check_object_permissions(self.request, obj)
    
            return obj

#### 3、get\_serializer() ####

> **返回应该用于验证和反序列化输入以及序列化输出的序列化器实例  
> 不需要重写get\_serializer()方法，直接调用即可**

def get_serializer(self, *args, **kwargs):
            """
            Return the serializer instance that should be used for validating and
            deserializing input, and for serializing output.
            """
            serializer_class = self.get_serializer_class()
            kwargs.setdefault('context', self.get_serializer_context())
            return serializer_class(*args, **kwargs)

#### 4、get\_serializer\_class() ####

> **返回用于序列化的类。默认使用 self.serializer\_class。如果您需要根据传入请求提供不同的序列化，您可能需要重写它。**

def get_serializer_class(self):
            """
            Return the class to use for the serializer.
            Defaults to using `self.serializer_class`.
    
            You may want to override this if you need to provide different
            serializations depending on the incoming request.
    
            (Eg. admins get full serialization, others get basic serialization)
            """
            assert self.serializer_class is not None, (
                "'%s' should either include a `serializer_class` attribute, "
                "or override the `get_serializer_class()` method."
                % self.__class__.__name__
            )
    
            return self.serializer_class

#### 5、filter\_queryset() ####

> **默认不需要过滤，如果需要过滤需要重写filter\_queryset()方法**

def filter_queryset(self, queryset):
            """
            Given a queryset, filter it with whichever filter backend is in use.
    
            You are unlikely to want to override this method, although you may need
            to call it either from a list view, or from a custom `get_object`
            method if you want to apply the configured filtering backend to the
            default queryset.
            """
            for backend in list(self.filter_backends):
                queryset = backend().filter_queryset(self.request, queryset, self)
            return queryset

#### 6、paginator() ####

> **a、paginator()方法让装饰器@property进行修饰，表示将方法暴露出去变成了属性  
> b、判断类属性中是否包含pagination\_class方法，如果存在pagination\_class，则变为pagination\_class()方法并且赋值给self.\_paginator，返回self.\_paginator**

@property
        def paginator(self):
            """
            The paginator instance associated with the view, or `None`.
            """
            if not hasattr(self, '_paginator'):
                if self.pagination_class is None:
                    self._paginator = None
                else:
                    self._paginator = self.pagination_class()
            return self._paginator

#### 7、paginate\_queryset() ####

> **a、默认不需要分页，如果需要分页需要重写paginate\_queryset()方法  
> b、如果self.paginator 为 None，不需要进行过滤，否则需要通过self.paginator.paginate\_queryset（）方法进行过滤**  
>

def paginate_queryset(self, queryset):
            """
            Return a single page of results, or `None` if pagination is disabled.
            """
            if self.paginator is None:
                return None
            return self.paginator.paginate_queryset(queryset, self.request, view=self)

### 我的视图 ###

#### 重写了get\_queryset()方法和get\_serializer\_class()方法 ####

from rest_framework.generics import GenericAPIView
    from rest_framework.response import Response
    
    
    from app2.models import NewsChannel
    from app2.serializers1 import NewsChannelSerializer,NewsChannel1Serializer
    
    
    class ChannelsAPIView(GenericAPIView):
        queryset = NewsChannel.objects.all()
        serializer_class = NewsChannelSerializer
    
    
        def get_queryset(self):
            return NewsChannel.objects.filter(id__exact=2)
    
        def get_serializer_class(self):
            return NewsChannel1Serializer
    
    
        def get(self, request,*args,**kwargs):
            queryset=self.get_queryset()
            serializer=self.get_serializer(instance=queryset,many=True)
            return Response(serializer.data)
    
        def post(self,request):
            serializer=self.get_serializer(data=request.data)
            serializer.is_valid(raise_exception=True)
            serializer.save()
            return Response(serializer.data)

#### 执行结果： ####

![在这里插入图片描述][0542556c673a45889d68587b9e6ae97d.png]

![在这里插入图片描述][a8aa7be0b0c14db297c5a474ad140449.jpeg_pic_center]  
![在这里插入图片描述][cc27298b6ae744caa4d6069eb578b935.gif_pic_center]

[e6d03f4c52e74d08b07648934808bbbe.webp_pic_center]: https://img-blog.csdnimg.cn/e6d03f4c52e74d08b07648934808bbbe.webp#pic_center
[0542556c673a45889d68587b9e6ae97d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/eb81394328ab48b580b0a63d218c5942.png
[a8aa7be0b0c14db297c5a474ad140449.jpeg_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/8dec6f1a1b1c4bbcb3317d00ce16c99a.jpeg
[cc27298b6ae744caa4d6069eb578b935.gif_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/1770671d5cdf4d2abf51a1e1b5d764e4.gif