drf 簡介以及部分源碼分析


復習

""" 1、vue如果控制html 在html中設置掛載點、導入vue.js環境、創建Vue對象與掛載點綁定 2、vue是漸進式js框架 3、vue指令 {{ }} v-text|html => 限制一次性渲染 v-once v-if|show v-if v-else-if v-else v-for v-model v-bind [c1, c2] | {active: isActive} v-on fn | fn(...) | fn($event, ...) {{ data中出現的變量 }} v-if="data中出現的變量 的條件表達式" 4、vue實例成員 el | template components data {} | data () { return {} } methods computed:定義的是方法屬性 watch:監聽屬性 props <div id="app"> <Nav :subdata="supdata" @subaction="supaction"></Nav> </div> 5、生命周期鈎子 都是實例成員,在組件創建到銷毀整個過程的某些時間節點回調的函數 beforeCreated() { this._fn => this.$option.methods._fn } 6、項目 環境:node => npm(cnpm) => vue/cli 創建與配置 vue create proj | 選擇基礎插件 | 配置npm啟動 插件:vue-router | vuex | axios | vue-cookies | element-ui """

drf框架

全稱:django-rest framework

知識點

""" 1、接口:什么是接口、restful接口規范 2、CBV生命周期源碼 - 基於restful規范下的CBV接口 3、請求組件、解析組件、響應組件 4、序列化組件(靈魂) 5、三大認證(重中之重):認證、權限(權限六表)、頻率 6、其他組件:過濾、篩選、排序、分頁、路由 """

# 難點:源碼分析

接口

""" 接口:聯系兩個物質的媒介,完成信息交互 web程序中:聯系前台頁面與后台數據庫的媒介 web接口組成: url:長得像放回數據的url鏈接 請求參數:前台按照指定的key提供數據給后台 響應數據:后台與數據庫交互后將數據反饋給前台 """

restful接口規范

接口規范:就是為了采用不同的后台語言,也能使用同樣的接口獲取到同樣的數據

如何寫接口:接口規范是 規范化書寫接口的,寫接口要寫 url、響應數據

​ 注:如果將請求參數也納入考量范圍,那就是在寫 接口文檔

兩大部分:

  • url
1) 用api關鍵字標識接口url
    api.baidu.com | www.baidu.com/api
    
2) 接口數據安全性決定優先選擇https協議

3) 如果一個接口有多版本存在,需要在url中標識體現
    api.baidu.com/v1/... | api.baidu.com/v2/...
    
4) 接口操作的數據源稱之為 資源,在url中一般采用資源復數形式,一個接口可以概括對該資源的多種操作方式
    api.baidu.com/books | api.baidu.com/books/(pk)
    
5) 請求方式有多種,用一個url處理如何保證不混亂 - 通過請求方式標識操作資源的方式
    /books      get         獲取所有
    /books      post        增加一個(多個)
    /books/(pk) delete      刪除一個
    /books/(pk) put         整體更新一個
    /books/(pk) patch       局部更新一個

6) 資源往往涉及數據的各種操作方式 - 篩選、排序、限制
    api.baidu.com/books/?search=西&ordering=-price&limit=3
  • 響應數據
1) http請求的響應會有響應狀態碼,接口用來返回操作的資源數據,可以擁有 操作數據結果的 狀態碼
    status  0(操作資源成功)  1(操作資源失敗)  2(操作資源成功,但沒匹配結果)
    注:資源狀態碼不像http狀態碼,一般都是后台與前台或是客戶約定的
    
2) 資源的狀態碼文字提示
    status  ok  '賬號有誤'  '密碼有誤'  '用戶鎖定'
    
3) 資源本身
    results
    注:刪除資源成功不做任何數據返回(返回空字符串)
    
4) 不能直接放回的資源(子資源、圖片、視頻等資源),返回該資源的url鏈接

基於restful規范的原生Django接口

主路由:url.py
from django.conf.urls import url, include
from django.contrib import admin


urlpatterns = [
    url(r'^admin/', admin.site.urls),
    # 路由分發
    url(r'^api/', include('api.urls'))
]
api組件的子路由:api/url.py
from django.conf.urls import url

from . import views
urlpatterns = [
    url(r'^books/', views.Book.as_view()),
    url(r'^books/(?P<pk>.*)/$', views.Book.as_view()),
]
模型層:model.py
from django.db import models

class Book(models.Model):
    title = models.CharField(max_length=64)
    price = models.DecimalField(max_digits=5, decimal_places=2)

    class Meta:
        db_table = 'old_boy_book'
        verbose_name = '書籍'
        verbose_name_plural = verbose_name

    def __str__(self):
        return '《%s》' % self.title
