04: DjangoRestFramework使用

梦里梦外; 2021-11-23 16:58 379阅读 0赞

Django其他篇

目录：

  • 1.1 DjangoRestFramework基本使用
  • 1.2 drf认证&权限 模块
  • 1.3 djangorestframework 序列化
  • 1.4 djangorestframework 分页

1.1 DjangoRestFramework基本使用 返回顶部

　　1、回顾CBV基本使用

ContractedBlock.gif ExpandedBlockStart.gif

  1. from django.contrib import admin
  2. from django.urls import path,re_path,include
  4. urlpatterns = [
  5.     path('admin/', admin.site.urls),
  6.     re_path(r'users/',include(('users.urls', 'users'), namespace='users'))
  7. ]

urls.py

ContractedBlock.gif ExpandedBlockStart.gif

  1. from django.contrib import admin
  2. from django.urls import path,re_path,include
  4. urlpatterns = [
  5.     path('admin/', admin.site.urls),
  6.     re_path(r'users/',include(('users.urls', 'users'), namespace='users'))
  7. ]

users/urls.py

ContractedBlock.gif ExpandedBlockStart.gif

  1. import json
  2. from django.shortcuts import render,HttpResponse
  3. from django.views import View
  5. class HomeView(View):
  7.     def dispatch(self, request, *args, **kwargs):
  8.         return super(HomeView, self).dispatch(request, *args, **kwargs)
  10.     def get(self, request):
  11.         return HttpResponse('get')
  13.     def post(self, request):
  14.         return HttpResponse('post')

users/views.py

　　2、安装DjangoRestFramework

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

　　3、DjangoRestFramework 基本使用

ContractedBlock.gif ExpandedBlockStart.gif

  1. from django.contrib import admin
  2. from django.urls import path,re_path,include
  4. urlpatterns = [
  5.     path('admin/', admin.site.urls),
  6.     re_path(r'users/',include(('users.urls', 'users'), namespace='users'))
  7. ]

urls.py

ContractedBlock.gif ExpandedBlockStart.gif

  1. from django.urls import path,re_path,include
  2. from users import views
  4. urlpatterns = [
  5.     re_path(r'info', views.UserInfoViewSet.as_view(), name='user'),
  6. ]

users/urls.py

ContractedBlock.gif ExpandedBlockStart.gif

  1. from rest_framework.views import APIView
  2. from django.http import JsonResponse
  4. class UserInfoViewSet(APIView):
  5.     def __init__(self):
  6.         super(UserInfoViewSet, self).__init__()
  8.     def get(self, request, *args, **kwargs):
  9.         result = {
  10.             'status': True,
  11.             'data': 'response data'
  12.         }
  13.         return JsonResponse(result, status=200)
  15.     def post(self, request, *args, **kwargs):
  16.         result = {
  17.             'status': True,
  18.             'data': 'response data'
  19.         }
  20.         return JsonResponse(result, status=200)

users/views.py

1.2 drf认证&权限 模块 返回顶部

　　1、authentication基本使用

  1. class UserInfoViewSet(APIView):
  2.     authentication_classes = [authentication.IsAuthenticated,]  # 用户认证模块
  3.     permission_classes = (authentication.IsOwnerOrReadOnly,)    # 用户授权模块

ContractedBlock.gif ExpandedBlockStart.gif

  1. from django.contrib import admin
  2. from django.urls import path,re_path,include
  4. urlpatterns = [
  5.     path('admin/', admin.site.urls),
  6.     re_path(r'users/',include(('users.urls', 'users'), namespace='users'))
  7. ]

urls.py

ContractedBlock.gif ExpandedBlockStart.gif

  1. #! /usr/bin/env python
  2. # -*- coding: utf-8 -*-
  3. from django.urls import path,re_path,include
  4. from users import views
  6. urlpatterns = [
  7.     re_path(r'info', views.UserInfoViewSet.as_view(), name='user'),
  8. ]

users/urls.py

