DRF框架簡介

一:基礎簡介

(1)接口:

  (1)生活中:鏈接兩個物體的媒介前端

  (2)web:鏈接前段後端的媒介git

(2)接口的組成

  (1)url:web

  (2)請求參數:按照後端的要求 前段輸入指定的key提交給後端數據庫

  (3)響應結果:後臺與數據庫交互數據 傳遞給前端django

二:restfull接口規範

(1)做用:

  (1)根據不一樣的語音環境寫一樣的接口 後端也能獲取數據json

(2)接口組成

(1)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

(2)響應數據api

1: http請求的響應會有響應狀態碼,接口用來返回操做的資源數據,能夠擁有 操做數據結果的 狀態碼
    status  0(操做資源成功)  1(操做資源失敗)  2(操做資源成功,但沒匹配結果)
    注:資源狀態碼不像http狀態碼,通常都是後臺與前臺或是客戶約定的
    
2: 資源的狀態碼文字提示
    status  ok    '帳號有誤'  '密碼有誤'  '用戶鎖定'
    
3: 資源自己
    results
    注:刪除資源成功不作任何數據返回(返回空字符串)
    
4: 不能直接放回的資源(子資源、圖片、視頻等資源),返回該資源的url連接

 三:基於restful規範的原生接口書寫方式

# 主路由 作路由分發
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子組件路由

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()),
]
# 模型層
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
from . import models  #
from django.views import View
from django.http import JsonResponse


class Book(View):
    def get(self, request, *args, **kwargs):  # get請求
        primary_key = kwargs.get('primary_key')  # 匹配前面有名分組
        if not primary_key:  # 查詢全部
            book_obj_list = models.Book.objects.all()
            print(book_obj_list)  # <QuerySet [<Book: <<西遊記>>>, <Book: <<紅樓夢>>>]>
            book_list = []
            # 序列化開始
            for book_obj in book_obj_list:
                back_dic = {}
                back_dic['name'] = book_obj.name
                back_dic['price'] = book_obj.price
                book_list.append(back_dic)
            #    序列化結束

            # 返回數據給前段
            return JsonResponse({
                'status': 0,
                'msg': '查詢成功',
                'results': book_list,

            }, json_dumps_params={'ensure_ascii': False})
        else:  # 查詢單個
            book_dict = models.Book.objects.filter(pk=primary_key).values('name', 'price').first()
            print(book_dict, type(book_dict))  # <QuerySet [<Book: <<西遊記>>>, <Book: <<紅樓夢>>>]>
            if not book_dict:  # 判斷數據是否存在
                return JsonResponse(
                    {'status': 1,
                     'msg': '該書籍不存在',
                     },
                    json_dumps_params={'ensure_ascii': False}
                )
            return JsonResponse({
                'status': 1,
                'msg': '查詢成功',
                'result': book_dict
            },
                json_dumps_params={'ensure_ascii': False}
            )

    def post(self, request, *args, **kwargs):  # post請求
        print(request.POST.dict())  # {'name': '神墓', 'price': '199.99'}
        recv_dict = request.POST.dict()
        book_obj = models.Book.objects.create(**recv_dict)  # 獲取用戶輸入的值 將對象打散轉換成字典形式
        if not book_obj:
            return JsonResponse({
                'status': 1,
                'msg': '建立異常'
            },
                json_dumps_params={'ensure_ascii': False})
        return JsonResponse({
            'status': 0,
            'msg': '添加成功',
            'results': {'name': book_obj.name, 'price': book_obj.price}
        },
            json_dumps_params={'ensure_ascii': False})
視圖層

PS:安全

  (1)postman能夠完成不一樣方式的請求:get | post | put ...
  (2) postman發送數據包有三種方式:form-data | urlencoding | json
  (3)原生django對urlencoding方式數據兼容最好restful

四:DRF框架

# 安裝
pip3 install djangorestframework
"""
1) 請求走的是APIView的as_view函數

2) 在APIView的as_view調用父類(django原生)的as_view,還禁用了 csrf 認證

3) 在父類的as_view中dispatch方法請求走的又是APIView的dispatch

4) 完成任務方法交給視圖類的請求函數處理,獲得請求的響應結果,返回給前臺
"""

(1)請求模塊 request對象

(1)源碼入口

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

(2)源碼分析

"""
# 二次封裝獲得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
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')
視圖層案例

PS:

  (1) drf 對原生request作了二次封裝,request._request就是原生request
  (2) 原生request對象的屬性和方法均可以被drf的request對象直接訪問(兼容)
  (3) drf請求的全部url拼接參數均被解析到query_params中,全部數據包數據都被解析到data中

(2)渲染模塊

 (1)源碼入口

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

(2)源碼分析

"""
# 最後解析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
"""

(3)全局配置:全部配置在settings文件配置

REST_FRAMEWORK = {
    # drf提供的渲染類
    'DEFAULT_RENDERER_CLASSES': [
        'rest_framework.renderers.JSONRenderer',
        'rest_framework.renderers.BrowsableAPIRenderer',  # 此處有bug 源碼問題 注意更改
    ],
}

(4)局部配置:某一個或一些實體類單獨處理,在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')
相關文章
相關標籤/搜索