Django REST框架 -序列化

Posted 2020-10-07 chenyang13677

建立一个新的环境

在我们做任何事情之前，我们将使用virtualenv创建一个新的虚拟环境。这将确保我们的包配置与我们正在开展的任何其他项目保持良好的隔离。

virtualenv env
source env/bin/activate

现在我们在一个virtualenv环境中，我们可以安装我们的包的要求。

pip install django
pip install djangorestframework
pip install pygments  # We‘ll be using this for the code highlighting

注意：要随时退出virtualenv环境，只需键入deactivate。有关更多信息，请参阅virtualenv文档。

入门

好的，我们准备好获得编码。要开始，我们来创建一个新的项目来处理

cd ~
django-admin.py startproject tutorial
cd tutorial

一旦完成，我们可以创建一个我们将用来创建一个简单的Web API的应用程序。

python manage.py startapp snippets

我们需要添加我们的新snippets应用和rest_framework应用INSTALLED_APPS。我们来编辑tutorial/settings.py文件：

INSTALLED_APPS = (
    ...
    ‘rest_framework‘,
    ‘snippets.apps.SnippetsConfig‘,
)

请注意，如果你使用的Django <1.9，则需要更换snippets.apps.SnippetsConfig有snippets。

好的，我们准备好了。

创建一个可以使用的模型

为了本教程的目的，我们将首先创建一个Snippet用于存储代码片段的简单模型。继续编辑snippets/models.py文件。注意：良好的编程实践包括评论。虽然您将在本教程代码的存储库版本中找到它们，但我们在此忽略了它们，专注于代码本身。

 

 

#coding=utf-8
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())
‘‘‘在models里面，用的models.   ‘‘‘
class Snippet(models.Model):
    create = models.DateTimeField(auto_now_add=True)
    title = models.CharField(max_length=100,blank=True,default=‘‘)
    code = models.TextField()  #文本
    lineons = 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‘,)   #关键字的高亮显示，排序方式是created 注意这里是一个元祖

我们还需要为我们的代码段模型创建初始迁移，并首次同步数据库。

python manage.py makemigrations snippets
python manage.py migrate

创建一个Serializer类

我们需要开始使用Web API的第一件事是提供一种将代码片段实例序列化和反序列化为表示形式的方法json。我们可以通过声明与Django表单非常相似的序列化器来做到这一点。在snippets命名的目录中创建一个文件，serializers.py并添加以下内容。

 

from rest_framework import serializers
from snippets.models import Snippet, LANGUAGE_CHOICES, STYLE_CHOICES   #从之前的models里面导入进来

‘‘‘views里面的所有字段，必须要与前面的models一致，尽可能的原则是只能少，不能多‘‘‘

‘‘‘在serializer里面是 serializers.  ‘‘‘
class SnippetSerializer(serializers.Serializer):  #Serializer是不可变的   Snippet是可变的，但是一定要和前面的models里面的要一致
    id = serializers.IntegerField(read_only=True) #id是可读的，不能修改
    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,validate_data):
        return Snippet.objects.create(**validate_data)


#用于更新的函数
    def update(self, instance, validated_data):  #最后面instance.title 这是默认值
        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

序列化器类的第一部分定义了序列化/反序列化的字段。该create()和update()方法定义实例如何完全成熟的创建或修改时调用serializer.save()

甲串行类非常类似于一个Django Form类，并且包括关于各个字段类似的验证标记，如required，max_length和default。

字段标志还可以控制在某些情况下，如渲染到HTML时如何显示串行器。{‘base_template‘: ‘textarea.html‘}上面的标志相当于widget=widgets.Textarea在Django Form类上使用。这对于控制如何显示可浏览的API特别有用，我们将在本教程的后面看到。

我们实际上也可以通过使用ModelSerializer课程来节省自己的时间，我们稍后会看到，但是现在我们将保持我们的序列化器定义。

使用串行器

在我们进一步了解之前，我们将熟悉使用我们新的Serializer类。我们进入Django shell。

 