ContractedBlock.gif ExpandedBlockStart.gif

  1. from rest_framework.views import APIView
  2. from django.http import JsonResponse
  3. from common.auth import authentication
  5. class UserInfoViewSet(APIView):
  6.     authentication_classes = [authentication.IsAuthenticated,]
  7.     permission_classes = (authentication.IsOwnerOrReadOnly,)
  9.     def __init__(self):
  10.         super(UserInfoViewSet, self).__init__()
  12.     def get(self, request, *args, **kwargs):
  13.         result = {
  14.             'status': True,
  15.             'data': 'response data'
  16.         }
  17.         return JsonResponse(result, status=200)
  19.     def post(self, request, *args, **kwargs):
  20.         result = {
  21.             'status': True,
  22.             'data': 'response data'
  23.         }
  24.         return JsonResponse(result, status=200)

users/views.py

ContractedBlock.gif ExpandedBlockStart.gif

  1. #! /usr/bin/env python
  2. # -*- coding: utf-8 -*-
  3. from rest_framework import authentication
  4. from rest_framework import exceptions
  5. from rest_framework import permissions
  7. class IsOwnerOrReadOnly(permissions.BasePermission):
  8.     def has_permission(self, request, view):
  9.         if False:  # 这里暂且不进行权限验证
  10.             raise exceptions.ParseError('您没有操作的权限')
  11.         return True
  13. class IsAuthenticated(authentication.BaseAuthentication):
  14.     def authenticate(self, request):
  15.         auth = request.META.get('HTTP_AUTHORIZATION', None)  # 获取 header中的 Authorization
  16.         if auth is None:
  17.             raise exceptions.NotAuthenticated()
  19.         '''这里应该是验证token是否合法逻辑'''
  20.         # token = Token.objects.filter(key=auth)
  21.         # try:
  22.         #     request.user = token[0].user
  23.         # except IndexError:
  24.         #     raise exceptions.NotAuthenticated('Invalid input Authenticated')
  25.         return (request, None)
  27.     def authenticate_header(self, request):
  28.         msg = 'Invalid token.Please get token first'
  29.         return exceptions.NotAuthenticated(msg)

common\auth\authentication.py

　　2、测试接口

　　　　　　1080958-20190607135327292-1123245917.png

1.3 djangorestframework 序列化 返回顶部

　　　　1080958-20190608123957991-1767044880.png 1080958-20190608124145607-1381834048.png 1080958-20190608124345627-376045533.png 1080958-20190608124755552-78905349.png

　　1、序列化使用举例（serializers.Serializer）

  1. '''1、ser = UserInfoSerializer(instance=obj,many=True)'''
  2. # 对查询实例进行序列化 # ser.data 获取序列化后的json格式数据
  4. '''2、定义显示的字段''' name = serializers.CharField()                         # 显示普通字段
  5. ut = serializers.CharField(source='ut.type_name')      # 显示一对多字段
  6. gp = serializers.SerializerMethodField()               # 自定义显示（显示多对多）
  7. xxx = serializers.CharField(source='name')             # 也可以自定义显示字段名称

ContractedBlock.gif ExpandedBlockStart.gif

  1. from django.contrib import admin
  2. from django.urls import path,re_path,include
  4. urlpatterns = [
  5.     path('admin/', admin.site.urls),
  6.     re_path(r'users/',include(('users.urls', 'users'), namespace='users'))
  7. ]

urls.py

ContractedBlock.gif ExpandedBlockStart.gif

  1. '''users/urls.py'''
  3. from django.urls import path,re_path
  4. from users import views
  6. urlpatterns = [
  7.     re_path(r'^info/$', views.UserInfoViewSet.as_view(), name='userinfo'),
  8. ]

users/urls.py

ContractedBlock.gif ExpandedBlockStart.gif

  1. '''users/models.py'''
  3. from __future__ import unicode_literals
  4. from django.db import models
  6. class UserInfo(models.Model):
  7.     name = models.CharField(max_length=64,unique=True)
  8.     ut = models.ForeignKey(to='UserType', on_delete=models.CASCADE)
  9.     gp = models.ManyToManyField(to='UserGroup')
  11. class UserType(models.Model):
  12.     type_name = models.CharField(max_length=64,unique=True)
  14. class UserGroup(models.Model):
  15.     group = models.CharField(max_length=64)

users/models.py

