django-rest-framework的第一级别

最新推荐文章于 2024-04-12 04:03:50 发布

啊了个呜

最新推荐文章于 2024-04-12 04:03:50 发布

阅读量141

点赞数

分类专栏： python develop 文章标签： python django

本文链接：https://blog.csdn.net/weixin_46129834/article/details/106186009

版权

python develop 专栏收录该内容

104 篇文章 2 订阅

订阅专栏

django-rest-framework的第一级别

这篇博客将会介绍django-rest-framework 的第二个开发案例，使用的是django-rest-framwork的第一级别。虽然我们现在已经不用以前级别的django-rest-framework, 之所以要从低级别开始讲起,主要是要介绍它的原理，对它进行更深层次的理解。

一. 创建初始项目并在settings.py里面加入rest_framework

#找一个自己的路径创建装项目的文件夹：
mkdir project 
cd project
#创建一个名为helloworld的项目
django-admin startproject  tutorial
cd tutorial
#创建一个名为quickstart的APP
python manage.py startapp snippets

#创建超级用户
python manage.py createsuperuser
#启动项目
python manage.py runserver

具体细节参考上一篇博客，这里不赘述了。

二. snippets/models.py

from django.db import models
from pygments.lexers import get_all_lexers
from pygments.styles import get_all_styles

LEXERS = [item for item in get_all_lexers() if item[1]]
LANGUAGE_CHOICES = sorted([(item[1][0], item[0]) for item in LEXERS])
STYLE_CHOICES = sorted([(item, item) for item in get_all_styles()])


class Snippet(models.Model):
    created = models.DateTimeField(auto_now_add=True)
    title = models.CharField(max_length=100, blank=True, default='')
    code = models.TextField()
    linenos = models.BooleanField(default=False)
    language = models.CharField(choices=LANGUAGE_CHOICES, default='python', max_length=100)
    style = models.CharField(choices=STYLE_CHOICES, default='friendly', max_length=100)

    class Meta:
        ordering = ['created']

#迁移数据库
python manage.py makemigrations
python manage.py migrate

三. 在snippets下创建serializers.py文件

为什么会有序列器的存在呢？序列器就是做序列化和反序列化。为什么要做序列化和反序列化呢？因为我们现在后端是使用python开发，后端的数据格式是python格式，但是前端传过来的数据类型是json格式，所以后端的是数据需要被格式化为json格式传送给前端。前端传来的数据也需要被反序列化为后端的数据格式。序列器相当于是models.py和前端之间沟通的桥梁。

同时，序列器还会对数据进行验证，需要假设用户都是不良用户，需要对用户传来的数据进行验证。

总结：序列器两大功能–翻译和验证数据有效性。

接下来要写的这个serializers.py和django的forms.py很相似。

from rest_framework import serializers
from snippets.models import Snippet, LANGUAGE_CHOICES, STYLE_CHOICES


class SnippetSerializer(serializers.Serializer):
    """
    定义要进行序列化/反序列化的字段
    """
    id = serializers.IntegerField(read_only=True)
    title = serializers.CharField(required=False, allow_blank=True, max_length=100)
    code = serializers.CharField(style={'base_template': 'textarea.html'})
    linenos = serializers.BooleanField(required=False)
    language = serializers.ChoiceField(choices=LANGUAGE_CHOICES, default='python')
    style = serializers.ChoiceField(choices=STYLE_CHOICES, default='friendly')

    def create(self, validated_data):
        """
        对前端传来的数据进行验证之后创建一个对象，也就是在数据表中加入一条数据
        """
        return Snippet.objects.create(**validated_data)

    def update(self, instance, validated_data):
        """
        对前端传来的数据进行验证之后对现有的这条数据进行更新操作
        """
        instance.title = validated_data.get('title', instance.title)
        instance.code = validated_data.get('code', instance.code)
        instance.linenos = validated_data.get('linenos', instance.linenos)
        instance.language = validated_data.get('language', instance.language)
        instance.style = validated_data.get('style', instance.style)
        instance.save()
        return instance

接收前端传来的数据， serializer.save()调用serializers.py里的create()方法保存数据，也会调用update()方法来更新数据

四. 进入API Shell

python manage.py shell

from snippets.models import Snippet
from snippets.serializers import SnippetSerializer
from rest_framework.renderers import JSONRenderer
from rest_framework.parsers import JSONParser

# 相当于实例化Snippet类，创建一个snippet对象
#之所以只填code的值是因为其它字段都有默认值
snippet=Snippet(code='foo = "bar"\n')
snippet.save()

snippet = Snippet(code='print("hello, world")\n')
snippet.save()

上面我们已经创建了两个对象，我们可以对其进行序列化


serializer = SnippetSerializer(snippet)
serializer.data
#现在得到的结果是将model的对象翻译成python的数据格式
# {'id': 2, 'title': '', 'code': 'print("hello, world")\n', 'linenos': False, 'language': 'python', 'style': 'friendly'}

#然后将python的数据格式转化成json格式来完成这整个序列化过程
content= JSONRender().render(serializer.data)
content
# b'{"id": 2, "title": "", "code": "print(\\"hello, world\\")\\n", "linenos": false, "language": "python", "style": "friendly"}'

上面的json格式和python的字典格式很相似，但是json格式一般key是用双引号引起来的，字典格式一般key没有引号，就算有的话一般都是单引号。

反序列化操作：就是模拟对前端传来的json格式数据进行反序列化操作