后台層:admin.py
from django.contrib import admin

from . import models

admin.site.register(models.Book)
數據庫遷移
>: python manage.py makemigrations
>: python manage.py migrrate
 >: python manage.py createsuperuser
視圖層:views.py
from django.http import JsonResponse

from django.views import View
from . import models


# 六大基礎接口:獲取一個 獲取所有 增加一個 刪除一個 整體更新一個 局部更新一個
# 十大接口:群增 群刪 整體改群改 局部改群改
class Book(View):
    def get(self, request, *args, **kwargs):
        pk = kwargs.get('pk')
        if not pk:  # 群查
            # 操作數據庫
            book_obj_list = models.Book.objects.all()
            # 序列化過程
            book_list = []
            for obj in book_obj_list:
                dic = {}
                dic['title'] = obj.title
                dic['price'] = obj.price
                book_list.append(dic)
            # 響應數據
            return JsonResponse({
                'status': 0,
                'msg': 'ok',
                'results': book_list
            }, json_dumps_params={'ensure_ascii': False})
        else:  # 單查
            book_dic = models.Book.objects.filter(pk=pk).values('title', 'price').first()
            if book_dic:
                return JsonResponse({
                    'status': 0,
                    'msg': 'ok',
                    'results': book_dic
                }, json_dumps_params={'ensure_ascii': False})
            return JsonResponse({
                'status': 2,
                'msg': '無結果',
            }, json_dumps_params={'ensure_ascii': False})


    # postman可以完成不同方式的請求:get | post | put ...
    # postman發送數據包有三種方式:form-data | urlencoding | json
    # 原生django對urlencoding方式數據兼容最好
    def post(self, request, *args, **kwargs):
        # 前台通過urlencoding方式提交數據
        try:
            book_obj = models.Book.objects.create(**request.POST.dict())
            if book_obj:
                return JsonResponse({
                    'status': 0,
                    'msg': 'ok',
                    'results': {'title': book_obj.title, 'price': book_obj.price}
                }, json_dumps_params={'ensure_ascii': False})
        except:
            return JsonResponse({
                'status': 1,
                'msg': '參數有誤',
            }, json_dumps_params={'ensure_ascii': False})

        return JsonResponse({
            'status': 2,
            'msg': '新增失敗',
        }, json_dumps_params={'ensure_ascii': False})

Postman接口工具

官網下載安裝

get請求,攜帶參數采用Params

post等請求,提交數據包可以采用三種方式:form-date、urlencoding、json

所有請求都可以攜帶請求頭









代碼

注意點:

1.使用get過濾條件返回的是對象,所以后面不能點value,,filter是得到querySet對象可以點querySet方法

2.瀏覽器訪問默認就是get請求

3.post請求一定要注掉csrf

4.create返回的也是對象

5.request.POST.dict() 是request.POST QuerySet對象的dict()方法,將數據變成字典的形式

6.rest_framework中的Response默認是瀏覽器返回的是頁面,postman返回的數據

使用路由分發(api下也要創建一個url.py),然后視圖類寫視圖,再models.py中寫模型,數據遷移,創建createsuperuser,到admin后台進行錄入數據,然后下載pip3 install djangorestframework,再到settings中注冊app中’rest_framework‘ ,還有post請求要講settings中csrf注掉

項目dp_proj下的url.py
from django.conf.urls import url, include
from django.contrib import admin


urlpatterns = [
    url(r'^admin/', admin.site.urls),
    # 路由分發
    url(r'^api/', include('api.urls'))
]
應用api下的urls.py
from django.conf.urls import url

from . import views
urlpatterns = [
    url(r'^books/$', views.Book.as_view()),
    url(r'^books/(?P<pk>.*)/$', views.Book.as_view()),

    url(r'^test/$', views.Test.as_view()),
    url(r'^test2/$', views.Test2.as_view()),
]
models.py
from django.db import models

class Book(models.Model):
    title = models.CharField(max_length=64)
    price = models.DecimalField(max_digits=5, decimal_places=2)

    class Meta:
        db_table = 'old_boy_book'
        verbose_name = '書籍'
        verbose_name_plural = verbose_name

    def __str__(self):
        return '《%s》' % self.title
admin.py
from django.contrib import admin

from . import models

admin.site.register(models.Book)
views.py

from django.http import JsonResponse

from django.views import View
from . import models


