Django REST Framework笔记 (二) 自定义序列化器介绍及基于FBV的视图处理方法

第一集：《(一)django Rest Framework简单理解&练习创建项目》
第二集：《(二)序列化介绍及基于函数的API》

API的简单描述

# 接口描述 用户列表
# 接口地址 http://127.0.0.1:8000/api/user
# 请求方式 POST GET 
# 返回参数 JSON格式的用户列表及状态码

# 接口描述 用户详情
# 接口地址 http://127.0.0.1:8000/api/user/{id}
# 请求方式 GET, PUT, DELETE
# 返回参数 用户详情及状态码(GET, PUT) 状态码(DELETE)

标题中之所以叫自定义序列化器，是因为必须得自定义，通俗点将，序列化器都是继承类来实现的。

前面一章《(一)django Rest Framework简单理解&练习创建项目》已经创建了项目、模型和数据，现在直接进入主题。

写接口往往都是从自定义序列化器开始的，序列化器的作用是把模型实例（如用户列表、用户详情）序列化和反序列化为如JSON格式的数据。不过，一个用户的详情还会包含密码，密码是不可能传输到前端去的，所以我们可以简单理解为并非所有的数据都需要序列化传输到前端，DRF的序列化器还可以定义序列化哪些字段。

编写好序列化器，在对应的view中调用就可以了，可简单理解为：
GET请求时：requests -> view -> 数据库读数据 -> 数据经过序列化器处理(序列化) -> 响应
POST请求或其他请求： request -> view -> 前端传过来的已被序列化的数据，序列化器处理(反序列化) -> 数据库保存 -> 响应

使用Serializers类自定义序列化器

使用这个类来创建序列化器，要做的工作会多一些，要自定义每一个字段。
在项目的user下创建文件：serializers.py，user相关的序列化器全部写在里面。

from enum import unique
from rest_framework import serializers
from .models import User, Company

# serializers.Seriazers处理办法
class UserSerializer(serializers.Serializer):
    id = serializers.IntegerField(read_only=True)
    user_name = serializers.CharField(max_length=20) 
    nick_name = serializers.CharField(max_length=30) 
    # password = serializers.CharField(max_length=20) password不传输到前台
    company = serializers.CharField(source='company_id')

    def create(self, validated_data):
        """
        创建一个用户
        """
        return User.objects.create(**validated_data)
    
    def update(self, instance ,validate_data):
        """
        更新一个用户信息
        para: instance 要修改的实例
        para: validate_data 要修改的数据，为views中的reqeust.data，是一个字典
        """
        instance.user_name = validate_data.get('user_name', instance.user_name)
        instance.nick_name = validate_data.get('nick_name', instance.nick_name)
        instance.company = validate_data.get('company', instance.company) #company是外键，在views中已经将request.data['company']的值换成了company的实例，请异步下方的views中的代码
        instance.save()
        return instance

编写views和urls

#views.py
from django.db.models.query import RawQuerySet
from django.shortcuts import render
from rest_framework.serializers import Serializer
from . models import User, Company

from rest_framework.decorators import api_view
from rest_framework.response import Response
from . serializers import UserSerializer

@api_view(['GET', 'POST', 'PUT']) #装饰器声明该函数只接受三种请求
def users_list(request):
    if request.method == 'GET':
        users = User.objects.all()
        serializer = UserSerializer(users, many=True)#many为True时接受返回多条数据
        return Response(serializer.data, 200)
    
    if request.method == 'POST':
        serializer = UserSerializer(data=request.data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data, 201)
        return Response(serializer.errors, 400)
    
    if request.method == 'PUT':
        print(request.data)
        user = User.objects.get(id=request.data['id'])
        serializer = UserSerializer(data=request.data)
        if serializer.is_valid():
        	#company是外键，这里要给序列化器传入外键实例才可以，只传入外键的id，序列化器是没办法处理的，会出错，所以下方使用data['company'] = company来替换原来的"company": id。
            company = Company.objects.get(id=request.data['company'])
            data = request.data
            data['company'] = company
            serializer.update(user, data)
            return Response(serializer.data, 200)
        return Response(serializer.errors, 400)

#总路由
from django.contrib import admin
from django.urls import path, include
from user.models import User

urlpatterns = [
    path('admin/', admin.site.urls),
    path('api/', include('user.urls')),
]

#子路由
from django.urls import path
from .views import users_list

urlpatterns = [
    path('user/', users_list),
]

使用ApiPost（支持国产）发起请求http://127.0.0.1:8000/api/user/ 。

• GET请求
  
• POST请求
  
• PUT请求(修改)
  

Serializers这个类比较基础，使用起来代码量较多，可以使用ModelSerializers，这个类类似于ModelForm，更少的代码量，更规范的写法。

使用ModelSerializers类自定义序列化器

使用ModelSerializers，同样的能力可以实现代码更精简。这个类和Serializers写了该库的同一个文件中，这个可以通过编辑器查看。

• 序列化器

class UserModelSerializer(serializers.ModelSerializer):
    class Meta:
        model = User
        exclude = ['password']
        readonly = ('id', )
#简单到没朋友

• views

#使用UserModelSerializer序列化器 都是基于FBV的，处理办法和上面的一样
@api_view(['GET', 'POST'])
def user_new_list(request):
    """
        处理用户列表请求和新增用户请求
    """
    if request.method == 'GET':
        users = User.objects.all()
        serializer = UserModelSerializer(users, many=True)
        return Response(serializer.data, 200)
    if request.method == 'POST':
        serializer = UserModelSerializer(data=request.data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data, 200)
        return Response(serializer.error, 400)

@api_view(['GET', 'DELETE', 'PUT'])
def user_deltail(request, user_id):
    """
        处理单个用户详情的请求、编辑单个用户资料及删除单个用户的请求
    """
    try:
        user = User.objects.get(id=user_id)
    except User.DoesNotExist:
        return Response(status=status.HTTP_404_NOT_FOUND)

    if request.method == 'GET':
        serializer = UserModelSerializer(user)
        return Response(serializer.data)

    if request.method == 'PUT':
        serialize = UserModelSerializer(user, data=request.data) #传入实例和实例要修改的数据
        if serialize.is_valid():
            serialize.save()
            return Response(serialize.data, 200)
        return Response(serialize.errors, status=status.HTTP_400_BAD_REQUEST)
    
    if request.method == 'DELETE':
        user.delete()
        return Response('删除成功' ,status=status.HTTP_204_NO_CONTENT)

• urls

	#其他省略
    path('v2/user/', user_new_list),
    path('v2/user/<int:user_id>', user_deltail),

CURD都没问题。

总结：以上方法都基于FBV，代码量还是很多，接下来学习基于CBV的，可极大地精简代码量。