django與drf框架

 

 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

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

 

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) 完成任務方法交給視圖類的請求函數處理，得到請求的響應結果，返回給前台
"""

 

 

請求模塊：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) 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):
        # post請求不在路由中, ***
        # 所有請求方式攜帶的數據包
        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)

源碼分析

"""
# 最后解析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')