ContractedBlock.gif ExpandedBlockStart.gif

  1. ''' users/views.py'''
  3. from rest_framework.views import APIView
  4. from rest_framework.views import Response
  5. from users.serializers.userinfo_serializers import UserInfoSerializer
  6. from users.models import UserInfo
  8. class UserInfoViewSet(APIView):
  9.     def get(self, request, *args, **kwargs):
  10.         obj = UserInfo.objects.all()
  11.         ser = UserInfoSerializer(instance=obj,many=True)
  12.         # ret = json.dumps(ser.data,ensure_ascii=False)
  13.         # return HttpResponse(ret)
  14.         return Response(ser.data, status=200)
  16. '''
  17. [{
  18.     "name": "zhangsan",
  19.     "ut": "学生",
  20.     "gp": [{
  21.         "id": 1,
  22.         "gp": "group01"
  23.     }, {
  24.         "id": 2,
  25.         "gp": "group02"
  26.     }],
  27.     "xxx": "zhangsan"
  28. }, {
  29.     "name": "lisi",
  30.     "ut": "学生",
  31.     "gp": [{
  32.         "id": 1,
  33.         "gp": "group01"
  34.     }],
  35.     "xxx": "lisi"
  36. }]

users/views.py

  1. '''users/serializers/userinfo_serializers.py'''
  3. from rest_framework import serializers
  4. from users.models import UserInfo
  6. class UserInfoSerializer(serializers.Serializer):
  7.     name = serializers.CharField()                         # 显示普通字段
  8.     ut = serializers.CharField(source='ut.type_name')      # 显示一对多字段
  9.     gp = serializers.SerializerMethodField()               # 自定义显示（显示多对多）
  10.     xxx = serializers.CharField(source='name')             # 也可以自定义显示字段名称
  12.     class Meta:
  13.         model = UserInfo
  15.     def get_gp(self,row):
  16.         '''row: 传过来的正是 UserInfo表的对象'''
  17.         gp_obj_list = row.gp.all()  # 获取用户所有组
  18.         ret = []
  19.         for item in gp_obj_list:
  20.             ret.append({
  21.      'id':item.id,'gp':item.group})
  22.         return ret

　　2、序列化使用举例（serializers.ModelSerializer）

　　　　　　1. ModelSerializer本质是继承了Serielizer类添加了部分功能

　　　　　　2. 在使用上ModelSerializer可以使用 fields = ‘__all__‘ 定义要显示的字段

ContractedBlock.gif ExpandedBlockStart.gif

  1. '''users/serializers/userinfo_serializers.py'''
  3. from rest_framework import serializers
  4. from users.models import UserInfo
  6. class UserInfoSerializer(serializers.ModelSerializer):
  7.     # name = serializers.CharField()                       # 显示普通字段
  8.     ut = serializers.CharField(source='ut.type_name')     # 显示一对多字段
  9.     gp = serializers.SerializerMethodField()               # 自定义显示（显示多对多）
  10.     xxx = serializers.CharField(source='name')             # 也可以自定义显示字段名称
  12.     class Meta:
  13.         model = UserInfo
  14.         # fields = "__all__"
  15.         fields = ["name",'ut','gp','xxx']  # 定义显示那些字段
  17.     def get_gp(self,row):
  18.         '''row: 传过来的正是 UserInfo表的对象'''
  19.         gp_obj_list = row.gp.all()  # 获取用户所有组
  20.         ret = []
  21.         for item in gp_obj_list:
  22.             ret.append({
  23.       'id':item.id,'gp':item.group})
  24.         return ret

serializers.ModelSerializer使用

　　3、使用serializers.ModelSerializer 进行数据验证

ContractedBlock.gif ExpandedBlockStart.gif

  1. from rest_framework.views import APIView
  2. from users.serializers.userinfo_serializers import UserInfoSerializer
  3. from users.models import UserInfo
  5. class UserInfoViewSet(APIView):
  6.     def get(self, request, *args, **kwargs):
  7.         obj = UserInfo.objects.all()
  8.         ser = UserInfoSerializer(instance=obj,many=True)
  9.         ret = json.dumps(ser.data,ensure_ascii=False)
  10.         return HttpResponse(ret)
  12.     def post(self, request, *args, **kwargs):
  13.         ser = UserInfoSerializer(data=request.data)          # 验证，对请求发来的数据进行验证
  14.         if ser.is_valid():
  15.             print(ser.validated_data)  # post请求数据字典
  16.         else:
  17.             print(ser.errors)  # form验证错误信息
  18.         return HttpResponse(json.dumps({
  19.      'status':True}))

users/views.py

ContractedBlock.gif ExpandedBlockStart.gif

  1. '''users/serializers/userinfo_serializers.py'''
  3. from rest_framework import serializers
  4. from django.core.exceptions import ValidationError
  5. from users.models import UserInfo
  7. class UserInfoSerializer(serializers.ModelSerializer):
  8.     name = serializers.CharField(min_length=10, error_messages={
  9.      'required': '该字段必填'})                       # 显示普通字段
  10.     ut = serializers.CharField(source='ut.type_name',required=False)     # 显示一对多字段
  11.     gp = serializers.SerializerMethodField(required=False)               # 自定义显示（显示多对多）
  12.     xxx = serializers.CharField(source='name', required=False)             # 也可以自定义显示字段名称
  14.     class Meta:
  15.         model = UserInfo
  16.         # fields = "__all__"
  17.         fields = ["name",'ut','gp','xxx']  # 定义显示那些字段
  19.     # 局部钩子:
  20.     def validate_name(self, value):  # value 是name字段提交的值
  21.         if value.startswith('sb'):  # 不能以sb开头
  22.             raise ValidationError('不能以sb开头')
  23.         else:
  24.             return value
  26.     # 全局钩子找到了
  27.     def validate(self, value):  # value是所有校验通过数据的字典
  28.         name = value.get('name')
  29.         if False:
  30.             raise ValidationError('全局钩子引发异常')
  31.         return value

users/serializers/userinfo_serializers.py

  1. '''1、ser.is_valid()'''
  2. # 验证post请求中数据是否合法
  4. '''2、全局校验钩子'''
  5. def validate(self, value):        # value是所有校验通过数据的字典
  7. '''3、局部钩子'''
  8. def validate_name(self, value):   # value 是name字段提交的值

1.4 djangorestframework 分页 返回顶部

　　1、分页中基本语法

  1. '''1、实例化一个Paginator对象'''
  2. paginator = Paginator(objs, page_size)    # paginator对象
  4. '''2、获取总数量&总页数'''
  5. total_count = paginator.count   # 总数量
  6. total = paginator.num_pages     # 总页数
  8. '''3、使用objs对象获取指定页数内容'''
  9. objs = paginator.page(page)
  11. '''4、对分页后的数据进行序列化操作'''
  12. serializer = Serializer(objs, many=True)    # 序列化操作

　　2、分页模块使用举例

ContractedBlock.gif ExpandedBlockStart.gif

  1. #!/usr/bin/python
  2. # -*- coding: utf-8 -*-
  3. from django.conf import settings
  4. from rest_framework import status
  5. from django.core.paginator import EmptyPage, Paginator, PageNotAnInteger
  6. from rest_framework.views import Response
  9. def Paginators(objs, request, Serializer):
  10.     """
  11.     objs : 实体对象, queryset
  12.     request : 请求对象
  13.     Serializer : 对应实体对象的类
  14.     page_size : 每页显示多少条数据
  15.     page  ： 显示第几页数据
  16.     total_count ：总共有多少条数据
  17.     total ：总页数
  18.     """
  19.     try:
  20.         page_size = int(request.GET.get('page_size', settings.REST_FRAMEWORK['PAGE_SIZE']))
  21.         page = int(request.GET.get('page', 1))
  22.     except (TypeError, ValueError):
  23.         return Response(status=400)
  25.     paginator = Paginator(objs, page_size)    # paginator对象
  26.     total_count = paginator.count
  27.     total = paginator.num_pages    # 总页数
  28.     try:
  29.         objs = paginator.page(page)
  30.     except PageNotAnInteger:
  31.         objs = paginator.page(1)
  32.     except EmptyPage:
  33.         objs = paginator.page(paginator.num_pages)
  34.     serializer = Serializer(objs, many=True)    # 序列化操作
  35.     return Response(
  36.         data={
  37.             'detail': serializer.data,
  38.             'page': page,
  39.             'page_size': page_size,
  40.             'total': total,
  41.             'total_count': total_count
  42.         }
  43.     )

common/utils/api_paginator.py 自定义分页模块

ContractedBlock.gif ExpandedBlockStart.gif

  1. #  分页
  2. REST_FRAMEWORK = {
  3.     # 全局分页
  4.     'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
  5.     # 关闭api root页面展示
  6.     'DEFAULT_RENDERER_CLASSES': (
  7.         'rest_framework.renderers.JSONRenderer',
  8.     ),
  9.     'UNICODE_JSON': False,
  10.     # 自定义异常处理
  11.     'EXCEPTION_HANDLER': (
  12.             'common.utils.custom_exception_handler'
  13.         ),
  14.     'PAGE_SIZE': 10
  15. }

settings.py

ContractedBlock.gif ExpandedBlockStart.gif

  1. '''users/serializers/userinfo_serializers.py'''
  3. from rest_framework import serializers
  4. from users.models import UserInfo
  6. class UserInfoSerializer(serializers.Serializer):
  7.     name = serializers.CharField()                         # 显示普通字段
  8.     ut = serializers.CharField(source='ut.type_name')      # 显示一对多字段
  9.     gp = serializers.SerializerMethodField()               # 自定义显示（显示多对多）
  10.     xxx = serializers.CharField(source='name')             # 也可以自定义显示字段名称
  12.     class Meta:
  13.         model = UserInfo
  15.     def get_gp(self,row):
  16.         '''row: 传过来的正是 UserInfo表的对象'''
  17.         gp_obj_list = row.gp.all()  # 获取用户所有组
  18.         ret = []
  19.         for item in gp_obj_list:
  20.             ret.append({
  21.       'id':item.id,'gp':item.group})
  22.         return ret

users/serializers/userinfo_serializer.py

ContractedBlock.gif ExpandedBlockStart.gif

  1. ''' users/views.py'''
  3. from rest_framework.views import APIView
  4. from rest_framework.views import Response
  5. from users.serializers.userinfo_serializers import UserInfoSerializer
  6. from users.models import UserInfo
  7. from common.utils.api_paginator import Paginators
  9. class UserInfoViewSet(APIView):
  10.     queryset = UserInfo.objects.all().order_by('id')
  11.     serializer_class = UserInfoSerializer
  13.     def get(self, request, *args, **kwargs):
  14.         self.queryset = self.queryset.all()
  15.         ret = Paginators(self.queryset, request, self.serializer_class)
  16.         print(json.dumps(ret.data))  # ret.data 返回的是最终查询的json数据
  17.         return Response(ret.data)
  19. # http://127.0.0.1:8000/users/info/?page_size=1
  20. '''
  21. {
  22.     "detail": [
  23.         {
  24.             "name": "zhangsan",
  25.             "ut": "学生",
  26.             "gp": [
  27.                 {
  28.                     "id": 1,
  29.                     "gp": "group01"
  30.                 },
  31.                 {
  32.                     "id": 2,
  33.                     "gp": "group02"
  34.                 }
  35.             ],
  36.             "xxx": "zhangsan"
  37.         }
  38.     ],
  39.     "page": 1,
  40.     "page_size": 1,
  41.     "total": 3,
  42.     "total_count": 3
  43. }
  44. '''

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

　　1、配置使用JWT

ContractedBlock.gif ExpandedBlockStart.gif

  1. ########### 1、在INSTALLED_APPS中加入'rest_framework.authtoken', #################
  2. INSTALLED_APPS = [
  3.     '''
  4.     'rest_framework.authtoken',  # 
  5.     '''
  6. ]
  8. ################### 2、配置jwt验证 ######################
  9. REST_FRAMEWORK = {
  10.     # 身份认证
  11.     'DEFAULT_AUTHENTICATION_CLASSES': (
  12.         'rest_framework_jwt.authentication.JSONWebTokenAuthentication',
  13.         'rest_framework.authentication.SessionAuthentication',
  14.         'rest_framework.authentication.BasicAuthentication',
  15.     ),
  16. }
  18. import datetime
  20. JWT_AUTH = {
  21.     'JWT_AUTH_HEADER_PREFIX': 'JWT',
  22.     'JWT_EXPIRATION_DELTA': datetime.timedelta(days=1),
  23. }
  24. AUTH_USER_MODEL='users.User'  # 指定使用users APP中的 model User进行验证

settings.py配置使用JWT

ContractedBlock.gif ExpandedBlockStart.gif

  1. from django.db import models
  2. from django.contrib.auth.models import AbstractUser
  5. class User(AbstractUser):
  6.     username = models.CharField(max_length=64, unique=True)
  7.     password = models.CharField(max_length=64)
  8.     phone = models.CharField(max_length=64)
  9.     token = models.CharField(max_length=255)

users/models.py 添加用户认证的User表

ContractedBlock.gif ExpandedBlockStart.gif

  1. #! /usr/bin/env python
  2. # -*- coding: utf-8 -*-
  3. from rest_framework_jwt.settings import api_settings
  4. from rest_framework import serializers
  5. from users.models import User
  7. class UserSerializer(serializers.Serializer):
  8.     username = serializers.CharField()
  9.     password = serializers.CharField()
  10.     phone = serializers.CharField()
  11.     token = serializers.CharField(read_only=True)
  13.     def create(self, data):
  14.         user = User.objects.create(**data)
  15.         user.set_password(data.get('password'))
  16.         user.save()
  17.         # 补充生成记录登录状态的token
  18.         jwt_payload_handler = api_settings.JWT_PAYLOAD_HANDLER
  19.         jwt_encode_handler = api_settings.JWT_ENCODE_HANDLER
  20.         payload = jwt_payload_handler(user)
  21.         token = jwt_encode_handler(payload)
  22.         user.token = token
  23.         return user

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

ContractedBlock.gif ExpandedBlockStart.gif

  1. from django.contrib import admin
  2. from django.urls import path,re_path,include
  3. from users import views
  4. from rest_framework_jwt.views import obtain_jwt_token  # 验证密码后返回token
  6. urlpatterns = [
  7.     path('admin/', admin.site.urls),
  8.     path('register/', views.RegisterView.as_view(), name='register'),  # 注册用户
  9.     path('login/', obtain_jwt_token,name='login'),  # 用户登录后返回token
  10.     path('user/list/', views.UserList.as_view(), name='register'),  # 测试需要携带token才能访问
  11. ]

urls.py

ContractedBlock.gif ExpandedBlockStart.gif

  1. import json
  2. from rest_framework.views import APIView
  3. from rest_framework.views import Response
  4. from rest_framework.permissions import IsAuthenticated
  5. from rest_framework_jwt.authentication import JSONWebTokenAuthentication
  6. from users.serializers import UserSerializer
  8. # 用户注册
  9. class RegisterView(APIView):
  10.     def post(self, request, *args, **kwargs):
  11.         serializer = UserSerializer(data=request.data)
  12.         if serializer.is_valid():
  13.             serializer.save()
  14.             return Response(serializer.data, status=201)
  15.         return Response(serializer.error, status=400)
  17. # 测试必须携带token才能访问接口
  18. class UserList(APIView):
  19.     permission_classes = [IsAuthenticated]  # 接口中加权限
  20.     authentication_classes = [JSONWebTokenAuthentication]
  22.     def get(self,request, *args, **kwargs):
  23.         print(request.META.get('HTTP_AUTHORIZATION', None))
  24.         return Response({
  25.      'name':'zhangsan'})
  26.     def post(self,request, *args, **kwargs):
  27.         return Response({
  28.      'name':'zhangsan'})

users/views.py

　　1080958-20190617224344976-736249891.png 1080958-20190617224458449-467928512.png 1080958-20190617224728406-311632406.png 

  1. # 通过用户token获取用户信息
  2. from rest_framework_jwt.utils import jwt_decode_handler
  3. toke_user = jwt_decode_handler(token)
  4. # {'user_id': 2, 'username': 'lisi', 'exp': 1561504444, 'email': ''}

1111

转载于:https://www.cnblogs.com/xiaonq/p/10987889.html

发表评论

表情：
评论列表 （有 0 条评论，379人围观）

还没有评论，来说两句吧...

相关阅读