python manage.py shell

好的，一旦我们有几个导入，我们来创建一些代码片段来处理。

from snippets.models import Snippet
from snippets.serializers import SnippetSerializer
from rest_framework.renderers import JSONRenderer  #输出格式为json格式
from rest_framework.parsers import JSONParser     #输入格式为json格式
 
snippet = Snippet(code=‘foo = "bar"\n‘)      #实例化类
snippet.save()      

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

我们现在有几个片段实例可以玩。我们来看看序列化这些实例之一。

serializer = SnippetSerializer(snippet)
serializer.data    #获取数据  python数据类型
# {‘id‘: 2, ‘title‘: u‘‘, ‘code‘: u‘print "hello, world"\n‘, ‘linenos‘: False, ‘language‘: u‘python‘, ‘style‘: u‘friendly‘}

此时，我们将模型实例转换为Python本机数据类型。为了完成序列化过程，我们将数据转换成json。

content = JSONRenderer().render(serializer.data)   #将python对象转化为json格式,因为前端传来的数据只支持json格式
content  
# b‘{"id": 2, "title": "", "code": "print \\"hello, world\\"\\n", "linenos": false, "language": "python", "style": "friendly"}‘

反序列化是类似的。首先我们将一个流解析为Python本机数据类型...

from django.utils.six import BytesIO   #转化类型

stream = BytesIO(content)  #读取
data = JSONParser().parse(stream) #解析

...然后我们将这些本机数据类型恢复到完全填充的对象实例中。

serializer = SnippetSerializer(data=data)   #反向还原
serializer.is_valid() #验证还原数据
# True
serializer.validated_data  #查看还原数据
# OrderedDict([(‘title‘, ‘‘), (‘code‘, ‘print "hello, world"\n‘), (‘linenos‘, False), (‘language‘, ‘python‘), (‘style‘, ‘friendly‘)])
serializer.save()
# <Snippet: Snippet object>

请注意API与表单的使用情况。当我们开始编写使用我们的串行器的视图时，相似性将变得更加明显。

我们也可以序列化查询集而不是模型实例。为此，我们只many=True需要为serializer参数添加一个标志。

serializer = SnippetSerializer(Snippet.objects.all(), many=True)  #所有数据进行显示
serializer.data
# [OrderedDict([(‘id‘, 1), (‘title‘, u‘‘), (‘code‘, u‘foo = "bar"\n‘), (‘linenos‘, False), (‘language‘, ‘python‘), (‘style‘, ‘friendly‘)]), OrderedDict([(‘id‘, 2), (‘title‘, u‘‘), (‘code‘, u‘print "hello, world"\n‘), (‘linenos‘, False), (‘language‘, ‘python‘), (‘style‘, ‘friendly‘)]), OrderedDict([(‘id‘, 3), (‘title‘, u‘‘), (‘code‘, u‘print "hello, world"‘), (‘linenos‘, False), (‘language‘, ‘python‘), (‘style‘, ‘friendly‘)])]

使用ModelSerializers

我们的SnippetSerializer课程正在复制Snippet模型中还包含的大量信息。如果我们可以保持我们的代码更简洁，那将是很好的。

与Django提供Form类和ModelForm类的方式相同，REST框架包括Serializer类和ModelSerializer类。

我们来看看使用ModelSerializer类重构我们的serializer 。snippets/serializers.py再次打开该文件，并用SnippetSerializer以下替换该类。

 

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

序列化器具有的一个不错的属性是可以通过打印其表示来检查序列化器实例中的所有字段。打开Django shell 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‘)...

 

重要的是要记住，ModelSerializer类不会做任何特别神奇的事情，它们只是创建序列化器类的快捷方式：

• 一组自动确定的字段。
• 简单的默认实现create()和update()方法。

使用我们的Serializer编写正常的Django视图

我们来看看我们如何使用我们的新的Serializer类编写一些API视图。目前我们不会使用任何REST框架的其他功能，我们只需将视图编写为常规的Django视图。

编辑snippets/views.py文件，并添加以下内容。

from django.http import HttpResponse,JsonResponse  #HTTP响应和json相应
from django.views.decorators.csrf import csrf_exempt  #b不用跨域请求了
from rest_framework.renderers import JSONRenderer
from rest_framework.parsers import JSONParser
from snippets.models import Snippet  #从模型中引入
from snippets.serializers import SnippetSerializer  #引入serializers

我们的API的根本将是一个视图，支持列出所有现有的片段，或创建一个新的片段。

@csrf_exempt
def snippet_list(request):  #生成列表，多条信息
#列出全部代码片段，或则创建新代码片段
    if request.method == ‘GET‘:
        snippets = Snippet.objects.all()
        serializer = SnippetSerializer(snippets,many=True) #转成json格式
        return JsonResponse(serializer.data,safe=False)   #以json格式响应出去
    elif request.method == ‘POST‘:
        data = JSONParser().parse(request)  #解析发来的数据，用parse方法
        serializer = SnippetSerializer(data=data)
        if serializer.is_valid(): #验证数据是否合法
            serializer.save()
            return JsonResponse(serializer.data,status=201)  #返回操作成功
        return JsonResponse(serializer.errors,status=400)   #返回操作错误

我们的API的根本将是一个视图，支持列出所有现有的片段，或创建一个新的片段。

请注意，因为我们希望能够从不具有CSRF令牌的客户端对此视图进行POST，因此我们需要将视图标记为csrf_exempt。这不是你通常想要做的事情，REST框架视图实际上比这更有明确的行为，但它现在将用于我们的目的。

我们还需要一个与单个代码段对应的视图，并可用于检索，更新或删除代码段。

#设置允许可以跨域请求
@csrf_exempt
def snippet_detail(request, pk):
    """
    提取 更新 删除代码片段
    """
    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 == ‘PATCH‘:#更新或者修改数据
        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)

最后我们需要把这些观点连接起来。创建snippets/urls.py文件：

 

from django.conf.urls import url
from snippets import views

urlpatterns = [
    url(r‘^snippets/$‘, views.snippet_list),  #列表接口
    url(r‘^snippets/(?P<pk>[0-9]+)/$‘, views.snippet_detail),   #用户用正则表达式出入PK，传入到views里面 修改，更新接口
]

 

我们还需要在tutorial/urls.py文件中连接根urlconf ，以包含我们的片段应用程序的URL。

 

 

from django.conf.urls import url, include

urlpatterns = [
    url(r‘^‘, include(‘snippets.urls‘)),

   url(r‘^admin/‘, admin.site.urls),

]

值得注意的是，我们目前还没有正确处理的几个边缘案例。如果我们发送格式错误json，或者如果请求是使用视图不处理的方法，那么我们最终会出现500个“服务器错误”响应。不过，现在这样做。

测试我们在Web API上的第一次尝试

现在我们可以启动一个服务我们的代码片段的示例服务器。

退出外壳...

quit()

...并启动Django的开发服务器。

python manage.py runserver

Validating models...

0 errors found
Django version 1.11, using settings ‘tutorial.settings‘
Development server is running at http://127.0.0.1:8000/
Quit the server with CONTROL-C.

在另一个终端窗口中，我们可以测试服务器。

我们可以使用curl或httpie来测试我们的API 。Httpie是用Python编写的用户友好的http客户端。我们来安装

您可以使用pip安装httpie：

pip install httpie

最后，我们可以得到所有片段的列表：

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"
  }
]


或者我们可以通过引用其id来获取特定的代码段：

http http://127.0.0.1:8000/snippets/2/

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

同样，您可以通过在Web浏览器中访问这些URL来显示相同??的json。

我们现在在哪

我们到目前为止，我们做得还不错，我们有一个序列化API，与Django的Forms API和一些常规的Django视图非常相似。

我们的API视图目前没有特别的特别之处，除了提供json响应外，还有一些错误处理我们仍然想要清理的边缘情况，但它是一个运行良好的Web API。