Django：DjangoRestFramework drf 开发2

最新推荐文章于 2024-07-27 12:20:46 发布

程序员老五

最新推荐文章于 2024-07-27 12:20:46 发布

阅读量186

点赞数

分类专栏： Django rest framework 文章标签： python django json orm restful

本文链接：https://blog.csdn.net/weixin_45579026/article/details/110951372

版权

Django rest framework 专栏收录该内容

9 篇文章 0 订阅

订阅专栏

4. 明确REST接口开发的核心任务

1. 序列化

将模型类对象转换成字典(将程序中的一个数据结构类型转换为其他格式(字典、JSON、XML等))
使用范围：查询、增加、修改
“我们把我们的东西给别人”

2. 反系列化

接收数据，验证并处理（把原来的对象转成新的对象）
“别人把数据给我们，我们接收验证和处理”

小结：

例: 我们的位置：服务器程序员
- 序列化：将Django中的数据输出到响应报文，给前端
- 反序列化：接收请求报文中的数据（前端传过来的），验证

5. Djangorestframework的开发

1. 安装DRF

	pip install djangorestframework

2. 添加rest_framework应用

project–>settings.py–>INSTALLED_APPS

INSTALLED_APPS = [
	 ...
    'rest_framework',
]

3. 注释CSRF跨域

MIDDLEWARE = [
	......
    # 'django.middleware.csrf.CsrfViewMiddleware',
    ......

4. drf开发模块：

视图
路由
序列化

5. drf开发模块

该模块是restful向序列化的过渡模块，无需特殊记忆，后续会对模型类序列化器做详细介绍

1. 编写路由

urls.py

from . import views
from rest_framework.routers import DefaultRouter

urlpatterns = []
router = DefaultRouter()
# books指匹配的路由规则，跟之前的普通路由是一样的，127.0.0.1:8000/books/；也可以换成其他的；
# basename随便起，我起的是子应用的名
router.register('books', views.BookModelViewSet, basename='book')
urlpatterns += router.urls

2. 序列化器

serializer.py

from rest_framework import serializers
from .models import Books

class BookSerializer(serializers.ModelSerializer):
    class Meta:
        model = Books  # 指定模型类（orm模型类）
        fields = '__all__'  # 默认所有字段

3. 视图函数

views.py

from rest_framework.viewsets import ModelViewSet
from .serializer import BookSerializer
from .model import Books

class BookModelViewSet(ModelViewSet):
   queryset = Books.objects.all()
   serializer_class = BookSerializer

这样跟标题3里的具体实现增删改查5项功能实现是一样的，因为ModelViewSet封装了这些方法。

6. 序列化器

1. 序列化概念

将python中的对象转换成字典并输出

2. 序列化器的作用

进行数据的校验
对数据对象进行转换

3. 序列化操作

1. 创建序列化器（参照模型类）

serializers.py

from rest_framework import serializers

class BooksSerializer(serializers.Serializer):
    """ 图书序列化器 """
    id = serializers.IntegerField()
    book_name = serializers.CharField()
    author = serializers.CharField()
    type = serializers.CharField()
    published_date = serializers.DateField()
    date_joined = serializers.DateField()

2. 创建序列化器对象（以模型类对象为参数）

views.py

book = Books.objects.get(pk=pk)
# 不需要指定many=True是因为上边的查询得到的类型：<class 'book.models.Books'> 是个对象，不是查询集列表
book_serializer = BooksSerializer(book)
# 上边这行代码可以把下边的代码块替换：
book_dict = {
          'id': book.id,
          'book_name': book.book_name,
          'author': book.author,
          'type': book.type,
          'published_date': book.published_date,
          'date_joined': book.date_joined
      }

3. 调用序列化器对象的data属性获取字典

book_dict = book_serializer.data

4. 参数many=True 当参数为模型类对象列表时需要指定

# 模型类对象列表: book = Books.objects.all() 查询类型得到：<class 'django.db.models.query.QuerySet'> 是个查询集列表
book_serializer = BooksSerializer(book, many=True)
# 上边这行代码可以把下边的代码块替换：
book_info = []
for book in book_obj:
    book_info.append({
        'id': book.id,
        'book_name': book.book_name,
        'author': book.author,
        'type': book.type,
        'published_date': book.published_date,
        'date_joined': book.date_joined
    })

4. 关系属性序列化

1. 在英雄模型类中定义外键(ForeignKey): hbook

2. 根据外键可知

在英雄模型类中有属性hbook_id，类型为int
在图书模型类中有属性heroinfo_set，表示相关的英雄

3. 关系属性有三种输出方案（ 先定义后使用 ）

主键：

将关系属性相关对象的主键PrimaryKey输出

 hbook = serializers.PrimaryKeyRelatedField(read_only=True)

2. 字符串：

将关系属性相关对象转成字符串输出，会调用str方法，str返回什么就输出什么
```
 hbook = serializers.StringRelatedField(read_only=True)
```

3. 自定义

调用关系属性的自定义序列化

 hbook = BookSerializer(read_only=True)

说明：

关系属性是只读的，需要指定read_only=True参数
在一端（多对一）的关系属性关联多个对象，需要指定 many=True

4. 关系属性说明：

（在定义外键的模型类A中添加related_name，可以在对应的序列化器B中使用关系属性）

Heros模型类中外键book_hero定义related_name：

 hero_book = models.ForeignKey(Books, related_name='hero', on_delete=models.CASCADE, verbose_name='所属图书')

Book序列化器中可以直接使用hero字段当成关系属性进行输出：

 hero = serializers.PrimaryKeyRelatedField(read_only=True, many=True)
 hero = serializers.StringRelatedField(read_only=True, many=True)
 hero = BookSerializer(read_only=True, many=True)

5. 定义Serializer序列化器

1. 定义方法

Django REST framework中的Serializer使用类来定义，须继承自

rest_framework.serializers.Serializer。

说明：

与模型类对应，属性名称相同，类型对应
根据需要(需求)定义属性，不需要把所有字段都写上
serializer不是只能为数据库模型类定义，也可以为非数据库模型类的数据定义。serializer是独立于数据库之外的存在

2. 字段与选项

字段类型:
- 常用的有CharField、IntegerField、DateField 等
- 字段类型列表

字段	字段构造方式
BooleanField	BooleanField()
NullBooleanField	NullBooleanField()
CharField	CharField(max_length=None, min_length=None, allow_blank=False, trim_whitespace=True)
EmailField	EmailField(max_length=None, min_length=None, allow_blank=False)
RegexField	RegexField(regex, max_length=None, min_length=None, allow_blank=False)
SlugField	SlugField(maxlength=50, min_length=None, allow_blank=False) 正则字段，验证正则模式 [a-zA-Z0-9-]+
URLField	URLField(max_length=200, min_length=None, allow_blank=False)
UUIDField	UUIDField(format=‘hex_verbose’) format：① ‘hex_verbose’ 如"5ce0e9a5-5ffa-654b-cee0-1238041fb31a" ② ‘hex’ 如 “5ce0e9a55ffa654bcee01238041fb31a” ③ ‘int’ - 如: “123456789012312313134124512351145145114” ④ ‘urn’ 如: “urn:uuid:5ce0e9a5-5ffa-654b-cee0-1238041fb31a”
IPAddressField	IPAddressField(protocol=‘both’, unpack_ipv4=False, **options)
IntegerField	IntegerField(max_value=None, min_value=None)
FloatField	FloatField(max_value=None, min_value=None)
DecimalField	DecimalField(max_digits, decimal_places, coerce_to_string=None, max_value=None, min_value=None) max_digits: 最多位数 decimal_palces: 小数点位置
DateTimeField	DateTimeField(format=api_settings.DATETIME_FORMAT,input_formats=None)
DateField	DateField(format=api_settings.DATE_FORMAT, input_formats=None)
TimeField	TimeField(format=api_settings.TIME_FORMAT, input_formats=None)
DurationField	DurationField()
ChoiceField	ChoiceField(choices) choices与Django的用法相同
MultipleChoiceField	MultipleChoiceField(choices)
FileField	FileField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL)
ImageField	ImageField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL)
ListField	ListField(child=, min_length=None, max_length=None)
DictField	DictField(child=)

