Django API 服务器实现（Django_REST_fr

2017-08-02 本文已影响440人处在水深火热的iOS_林龙

上一章讲解《这绝对不是只是Django入门》后,本该讲解admin及web网页等相关内容，考虑是否应该先插入《Django API 服务器实现》因为这个实现简单不需要掌握前端知识就可以实现。

Django中有一个框架django_REST_framework。本来想根据官方网站的目录为大家一一讲解，但是发现每一章都在为上一章而优化。如需知道更详细过程。可以去官方网查看说明文档django-rest-framework官方网在讲解 django_REST_framework 之前需要了解什么是RESTful。

RESTful（简称:REST ，英文为:Representational State Transfer）
描述了一个架构样式的网络系统，是指一组架构约束条件和原则，这是一种软件架构风格而不是强制(标准)。提供了一组设计原则和约束条件。它用于客户端和服务器交互的软件。由于服务器与客户端之间的交互请求是无状态。

原本打算用一到两天的时间来学习这个框架，后来发现真的是 too young too simple，很多实现方式是框架约定好的，在一个新手如果未了解根本无从下手。为了让大家更好的看懂本章内容，花了很多时间在整理，语言表达上。希望大家学完可以运用在自己项目中。

django_REST_framework

执行pip命令安装框架

pip install djangorestframework

安装成功后打开之前编辑中的项目，如果还没编辑请参考《这绝对不是只是Django入门》创建一个django项目。
打开settings文件，把django_REST_framework框架导入到settings中，偷懒了一下借用个官方文档中的案例为大家讲解一下。同时如果有什么不明白的

python manage.py startapp snippets

# settings.py
# 注意安装的时候djangorestframework 但导入是rest_framework，请不要写错
import rest_framework   

INSTALLED_APPS = [
          ...
    'rest_framework',
    'snippets',
]

打开snippets目录下的 models.py 文件，我们编写该模型的类

# models.py
from __future__ import unicode_literals
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',)  #根据created这个字段排序

这个类应该很容易理解，我就不赘述了。如果有什么不明白的可以在django.db.models这个py文件查看源码。

前面的准备工作已经结束，开始讲解rest_framework框架

在snippets目录下创建serializers.py 用于序列化对象
(序列化：用于字典与对象的直接的互转，相信从事ios开发，安卓开发等攻城狮应该不陌生)

# serializers.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):
        """
        Create and return a new `Snippet` instance, given the validated data.
        """
        return Snippet.objects.create(**validated_data)

    def update(self, instance, validated_data):
        """
        Update and return an existing `Snippet` instance, given the 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

rest_framework框架提供了一个更加方便的方式来定义序列化文件

# 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')

无需再定义序列化的字段及字段的类型，只需重写Meta类，定义model是哪个类的，fields则是在http请求后返回什么字段。是不是对比与上面编写的序列化方便简单得多。

我们开始来定义views.py文件。官方文档中定义了几个实现方式。现在我们为大家一一讲解一下
�前两个实现方式是通过request方式来实现，三到五是通过创建View来实现，六则通过viewSet来实现

# urls.py
# 针对request
url(r'^snippets/$',views.snippet_list, name='snippet-list')          

# 针对view
url(r'^snippets/$',views.SnippetList.as_view(), name='snippet-list')  

# 针对的是viewSet
snippet_list = SnippetViewSet.as_view({
    'get': 'list',
    'post': 'create'
})
url(r'^snippets/$', snippet_list, name='snippet-list'),

实现方式一

# views.py
from rest_framework.parsers import JSONParser
from rest_framework.response import Response
from rest_framework import status
from snippets.models import Snippet
from snippets.serializers import SnippetSerializer

@csrf_exempt
def snippet_list(request):
    if request.method == 'GET':
        snippets = Snippet.objects.all()
        serializer = SnippetSerializer(snippets, many=True)
        return Response(serializer.data, safe=False)

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

定义@csrf_exempt 是为了避免 csrf攻击 ①
GET请求是获取Snippet类中所有的对象snippets
— 通过SnippetSerializer类序列化出serializer对象
— 返回序列化对象的data数据（返回JSON字符串）
POST请求是通过JSONParser().parse(request)
— 把request请求中数据通过JSONParser类转化为序列化的data数据
— 对data数据进行序列化，判断序列化是否有效，有效则保存到本地数据库中

①(通过装饰器对该方法进行修改，如果不知道装饰器可百度查阅，这是一个python语法)

实现方式二

# views.py
from rest_framework.decorators import api_view
from rest_framework.response import Response

from snippets.models import Snippet
from snippets.serializers import SnippetSerializer

@api_view(['GET', 'POST'])
def snippet_list(request,format=None):
    if request.method == 'GET':
        snippets = Snippet.objects.all()
        serializer = SnippetSerializer(snippets, many=True)
        return Response(serializer.data)

    elif request.method == 'POST':
        serializer = SnippetSerializer(data=request.data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data, status=status.HTTP_201_CREATED)
        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

@api_view(['GET', 'POST']) 告诉该方法只运行GET ,POST 两个方法，内部也对csrf攻击做了处理
GET请求实现方式与上面的例子完全一样，只是在POST请求中，减少JSONParser类的实现。直接通过request.data获得。只是因为在装饰器@api_view()中做了处理

实现方式三

# views.py
from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework import status
from snippets.models import Snippet
from snippets.serializers import SnippetSerializer

class SnippetList(APIView):
    def get(self, request, format=None):
        snippets = Snippet.objects.all()
        serializer = SnippetSerializer(snippets, many=True)
        dict = {'code':0000,'data':serializer.data,'msg':"success"}
        return Response(dict)

    def post(self, request, format=None):
        serializer = SnippetSerializer(data=request.data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data, status=status.HTTP_201_CREATED)
        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

这个是我最喜欢的方式因为它是真正针对一个视图的方式。通过视图中个get方法 post方法去实现逻辑处理，而且更加自定义化，为什么会说自定义化呢，参考下面的几个方式，你就会理解该框架在实现简单化的过程却失去了自定义化的缺点

实现方式四

# views.py
from rest_framework import mixins
from rest_framework import generics
from rest_framework import status
from snippets.models import Snippet
from snippets.serializers import SnippetSerializer


class SnippetList(mixins.ListModelMixin,
                  mixins.CreateModelMixin,
                  generics.GenericAPIView):
    queryset = Snippet.objects.all()
    serializer_class = SnippetSerializer

    def get(self, request, *args, **kwargs):
        return self.list(request, *args, **kwargs)

    def post(self, request, *args, **kwargs):
        return self.create(request, *args, **kwargs)

在这里我就不多详细讲解，因为方式五对方式四做了优化

实现方式五

# views.py
from rest_framework import generics
from snippets.models import Snippet
from snippets.serializers import SnippetSerializer

class SnippetList(generics.ListCreateAPIView):
    queryset = Snippet.objects.all()
    serializer_class = SnippetSerializer

如果直接跳到这一步，大家一定是一脸懵逼的。这格式是其实也没什么好讲解，优点实现快，缺点不够灵活。这就是我为什么说喜欢实现方式三的原因。

实现方式六

from rest_framework import viewsets
class SnippetViewSet(viewsets.ReadOnlyModelViewSet):
    """
    This viewset automatically provides `list` and `detail` actions.
    """
    queryset = Snippet.objects.all()
    serializer_class = SnippetSerializer

rest_framework 从官方网提供的这六个方法中，从代码的繁多到最后的两行代码实现一个请求的方式。从例子中的四五六，虽然实现起来特别简单，不需要去判断逻辑，不需要去手动的实现序列化就能得到预期效果。但却失去了复杂的逻辑判断，及response 自由的格式。方法三对比其他可能较为麻烦，但是却能满足各公司不同需求的逻辑。如果有时间的话我会研究一下tornado，与django进行一个对比

Django API 服务器实现（Django_REST_fr

django_REST_framework

前面的准备工作已经结束，开始讲解rest_framework框架

实现方式一

实现方式二

实现方式三

实现方式四

实现方式五

实现方式六

猜你喜欢

热点阅读

Django API 服务器实现 （Django_REST_fr

django_REST_framework

前面的准备工作已经结束，开始讲解rest_framework框架

实现方式 一

实现方式 二

实现方式 三

实现方式 四

实现方式 五

实现方式 六

猜你喜欢

热点阅读

Django API 服务器实现（Django_REST_fr

实现方式一

实现方式二

实现方式三

实现方式四

实现方式五

实现方式六