用Django全栈开发（进阶篇）——09.加入Django REST Framework为前后端分离做准备

大家好，这是皮爷给大家带来的最新的学习Python能干啥？之Django教程的进阶版。

在之前《用Django全栈开发》系列专辑里面，皮爷详细的阐述了如何编写一个完整的网站，具体效果可以浏览线上网站：Peekpa.com

从进阶篇开始，每一篇文章都是干货满满，干的不行。这一节，我们来说：加入著名的Django REST framework，为日后的前后端分离做准备。

Peekpa.com的官方地址：http://peekpa.com

获取整套教程源码唯一途径，关注『皮爷撸码』，回复『peekpa.com』

皮爷的每一篇文章，都配置相对应的代码。这篇文章的代码对应的Tag是“Advanced_09”。

tittle.jpeg

啥是REST

REST，即Representational State Transfer。使用Json格式来承载数据的传递格式，通过HTTP来操作数据。最最最核心内容就是，正确的使用HTTP。

可是，啥叫正确使用HTTP？HTTP的方法有以下几种：

GET：获取资源，有返回body，最常用的方法；
HEAD：获取资源，但是没有返回body，可以通过返回的头文件来看一些相关信息；
POST：增加或修改资源，可以有返回body；
PUT：修改资源，需要修改资源的全部信息，可以有返回body；
DELETE：删除资源，但是客户端无法得知资源是否被删除；
CONNECT：HTTP/1.1 协议中预留给能够将连接改为管道方式的代理服务器；
OPTIONS：获取当前URL的可使用方法，若成功，将会把方法放到Allow中；
TRACE：会在目的服务器端发起一个“回环”诊断，回显服务器收到的请求，主要用于测试或诊断；
PATCH：是对 PUT 方法的补充，用来对已知资源进行局部更新。

这些方法，其中我们最常用的基本就是：GET，POST，PUT和DELETE了，分别对应的就是增，增和修改，修改，删除。

这里要说一句，PUT有幂等性(idempotence)，POST没有幂等性。何为幂等性？简单理解就是：一个方法重复执行多次，如果得到的结果是一样的，那么这个方法就具有幂等性。反之则不具备。

所以这里，PUT是有幂等性的，而POST在做增加的时候是不具备幂等性的。

但是可以看到上面的方法，修改资源的时候，可以用PUT，POST或者PATCH。

说完HTTP的方法，所以，REST的核心就是要正确使用HTTP，正确的使用HTTP的方法。

你查看资源，就用GET方法；
你更改资源，就用PUT或者PATCH方法；
你删除资源，就用DELETE方法；
你想获取下载文件大小，就用HEAD方法；
。。。

这样的使用方法就是RESTful。正确的使用HTTP就是REST。

那么REST主要用来能干嘛呢？其实最常用的就是按照REST来写接口，俗称的Rest Api。碰巧，Django中我们也有对应的模块能够快速的实现Rest Api，它就是：Django REST framework。

安装Django REST framework

其实我们的项目类，在一开始就集成了Django REST framework（网上一般缩写为drf）。如果你下载了源码，就会在settings.py里面看到，我们已经集成了它。但是这里我们再来简单的捋一遍如何集成Django REST framework。

首先通过pip来安装Django REST framework：

$ pip install djangorestframework

安装好之后，我们需要在Peekpa/settings.py当中需要配置INSTALLED_APPS，在其中需要添加rest_framework：

INSTALLED_APPS = [
    。。。内容太多忽略。。。
    'rest_framework',
    。。。内容太多忽略。。。
]

到此为止，我们的Django REST framework就集成完毕了。是不是非常的方便。

初探Django REST framework

Django REST framework用来实现API，其实关键的内容有两部分：

一个是数对数据的Serializer;
另一个是返回结果的APIView。

那么下面我们就以我们的数据中心的地震信息为例，来实战操作一下如何使用DRF来编写API。

首先，我们的地震信息的Model有以下内容：

{
    "_id" : ObjectId("5f0110fc601bd5114812c0fd"),
    "jp_create_time" : "2020-7-5-7-30-4",
    "jp_url" : "http://www.jma.go.jp/jp/quake/20200704232923395-05082651.html",
    "jp_title" : "２０２０年　７月　５日０８時２６分",
    "jp_id" : "2020070423292339505082651",
    "jp_time_num" : "2020-07-04-08-26-51",
    "jp_location_image_url" : "http://www.jma.go.jp/jp/quake/images/japan/20200704232923395-05082651.png",
    "jp_location" : "岐阜県飛騨地方",
    "jp_level" : "Ｍ３．１",
    "jp_max_level" : "震度１",
    "jp_time_text" : "　７月　５日０８時２９分"
}