# 六大基礎接口:獲取一個 獲取所有 增加一個 刪除一個 整體更新一個 局部更新一個
# 十大接口:群增 群刪 整體改群改 局部改群改
class Book(View):
    def get(self, request, *args, **kwargs):
        pk = kwargs.get('pk')
        if not pk:  # 群查
            # 操作數據庫
            book_obj_list = models.Book.objects.all()
            # 序列化過程
            book_list = []
            for obj in book_obj_list:
                dic = {}
                dic['title'] = obj.title
                dic['price'] = obj.price
                book_list.append(dic)
            # 響應數據
            return JsonResponse({
                'status': 0,
                'msg': 'ok',
                'results': book_list
            }, json_dumps_params={'ensure_ascii': False})
        else:  # 單查
            book_dic = models.Book.objects.filter(pk=pk).values('title', 'price').first()
            if book_dic:
                return JsonResponse({
                    'status': 0,
                    'msg': 'ok',
                    'results': book_dic
                }, json_dumps_params={'ensure_ascii': False})
            return JsonResponse({
                'status': 2,
                'msg': '無結果',
            }, json_dumps_params={'ensure_ascii': False})


    # postman可以完成不同方式的請求:get | post | put ...
    # postman發送數據包有三種方式:form-data | urlencoding | json
    # 原生django對urlencoding方式數據兼容最好
    def post(self, request, *args, **kwargs):
        # 前台通過urlencoding方式提交數據
        try:
            book_obj = models.Book.objects.create(**request.POST.dict())
            if book_obj:
                return JsonResponse({
                    'status': 0,
                    'msg': 'ok',
                    'results': {'title': book_obj.title, 'price': book_obj.price}
                }, json_dumps_params={'ensure_ascii': False})
        except:
            return JsonResponse({
                'status': 1,
                'msg': '參數有誤',
            }, json_dumps_params={'ensure_ascii': False})

        return JsonResponse({
            'status': 2,
            'msg': '新增失敗',
        }, json_dumps_params={'ensure_ascii': False})



# drf框架的封裝風格
from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework.request import Request
from rest_framework.serializers import Serializer
from rest_framework.settings import APISettings
from rest_framework.filters import SearchFilter
from rest_framework.pagination import PageNumberPagination
from rest_framework.authentication import TokenAuthentication
from rest_framework.permissions import IsAuthenticated
from rest_framework.throttling import SimpleRateThrottle

# 總結:
# 1) drf 對原生request做了二次封裝,request._request就是原生request
# 2) 原生request對象的屬性和方法都可以被drf的request對象直接訪問(兼容)
# 3) drf請求的所有url拼接參數均被解析到query_params中,所有數據包數據都被解析到data中
class Test(APIView):
    def get(self, request, *args, **kwargs):
        # url拼接的參數
        print(request._request.GET)  # 二次封裝方式
        print(request.GET) # 兼容
        print(request.query_params) # 拓展

        return Response('drf get ok')

    def post(self, request, *args, **kwargs):
        # 所有請求方式攜帶的數據包
        print(request._request.POST)  # 二次封裝方式
        print(request.POST)  # 兼容
        print(request.data)  # 拓展,兼容性最強,三種數據方式都可以

        print(request.query_params)

        return Response('drf post ok')

# 在setting.py中配置REST_FRAMEWORK,完成的是全局配置,所有接口統一處理
# 如果只有部分接口特殊化,可以完成 - 局部配置
from rest_framework.renderers import JSONRenderer
class Test2(APIView):
    renderer_classes = [JSONRenderer]
    def get(self, request, *args, **kwargs):
        return Response('drf get ok 2')

    def post(self, request, *args, **kwargs):
        return Response('drf post ok 2')

DRF框架

安裝
>: pip3 install djangorestframework
drf框架規矩的封裝風格
from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework.request import Request
from rest_framework.serializers import Serializer
from rest_framework.settings import APISettings
from rest_framework.filters import SearchFilter
from rest_framework.pagination import PageNumberPagination
from rest_framework.authentication import TokenAuthentication
from rest_framework.permissions import IsAuthenticated
from rest_framework.throttling import SimpleRateThrottle

class Test(APIView):
    def get(self, request, *args, **kwargs):
        return Response('drf get ok')
drf請求生命周期
""" 1) 請求走的是APIView的as_view函數 2) 在APIView的as_view調用父類(django原生)的as_view,還禁用了 csrf 認證 3) 在父類的as_view中dispatch方法請求走的又是APIView的dispatch 4) 完成任務方法交給視圖類的請求函數處理,得到請求的響應結果,返回給前台 """

1.views.py視圖文件中寫一個類繼承APIView,點擊APIView