选项参数：

参数名称	作用
max_length	最大长度
min_lenght	最小长度
allow_blank	是否允许为空
trim_whitespace	是否截断空白字符
max_value	最小值
min_value	最大值

通用参数:

参数名称	说明
read_only	表明该字段仅用于序列化输出，默认False
write_only	表明该字段仅用于反序列化输入，默认False
required	表明该字段在反序列化时必须输入，默认True
default	反序列化时使用的默认值
allow_null	表明该字段是否允许传入None，默认False
validators	该字段使用的验证器
error_messages	包含错误编号与错误信息的字典
label	用于HTML展示API页面时，显示的字段名称
help_text	用于HTML展示API页面时，显示的字段帮助提示信息

3. 创建Serializer对象

Serializer的构造方法为：

Serializer(instance=None, data=empty, **kwarg)

说明：

用于序列化时，将模型类对象传入instance参数
用于反序列化时，将要被反序列化的数据传入data参数
除了instance和data参数外，在构造Serializer对象时，还可通过context参数额外添加数据，如
```
 serializer = AccountSerializer(account, context={'request': request})
```
通过context参数附加的数据，可以通过Serializer对象的context属性获取。

如有不足，请多指教！

程序员老五

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
打赏
0
评论
Django：DjangoRestFramework drf 开发2

4. 明确REST接口开发的核心任务1. 序列化将模型类对象转换成字典(将程序中的一个数据结构类型转换为其他格式(字典、JSON、XML等))使用范围：查询、增加、修改“我们把我们的东西给别人”2. 反系列化接收数据，验证并处理（把原来的对象转成新的对象）“别人把数据给我们，我们接收验证和处理”小结：例: 我们的位置：服务器程序员序列化：将Django中的数据输出到响应报文，给前端反序列化：接收请求报文中的数据（前端传过来的），验证5.
复制链接

扫一扫