所以，我们首先要在app/datacenter目录下创建一个serializers.py文件，将一下内容复制进去：

class JpEarthSerializer(serializers.Serializer):
    jp_title = serializers.CharField(allow_null=True)
    jp_create_time = serializers.CharField(allow_null=True)
    jp_url = serializers.CharField(allow_null=True)
    jp_id = serializers.CharField(allow_null=True)
    jp_time_num = serializers.CharField(allow_null=True)
    jp_location_image_url = serializers.CharField(allow_null=True)
    jp_location = serializers.CharField(allow_null=True)
    jp_level = serializers.CharField(allow_null=True)
    jp_max_level = serializers.CharField(allow_null=True)
    jp_time_text = serializers.CharField(allow_null=True)
    jp_peekpa = serializers.CharField(allow_null=True)

这里需要注意一点，我们看到有些变量的括号里面添加了allow_null=True，这个的作用就是，如果在数据列表中，有些数据没有这个字段，那么不添加这个字段就会报错，添加了，则会返回null。

之后，我们创建一个center_api_view.py文件，为我们日后的前后端分离做准备。在这个文件里面，我们专门处理API相关的数据问题，这里，我们先把之前的jpearth_view.py里面关于内容搬运到这个文件中，并做一定的修改。下面简单列出核心内容：

class CenterApiView(APIView):
        def get(self, request):
        page = int(request.GET.get('p', 1))
        handle_type, search_key = self.process_paramter(request)
        # list_data = self.get_data_from_db(handle_type, search_key)
        # 封装置后的数据缓存数据处理方法在这里
        from_cache, list_data = get_data_from_cache(request, self.get_data_from_db, handle_type=handle_type,
                                                    search_key=search_key)
        paginator = Paginator(list(list_data), settings.ONE_PAGE_NEWS_COUNT)
        page_obj = paginator.page(page)
        print(page_obj.object_list[0])
        context = {
            "list_data": JpEarthSerializer(page_obj.object_list, many=True).data,
            "from_cache": from_cache
        }
        context.update(self.get_pagination_data(paginator, page_obj))
        return Response(data=context, status=200)

如果你直接贴代码运行的话，可能会报错，上面列出来的是代码的局部，代码详情，还是请看源码中的对应代码，在apps/datacenter/center_api_view.py目录。获取源码的方式在文末有。

可以看到这里，最关键的一步就是JpEarthSerializer(page_obj.object_list, many=True).data，这里就是对我们的数据进行序列化的操作。

当然，如果你只对一个对象进行序列化，可以把后面的many=True去掉就可以。

接着，我们在app/datacenter/urls.py里面配置一下URL映射：

urlpatterns = [
    path('center/data/', CenterApiView.as_view(), name="jpearth_api_view"),
]

那么接下来，我们来看一下具体访问http://127.0.0.1:8000/center/data/的效果：

001.png

可以看到，我们的数据被返回成了JSON格式，而这个UI界面，是Django REST framework自己的APIView提供的，其实如果你在Postman里面检验这个接口的时候，这个背景信息是没有的。如果我们想要去掉这个UI，只需要在APIView的类底下添加一句renderer_classes = [JSONRenderer]就可以：

class CenterApiView(APIView):
    renderer_classes = [JSONRenderer]
    def get(self, request):
        。。。内容太多忽略。。。

这样，我们再来访问链接，就会发现页面改变了：

002.png

可以看到，我们的数据在Chrome浏览器里面展现成了JSON格式，是不是非常的方便。

这里我们使用到的是GET方法，所以仅仅实现了CenterApiView类里面的def get(self, request):方法。

下一节，我们将讲述Django结合Ajax来实现异步请求操作。到时候就会需要今天我们写的接口了。

技术总结

最后总结一下，

集成初探Django REST Framework：

想要实现RESTful API，那么就必须要知道REST是什么？就是要正确的使用HTTP；
使用Django REST framework，首先要创建对象的序列化Serializer；
然后可以创建一个类，继承自APIView，然后在里面读取数据，将数据序列化;
如果要去除drf自己的UI样式，只需要加入renderer_classes = [JSONRenderer]语句即可；
进阶篇的集成初探Django REST Framework总结完毕。

获取整套教程源码唯一途径，关注『皮爷撸码』，回复『peekpa.com』

长按下图二维码关注，如文章对你有启发或者能够帮助到你，欢迎点赞，在看，转发三连走一发，这是对我原创内容输出的最大肯定。

底部图片.png