2.  renderer_classes = api_settings.DEFAULT_RENDERER_CLASSES
    parser_classes = api_settings.DEFAULT_PARSER_CLASSES
    authentication_classes = api_settings.DEFAULT_AUTHENTICATION_CLASSES
    throttle_classes = api_settings.DEFAULT_THROTTLE_CLASSES
    permission_classes = api_settings.DEFAULT_PERMISSION_CLASSES
    content_negotiation_class = api_settings.DEFAULT_CONTENT_NEGOTIATION_CLASS
    metadata_class = api_settings.DEFAULT_METADATA_CLASS
    versioning_class = api_settings.DEFAULT_VERSIONING_CLASS
    看到以上這些所以的類屬性都是可以在自定義類中來重寫自定義renderer_class=[...]
    
3.這些類屬性都是默認的,如果你沒有重寫這些類屬性就默認找api_settings
views.py中導入from rest_framework.settings import APISettings, 點擊APISettings進行查看,這個配置文件中說如果你設置rest_framework全局的名稱空間,你需要到自己的項目中settings配置文件中進行自定義配置,否則就采用默認的

4.re_path(r'^test/$', views.Test.as_view()),訪問路由的as_view(),走的是APIView中的as_view()

5.APIView的as_wiew()方法返回的是return csrf_exempt(view) 這是禁用csrf,也就是局部禁用csrf,繼承APIView視圖的類會禁用csrf認證

6.APIView中view=super().as_view(**initkwargs)  這里調用的super就是APIView父類

7.先不用點擊APIView繼承的父類,往上找發現是導包的View  from django.views.generic import View

8.這個View就是視圖函數繼承的View
from django.views import View 點擊View查看,點擊進去之后按pycharm的左上角定位到文件,發現就是views文件夾下沒有View,所以走的是文件夾下__init__中的__all__=['View']
這個View是from django.views.genneric.base import View  
9.其實走的還是View中的return self.dispatch(request,*args,**kwargs),先走自定義類中Test中是否重寫dispatch方法,沒有就走APIView中的dispatch

10.APIView中根View不一樣的地方就是有異常捕獲,response = self.handle_exception(exc)這個是自己提供的

請求模塊:request對象

源碼入口

APIView類的dispatch方法中:request = self.initialize_request(request, *args, **kwargs)

源碼分析
""" # 二次封裝得到def的request對象 request = self.initialize_request(request, *args, **kwargs) 點進去 # 在rest_framework.request.Request實例化方法中 self._request = request 將原生request作為新request的_request屬性 # 在rest_framework.request.Request的__getattr__方法中 try: return getattr(self._request, attr) # 訪問屬性完全兼容原生request except AttributeError: return self.__getattribute__(attr) """

1.入口是從APIView中的dispatch方法中看源碼

2. request = self.initialize_request(request, *args, **kwargs)這是request的二次封裝

3. try:
            self.initial(request, *args, **kwargs) #request對象處理完之后,請求之前執行的代碼,這個通過了才可以請求,沒有通過就是走response

            # Get the appropriate handler method
            if request.method.lower() in self.http_method_names:#請求
                handler = getattr(self, request.method.lower(),
                                  self.http_method_not_allowed)
            else:
                handler = self.http_method_not_allowed

            response = handler(request, *args, **kwargs)

        except Exception as exc:
            response = self.handle_exception(exc)

        self.response = self.finalize_response(request, response, *args, **kwargs)
        return self.response
    
    
    
4.request = self.initialize_request(request, *args, **kwargs)點擊initialize_request
parser_context = self.get_parser_context(request)將request傳入進行解析數據

5.
#這個request是導入的from rest_framework.request import Request的類
這是在實例化
  return Request(
            request, #傳入原生的request
            parsers=self.get_parsers(), #self代表視圖函數中的自定義類的對象,沒有重寫的就到APIView中找打,解析數據
            authenticators=self.get_authenticators(),
            negotiator=self.get_content_negotiator(),
            parser_context=parser_context
        )

6.點擊Request這個類,__init__先走斷言,是否遵守了https協議,遵守了就到self._request = request#這是二次封裝request,將原生reqeust作為drf request對象的_request

7.self.name這是會觸發魔法方法__getattr__方法,所以找到Reuqest的__getattr__方法

8.
繼承了APIView  request就不是原生django的,而是drf的request方法,request.屬性就會觸發(request.user)__getattr__
 def __getattr__(self, attr):
        """ If an attribute does not exist on this instance, then we also attempt to proxy it to the underlying HttpRequest object. """
        try:
            return getattr(self._request, attr)  #而這里self._request是原生django的reqeust,在Request類實例化的時候進行賦值的,這里就是完全兼容了原功能,在此基礎上再拓展新功能,先在這里面找,找不到去自己的self.__getattribute__(attr)中找
        except AttributeError:
            return self.__getattribute__(attr)