import io
#content就是上面进行序列化操作得到的json格式数据
#io.BytesIO模拟前端传导的方式
stream=io.BytesIO(content)
#对json格式数据进行解析
data=JSONParser().parse(stream)
#进行翻译成python格式数据
serializer=SnippetSerializer(data=data)
#进行数据有效性验证， True表示有效
serializer.is_valid()
# True
#得到python格式的数据
serializer.validated_data
# OrderedDict([('title', ''), ('code', 'print("hello, world")\n'), ('linenos', False), ('language', 'python'), ('style', 'friendly')])
#上面只是保存在本地，执行serializer.save()调用序列器里面的create()方法，创建一条数据，也就是对象，保存进数据库
serializer.save()
# <Snippet: Snippet object>

#对查找出来的所有对象进行序列化转化成python格式数据
serializer = SnippetSerializer(Snippet.objects.all(), many=True)
serializer.data
# [OrderedDict([('id', 1), ('title', ''), ('code', 'foo = "bar"\n'), ('linenos', False), ('language', 'python'), ('style', 'friendly')]), OrderedDict([('id', 2), ('title', ''), ('code', 'print("hello, world")\n'), ('linenos', False), ('language', 'python'), ('style', 'friendly')]), OrderedDict([('id', 3), ('title', ''), ('code', 'print("hello, world")'), ('linenos', False), ('language', 'python'), ('style', 'friendly')])]

以上我们可以发现models.py和serializer.py里面很多字段信息是重复的，所以我们可以进行一点优化，在serializers.py里面使用ModelSerializers而不是Serializer，这样会让代码更简洁,将serializers.py里面的内容全部注释掉，换成以下的内容，注释掉的代码和下面的代码实现的功能是一样的！

from rest_framework import serializers
from snippets.models import Snippet, LANGUAGE_CHOICES, STYLE_CHOICES

class SnippetSerializer(serializers.ModelSerializer):
    class Meta:
        model = Snippet
        fields = ['id', 'title', 'code', 'linenos', 'language', 'style']

python manage.py shell

from snippets.serializers import SnippetSerializer
serializer = SnippetSerializer()
print(repr(serializer))
# SnippetSerializer():
#    id = IntegerField(label='ID', read_only=True)
#    title = CharField(allow_blank=True, max_length=100, required=False)
#    code = CharField(style={'base_template': 'textarea.html'})
#    linenos = BooleanField(required=False)
#    language = ChoiceField(choices=[('Clipper', 'FoxPro'), ('Cucumber', 'Gherkin'), ('RobotFramework', 'RobotFramework'), ('abap', 'ABAP'), ('ada', 'Ada')...
#    style = ChoiceField(choices=[('autumn', 'autumn'), ('borland', 'borland'), ('bw', 'bw'), ('colorful', 'colorful')...

退出shell:

quit()

五. snippets/views.py

from django.http import HttpResponse, JsonResponse
from django.views.decorators.csrf import csrf_exempt
from rest_framework.parsers import JSONParser
from snippets.models import Snippet
from snippets.serializers import SnippetSerializer

#csrf_exempt是为了让post到view的数据不需要使用到CSRF token
# 在Django中对于基于函数的视图我们可以 @csrf_exempt 注解来标识一个视图可以被跨域访问。
@csrf_exempt
def snippet_list(request):
	"""
	显示snippet列表， 和创建snippet
	"""
	if request.method == 'GET':
        snippets = Snippet.objects.all()
        serializer = SnippetSerializer(snippets, many=True)
        return JsonResponse(serializer.data, safe=False)

    elif request.method == 'POST':
        data = JSONParser().parse(request)
        serializer = SnippetSerializer(data=data)
        if serializer.is_valid():
            serializer.save()
            return JsonResponse(serializer.data, status=201)
        return JsonResponse(serializer.errors, status=400)

@csrf_exempt
def snippet_detail(request, pk):
    """
   针对详情页面的显示(retrieve)，修改(update)和删除(delete)
    """
    try:
        snippet = Snippet.objects.get(pk=pk)
    except Snippet.DoesNotExist:
        return HttpResponse(status=404)

    if request.method == 'GET':
        serializer = SnippetSerializer(snippet)
        return JsonResponse(serializer.data)

    elif request.method == 'PUT':
        data = JSONParser().parse(request)
        serializer = SnippetSerializer(snippet, data=data)
        if serializer.is_valid():
            serializer.save()
            return JsonResponse(serializer.data)
        return JsonResponse(serializer.errors, status=400)

    elif request.method == 'DELETE':
        snippet.delete()
        return HttpResponse(status=204)

关于csrf_exempt可以参照：https://blog.csdn.net/weixin_40744265/article/details/80747905 本文中进行了解即可， Let’s move on…

六. snippets/urls.py和 tutorial/urls.py

(一)snippets/urls.py

from django.urls import path
from snippets import views

urlpatterns = [
	path('snippets/', views.snippet_list),
	path('snippets/<int:pk>', views.snippet_detail),
]

(二) tutorial/urls.py

from django.urls import path, include

urlpatterns = [
	path('', include('snippets.urls')),
]

七. 测试我们的API —采用httpie进行测试

(一) 安装httpie

pip insttall httpie

(二) 启动项目

python manage.py runserver

(三)开始测试

#获取snippets的列表
http http://127.0.0.1:8000/snippets/
HTTP/1.1 200 OK
...
[
  {
    "id": 1,
    "title": "",
    "code": "foo = \"bar\"\n",
    "linenos": false,
    "language": "python",
    "style": "friendly"
  },
  {
    "id": 2,
    "title": "",
    "code": "print(\"hello, world\")\n",
    "linenos": false,
    "language": "python",
    "style": "friendly"
  }
]

#获取详情页面
http http://127.0.0.1:8000/snippets/1/

HTTP/1.1 200 OK
...
{
  "id": 2,
  "title": "",
  "code": "print(\"hello, world\")\n",
  "linenos": false,
  "language": "python",
  "style": "friendly"
}

ps:

项目代码奉上：https://github.com/Ran-oops/DRF_Project2.git