04: DjangoRestFramework使用

時間 2019-12-14

標籤 djangorestframework 使用简体版

原文原文鏈接

Django其餘篇

1.1 DjangoRestFramework基本使用返回頂部

　　一、回顧CBV基本使用html

from django.contrib import admin
from django.urls import path,re_path,include

urlpatterns = [
    path('admin/', admin.site.urls),
    re_path(r'users/',include(('users.urls', 'users'), namespace='users'))
]

urls.py

from django.contrib import admin
from django.urls import path,re_path,include

urlpatterns = [
    path('admin/', admin.site.urls),
    re_path(r'users/',include(('users.urls', 'users'), namespace='users'))
]

users/urls.py

import json
from django.shortcuts import render,HttpResponse
from django.views import View

class HomeView(View):

    def dispatch(self, request, *args, **kwargs):
        return super(HomeView, self).dispatch(request, *args, **kwargs)

    def get(self, request):
        return HttpResponse('get')

    def post(self, request):
        return HttpResponse('post')

users/views.py

　　二、安裝DjangoRestFrameworkpython

pip install djangorestframework==3.9.2
pip install markdown==3.0.1                  # Markdown support for the browsable API.
pip install django-filter==2.1.0             # Filtering support

　　三、DjangoRestFramework 基本使用git

from django.contrib import admin
from django.urls import path,re_path,include

urlpatterns = [
    path('admin/', admin.site.urls),
    re_path(r'users/',include(('users.urls', 'users'), namespace='users'))
]

urls.py

from django.urls import path,re_path,include
from users import views

urlpatterns = [
    re_path(r'info', views.UserInfoViewSet.as_view(), name='user'),
]

users/urls.py

from rest_framework.views import APIView
from django.http import JsonResponse

class UserInfoViewSet(APIView):
    def __init__(self):
        super(UserInfoViewSet, self).__init__()

    def get(self, request, *args, **kwargs):
        result = {
            'status': True,
            'data': 'response data'
        }
        return JsonResponse(result, status=200)

    def post(self, request, *args, **kwargs):
        result = {
            'status': True,
            'data': 'response data'
        }
        return JsonResponse(result, status=200)

users/views.py

1.2 drf認證&權限模塊返回頂部

　　一、authentication基本使用github

class UserInfoViewSet(APIView):
    authentication_classes = [authentication.IsAuthenticated,]  # 用戶認證模塊
    permission_classes = (authentication.IsOwnerOrReadOnly,)    # 用戶受權模塊

from django.contrib import admin
from django.urls import path,re_path,include

urlpatterns = [
    path('admin/', admin.site.urls),
    re_path(r'users/',include(('users.urls', 'users'), namespace='users'))
]

urls.py

#! /usr/bin/env python
# -*- coding: utf-8 -*-
from django.urls import path,re_path,include
from users import views

urlpatterns = [
    re_path(r'info', views.UserInfoViewSet.as_view(), name='user'),
]

users/urls.py

from rest_framework.views import APIView
from django.http import JsonResponse
from common.auth import authentication

class UserInfoViewSet(APIView):
    authentication_classes = [authentication.IsAuthenticated,]
    permission_classes = (authentication.IsOwnerOrReadOnly,)

    def __init__(self):
        super(UserInfoViewSet, self).__init__()

    def get(self, request, *args, **kwargs):
        result = {
            'status': True,
            'data': 'response data'
        }
        return JsonResponse(result, status=200)

    def post(self, request, *args, **kwargs):
        result = {
            'status': True,
            'data': 'response data'
        }
        return JsonResponse(result, status=200)

users/views.py

#! /usr/bin/env python
# -*- coding: utf-8 -*-
from rest_framework import authentication
from rest_framework import exceptions
from rest_framework import permissions

class IsOwnerOrReadOnly(permissions.BasePermission):
    def has_permission(self, request, view):
        if False:  # 這裏暫且不進行權限驗證
            raise exceptions.ParseError('您沒有操做的權限')
        return True