9.
views.py中的類
class Test(APIView):
    def get(self, request, *args, **kwargs):
        return Response('drf get ok')  #在這里打斷點
然后postman發送GET http//127.0.0.1:8000/api/test/ 的請求數據
查看后台debug數據request展開,這里面找到下划線_request就是django原生的WSGIR協議的request
_request中可以找到GET,POST,META
在request中找不到GET,META,但是有data,POST,query_params
data是django,res_framework中三種方式提交數據包都會解析到這里來 比如PUT,POST
而GET請求的數據會解析到query_params里面

10.
#三種獲取get請求數據的方法
class Test(APIView):
    def get(self, request, *args, **kwargs):
        # url拼接的參數
        print(request._request.GET)  # 二次封裝方式
        print(request.GET) # 兼容
        print(request.query_params) # 拓展

        return Response('drf get ok')

11.
postman中發送post請求,使用form_data和json和urlencoded發送新增數據
    def post(self, request, *args, **kwargs):
        # 所有請求方式攜帶的數據包
        print(request._request.POST)  # 二次封裝方式,這里只能獲取到form_data和urlencoded的數據
        print(request.POST)  # 兼容,這里也只能獲取搭配form_data和urlencoded的數據
        print(request.data)  # 拓展,兼容性最強,三種數據方式都可以,這里三種請求方式的數據都可以獲取的到

        print(request.query_params)

        return Response('drf post ok')
重點總結
# 1) drf 對原生request做了二次封裝,request._request就是原生request
# 2) 原生request對象的屬性和方法都可以被drf的request對象直接訪問(兼容)
# 3) drf請求的所有url拼接參數均被解析到query_params中,所有數據包數據都被解析到data中
class Test(APIView):
    def get(self, request, *args, **kwargs):
        # url拼接的參數
        print(request._request.GET)  # 二次封裝方式
        print(request.GET) # 兼容
        print(request.query_params) # 拓展

        return Response('drf get ok')

    def post(self, request, *args, **kwargs):
        # 所有請求方式攜帶的數據包
        print(request._request.POST)  # 二次封裝方式
        print(request.POST)  # 兼容
        print(request.data)  # 拓展,兼容性最強,三種數據方式都可以

        print(request.query_params)

        return Response('drf post ok')

渲染模塊:瀏覽器和Postman請求結果渲染數據的方式不一樣

源碼入口

APIView類的dispatch方法中:self.response = self.finalize_response(request, response, *args, **kwargs)

源碼分析
""" self.response = self.finalize_response(request, response, *args, **kwargs)這里點擊finalize_response進入 # 最后解析reponse對象數據 self.response = self.finalize_response(request, response, *args, **kwargs) 點進去 # 拿到運行的解析類的對象們 neg = self.perform_content_negotiation(request, force=True) 點進去 # 獲得解析類對象 renderers = self.get_renderers() 點進去 # 從視圖類中得到renderer_classes請求類,如何實例化一個個對象形參解析類對象列表 return [renderer() for renderer in self.renderer_classes] # 重點:self.renderer_classes獲取renderer_classes的順序 # 自己視圖類的類屬性(局部配置) => # APIView類的類屬性設置 => # 自己配置文件的DEFAULT_RENDERER_CLASSES(全局配置) => # drf配置文件的DEFAULT_RENDERER_CLASSES """
全局配置:所有視圖類統一處理,在項目的settings.py中
REST_FRAMEWORK = {
    # drf提供的渲染類
    'DEFAULT_RENDERER_CLASSES': [
        'rest_framework.renderers.JSONRenderer',
        'rest_framework.renderers.BrowsableAPIRenderer',
    ],
}
局部配置:某一個或一些實體類單獨處理,在views.py視圖類中提供對應的類屬性
class Test(APIView):
    def get(self, request, *args, **kwargs):
        return Response('drf get ok')

    def post(self, request, *args, **kwargs):
        return Response('drf post ok')

# 在setting.py中配置REST_FRAMEWORK,完成的是全局配置,所有接口統一處理
# 如果只有部分接口特殊化,可以完成 - 局部配置
from rest_framework.renderers import JSONRenderer
class Test2(APIView):
    # 局部配置
    renderer_classes = [JSONRenderer]
    def get(self, request, *args, **kwargs):
        return Response('drf get ok 2')

    def post(self, request, *args, **kwargs):
        return Response('drf post ok 2')







此博客轉自https://www.cnblogs.com/huangxuanya/p/11680325.html


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM