Django API 服务器实现 (Django_REST_framework)

上一章讲解 《这绝对不是只是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)
  1. 定义@csrf_exempt 是为了避免 csrf攻击 ①

  2. GET请求是获取Snippet类中所有的对象snippets
    — 通过SnippetSerializer类序列化出serializer对象
    — 返回序列化对象的data数据(返回JSON字符串)

  3. 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)
  1. @api_view(['GET', 'POST']) 告诉该方法只运行GET ,POST 两个方法,内部也对csrf攻击做了处理

  2. 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进行一个对比

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,835评论 4 364
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,598评论 1 295
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,569评论 0 244
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,159评论 0 213
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,533评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,710评论 1 222
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,923评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,674评论 0 203
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,421评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,622评论 2 245
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,115评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,428评论 2 254
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,114评论 3 238
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,097评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,875评论 0 197
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,753评论 2 276
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,649评论 2 271

推荐阅读更多精彩内容