class IsAuthenticated(authentication.BaseAuthentication):
    def authenticate(self, request):
        auth = request.META.get('HTTP_AUTHORIZATION', None)  # 獲取 header中的 Authorization
        if auth is None:
            raise exceptions.NotAuthenticated()

        '''這裏應該是驗證token是否合法邏輯'''
        # token = Token.objects.filter(key=auth)
        # try:
        #     request.user = token[0].user
        # except IndexError:
        #     raise exceptions.NotAuthenticated('Invalid input Authenticated')
        return (request, None)

    def authenticate_header(self, request):
        msg = 'Invalid token.Please get token first'
        return exceptions.NotAuthenticated(msg)

common\auth\authentication.py

　　二、測試接口 django

1.3 djangorestframework 序列化返回頂部

　　一、序列化使用舉例（serializers.Serializer）json

'''一、ser = UserInfoSerializer(instance=obj,many=True)'''
# 對查詢實例進行序列化 # ser.data 獲取序列化後的json格式數據

'''二、定義顯示的字段''' name = serializers.CharField()                         # 顯示普通字段
ut = serializers.CharField(source='ut.type_name')      # 顯示一對多字段
gp = serializers.SerializerMethodField()               # 自定義顯示（顯示多對多）
xxx = serializers.CharField(source='name')             # 也能夠自定義顯示字段名稱

from django.contrib import admin
from django.urls import path,re_path,include

urlpatterns = [
    path('admin/', admin.site.urls),
    re_path(r'users/',include(('users.urls', 'users'), namespace='users'))
]

urls.py

'''users/urls.py'''

from django.urls import path,re_path
from users import views

urlpatterns = [
    re_path(r'^info/$', views.UserInfoViewSet.as_view(), name='userinfo'),
]

users/urls.py

'''users/models.py'''

from __future__ import unicode_literals
from django.db import models

class UserInfo(models.Model):
    name = models.CharField(max_length=64,unique=True)
    ut = models.ForeignKey(to='UserType', on_delete=models.CASCADE)
    gp = models.ManyToManyField(to='UserGroup')

class UserType(models.Model):
    type_name = models.CharField(max_length=64,unique=True)

class UserGroup(models.Model):
    group = models.CharField(max_length=64)

users/models.py

''' users/views.py'''

from rest_framework.views import APIView
from rest_framework.views import Response
from users.serializers.userinfo_serializers import UserInfoSerializer
from users.models import UserInfo

class UserInfoViewSet(APIView):
    def get(self, request, *args, **kwargs):
        obj = UserInfo.objects.all()
        ser = UserInfoSerializer(instance=obj,many=True)
        # ret = json.dumps(ser.data,ensure_ascii=False)
        # return HttpResponse(ret)
        return Response(ser.data, status=200)

'''
[{
    "name": "zhangsan",
    "ut": "學生",
    "gp": [{
        "id": 1,
        "gp": "group01"
    }, {
        "id": 2,
        "gp": "group02"
    }],
    "xxx": "zhangsan"
}, {
    "name": "lisi",
    "ut": "學生",
    "gp": [{
        "id": 1,
        "gp": "group01"
    }],
    "xxx": "lisi"
}]

users/views.py

'''users/serializers/userinfo_serializers.py'''

from rest_framework import serializers
from users.models import UserInfo

class UserInfoSerializer(serializers.Serializer):
    name = serializers.CharField()                         # 顯示普通字段
    ut = serializers.CharField(source='ut.type_name')      # 顯示一對多字段
    gp = serializers.SerializerMethodField()               # 自定義顯示（顯示多對多）
    xxx = serializers.CharField(source='name')             # 也能夠自定義顯示字段名稱

    class Meta:
        model = UserInfo

    def get_gp(self,row):
        '''row: 傳過來的正是 UserInfo表的對象'''
        gp_obj_list = row.gp.all()  # 獲取用戶全部組
        ret = []
        for item in gp_obj_list:
            ret.append({'id':item.id,'gp':item.group})
        return ret

　　二、序列化使用舉例（serializers.ModelSerializer）api

　　　　　　1. ModelSerializer本質是繼承了Serielizer類添加了部分功能markdown

　　　　　　2. 在使用上ModelSerializer能夠使用 fields = '__all__' 定義要顯示的字段app

'''users/serializers/userinfo_serializers.py'''

from rest_framework import serializers
from users.models import UserInfo

class UserInfoSerializer(serializers.ModelSerializer):
    # name = serializers.CharField()                       # 顯示普通字段
    ut = serializers.CharField(source='ut.type_name')     # 顯示一對多字段
    gp = serializers.SerializerMethodField()               # 自定義顯示（顯示多對多）
    xxx = serializers.CharField(source='name')             # 也能夠自定義顯示字段名稱

    class Meta:
        model = UserInfo
        # fields = "__all__"
        fields = ["name",'ut','gp','xxx']  # 定義顯示那些字段

    def get_gp(self,row):
        '''row: 傳過來的正是 UserInfo表的對象'''
        gp_obj_list = row.gp.all()  # 獲取用戶全部組
        ret = []
        for item in gp_obj_list:
            ret.append({'id':item.id,'gp':item.group})
        return ret

serializers.ModelSerializer使用

　　三、使用serializers.ModelSerializer 進行數據驗證ide

from rest_framework.views import APIView
from users.serializers.userinfo_serializers import UserInfoSerializer
from users.models import UserInfo

class UserInfoViewSet(APIView):
    def get(self, request, *args, **kwargs):
        obj = UserInfo.objects.all()
        ser = UserInfoSerializer(instance=obj,many=True)
        ret = json.dumps(ser.data,ensure_ascii=False)
        return HttpResponse(ret)

    def post(self, request, *args, **kwargs):
        ser = UserInfoSerializer(data=request.data)          # 驗證，對請求發來的數據進行驗證
        if ser.is_valid():
            print(ser.validated_data)  # post請求數據字典
        else:
            print(ser.errors)  # form驗證錯誤信息
        return HttpResponse(json.dumps({'status':True}))

users/views.py

'''users/serializers/userinfo_serializers.py'''

from rest_framework import serializers
from django.core.exceptions import ValidationError
from users.models import UserInfo

class UserInfoSerializer(serializers.ModelSerializer):
    name = serializers.CharField(min_length=10, error_messages={'required': '該字段必填'})                       # 顯示普通字段
    ut = serializers.CharField(source='ut.type_name',required=False)     # 顯示一對多字段
    gp = serializers.SerializerMethodField(required=False)               # 自定義顯示（顯示多對多）
    xxx = serializers.CharField(source='name', required=False)             # 也能夠自定義顯示字段名稱

    class Meta:
        model = UserInfo
        # fields = "__all__"
        fields = ["name",'ut','gp','xxx']  # 定義顯示那些字段

    # 局部鉤子:
    def validate_name(self, value):  # value 是name字段提交的值
        if value.startswith('sb'):  # 不能以sb開頭
            raise ValidationError('不能以sb開頭')
        else:
            return value

    # 全局鉤子找到了
    def validate(self, value):  # value是全部校驗經過數據的字典
        name = value.get('name')
        if False:
            raise ValidationError('全局鉤子引起異常')
        return value

users/serializers/userinfo_serializers.py

'''一、ser.is_valid()'''
# 驗證post請求中數據是否合法

'''二、全局校驗鉤子'''
def validate(self, value):        # value是全部校驗經過數據的字典

'''三、局部鉤子'''
def validate_name(self, value):   # value 是name字段提交的值

1.4 djangorestframework 分頁返回頂部

　　一、分頁中基本語法

'''一、實例化一個Paginator對象'''
paginator = Paginator(objs, page_size)    # paginator對象

'''二、獲取總數量&總頁數'''
total_count = paginator.count   # 總數量
total = paginator.num_pages     # 總頁數

'''三、使用objs對象獲取指定頁數內容'''
objs = paginator.page(page)

'''四、對分頁後的數據進行序列化操做'''
serializer = Serializer(objs, many=True)    # 序列化操做

　　二、分頁模塊使用舉例

#!/usr/bin/python
# -*- coding: utf-8 -*-
from django.conf import settings
from rest_framework import status
from django.core.paginator import EmptyPage, Paginator, PageNotAnInteger
from rest_framework.views import Response


def Paginators(objs, request, Serializer):
    """
    objs : 實體對象, queryset
    request : 請求對象
    Serializer : 對應實體對象的類
    page_size : 每頁顯示多少條數據
    page  ： 顯示第幾頁數據
    total_count ：總共有多少條數據
    total ：總頁數
    """
    try:
        page_size = int(request.GET.get('page_size', settings.REST_FRAMEWORK['PAGE_SIZE']))
        page = int(request.GET.get('page', 1))
    except (TypeError, ValueError):
        return Response(status=400)

    paginator = Paginator(objs, page_size)    # paginator對象
    total_count = paginator.count
    total = paginator.num_pages    # 總頁數
    try:
        objs = paginator.page(page)
    except PageNotAnInteger:
        objs = paginator.page(1)
    except EmptyPage:
        objs = paginator.page(paginator.num_pages)
    serializer = Serializer(objs, many=True)    # 序列化操做
    return Response(
        data={
            'detail': serializer.data,
            'page': page,
            'page_size': page_size,
            'total': total,
            'total_count': total_count
        }
    )

common/utils/api_paginator.py 自定義分頁模塊

#  分頁
REST_FRAMEWORK = {
    # 全局分頁
    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
    # 關閉api root頁面展現
    'DEFAULT_RENDERER_CLASSES': (
        'rest_framework.renderers.JSONRenderer',
    ),
    'UNICODE_JSON': False,
    # 自定義異常處理
    'EXCEPTION_HANDLER': (
            'common.utils.custom_exception_handler'
        ),
    'PAGE_SIZE': 10
}

settings.py

'''users/serializers/userinfo_serializers.py'''

from rest_framework import serializers
from users.models import UserInfo

class UserInfoSerializer(serializers.Serializer):
    name = serializers.CharField()                         # 顯示普通字段
    ut = serializers.CharField(source='ut.type_name')      # 顯示一對多字段
    gp = serializers.SerializerMethodField()               # 自定義顯示（顯示多對多）
    xxx = serializers.CharField(source='name')             # 也能夠自定義顯示字段名稱

    class Meta:
        model = UserInfo

    def get_gp(self,row):
        '''row: 傳過來的正是 UserInfo表的對象'''
        gp_obj_list = row.gp.all()  # 獲取用戶全部組
        ret = []
        for item in gp_obj_list:
            ret.append({'id':item.id,'gp':item.group})
        return ret

users/serializers/userinfo_serializer.py

''' users/views.py'''

from rest_framework.views import APIView
from rest_framework.views import Response
from users.serializers.userinfo_serializers import UserInfoSerializer
from users.models import UserInfo
from common.utils.api_paginator import Paginators

class UserInfoViewSet(APIView):
    queryset = UserInfo.objects.all().order_by('id')
    serializer_class = UserInfoSerializer

    def get(self, request, *args, **kwargs):
        self.queryset = self.queryset.all()
        ret = Paginators(self.queryset, request, self.serializer_class)
        print(json.dumps(ret.data))  # ret.data 返回的是最終查詢的json數據
        return Response(ret.data)

# http://127.0.0.1:8000/users/info/?page_size=1
'''
{
    "detail": [
        {
            "name": "zhangsan",
            "ut": "學生",
            "gp": [
                {
                    "id": 1,
                    "gp": "group01"
                },
                {
                    "id": 2,
                    "gp": "group02"
                }
            ],
            "xxx": "zhangsan"
        }
    ],
    "page": 1,
    "page_size": 1,
    "total": 3,
    "total_count": 3
}
'''

users/views.py

1.5 JWT：使用djangorestframework-jwt模塊進行用戶身份驗證

　　 安裝： pip install djangorestframework-jwt

　　 添加應用：python manage.py users

　　 官方網站：http://getblimp.github.io/django-rest-framework-jwt/#rest-framework-jwt-auth

　　一、配置使用JWT

########### 一、在INSTALLED_APPS中加入'rest_framework.authtoken', #################
INSTALLED_APPS = [
    '''
    'rest_framework.authtoken',  # 
    '''
]

################### 二、配置jwt驗證 ######################
REST_FRAMEWORK = {
    # 身份認證
    'DEFAULT_AUTHENTICATION_CLASSES': (
        'rest_framework_jwt.authentication.JSONWebTokenAuthentication',
        'rest_framework.authentication.SessionAuthentication',
        'rest_framework.authentication.BasicAuthentication',
    ),
}

import datetime

JWT_AUTH = {
    'JWT_AUTH_HEADER_PREFIX': 'JWT',
    'JWT_EXPIRATION_DELTA': datetime.timedelta(days=1),
}
AUTH_USER_MODEL='users.User'  # 指定使用users APP中的 model User進行驗證

settings.py 配置使用JWT

from django.db import models
from django.contrib.auth.models import AbstractUser


class User(AbstractUser):
    username = models.CharField(max_length=64, unique=True)
    password = models.CharField(max_length=64)
    phone = models.CharField(max_length=64)
    token = models.CharField(max_length=255)

users/models.py 添加用戶認證的User表

#! /usr/bin/env python
# -*- coding: utf-8 -*-
from rest_framework_jwt.settings import api_settings
from rest_framework import serializers
from users.models import User

class UserSerializer(serializers.Serializer):
    username = serializers.CharField()
    password = serializers.CharField()
    phone = serializers.CharField()
    token = serializers.CharField(read_only=True)

    def create(self, data):
        user = User.objects.create(**data)
        user.set_password(data.get('password'))
        user.save()
        # 補充生成記錄登陸狀態的token
        jwt_payload_handler = api_settings.JWT_PAYLOAD_HANDLER
        jwt_encode_handler = api_settings.JWT_ENCODE_HANDLER
        payload = jwt_payload_handler(user)
        token = jwt_encode_handler(payload)
        user.token = token
        return user

users/serializers.py 使用Serializer的create方法建立token

from django.contrib import admin
from django.urls import path,re_path,include
from users import views
from rest_framework_jwt.views import obtain_jwt_token  # 驗證密碼後返回token

urlpatterns = [
    path('admin/', admin.site.urls),
    path('register/', views.RegisterView.as_view(), name='register'),  # 註冊用戶
    path('login/', obtain_jwt_token,name='login'),  # 用戶登陸後返回token
    path('user/list/', views.UserList.as_view(), name='register'),  # 測試須要攜帶token才能訪問
]

urls.py

import json
from rest_framework.views import APIView
from rest_framework.views import Response
from rest_framework.permissions import IsAuthenticated
from rest_framework_jwt.authentication import JSONWebTokenAuthentication
from users.serializers import UserSerializer

# 用戶註冊
class RegisterView(APIView):
    def post(self, request, *args, **kwargs):
        serializer = UserSerializer(data=request.data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data, status=201)
        return Response(serializer.error, status=400)

# 測試必須攜帶token才能訪問接口
class UserList(APIView):
    permission_classes = [IsAuthenticated]  # 接口中加權限
    authentication_classes = [JSONWebTokenAuthentication]

    def get(self,request, *args, **kwargs):
        print(request.META.get('HTTP_AUTHORIZATION', None))
        return Response({'name':'zhangsan'})
    def post(self,request, *args, **kwargs):
        return Response({'name':'zhangsan'})

users/views.py

# 經過用戶token獲取用戶信息
from rest_framework_jwt.utils import jwt_decode_handler
toke_user = jwt_decode_handler(token)
# {'user_id': 2, 'username': 'lisi', 'exp': 1561504444, 'email': ''}