Python3+PyCharm+Django+Django REST framework开发教程

一、说明

自己一是想跟上潮流二是习惯于直接干三是没有人可以请教，由于这三点经常搞得要死要活。之前只简单看过没写过Diango，没看过Django REST framework，今天一步到位直接上又撞上了南墙。在此记一下以备忘，也希望对后来者能有所帮助。本文相当于Django REST framework官方文档的重新实现。

 

1.1 Django是什么

Django是当下流行的一个python语言的web框架，类似于java的struts2,（如果struts2太旧不懂那也可以理解为spring boot）。

 

1.2 Django REST framework是什么

Django类似于struts2，也就是说其是mvc模式的，也就是说其v是前后端强耦合的，但现在都讲REST。

Django REST framework就是Django的REST化库，用于实现Django的REST化。

 

二、开发环境搭建

2.1 安装PyCharm+conda

参见：https://www.cnblogs.com/lsdb/p/9121033.html

 

2.2 在pycharm中新建项目

 

2.3 安装Django和Django REST framework

依次点开pycharm----菜单----file----settings----project----project interpreter，安装django、djangorestframework、pygments、pytest四个包

或者通过系统菜单开启“Anaconda Prompt”用pip安装，命令如下

conda activate DjangoTest

pip install django
pip install djangorestframework
pip install pygments
pip install pytest

 

2.4 创建真正的Django项目

在前面中我们已经创建了名称为DjangoTest的项目，但要注意只是我们把名字命名为DjangoTest而已改项目到现在为止其实与Django无关。

Django项目需要通过django-admin命令来创建；所以我们要到项目所在文件夹下将现有DjangoTest文件夹删掉，然后用django-admin命令来重新创建DjangoTest。

（前边创建的DjangoTest的意义，是更多是为了创建DjangoTest虚拟环境。虽然有点绕，但这是我针对Scrapy和Django这种鸡和蛋问题能想到的最好办法）

而django-admin命令的位置，我们可以借助conda env list来查看DjangoTest虚拟环境所在的目录，然后加上\Scripts\django-admin.exe即是其位置。比如我的操作如下：

cd F:\PycharmProjects
F:
rmdir /s /q DjangoTest
conda env list
D:\Language\Miniconda3\envs\DjangoTest\Scripts\django-admin.exe startproject DjangoTest

创建完成后目录结构如下：

 

 2.5 设置运行环境

django项目需要通过python manage.py runserver形式运行，我们也需要配置成该形式。

依次点击菜单----Run----Edit Configurations----左上角+号----Python，添加运行环境

Name----环境名称，自己随便填

Script path----manage.py所在的路径，改成自己的

Parameters----runserver，ip和端口如果需要直接追加在后边即可

一定要注意，后续不要随便在一个页面就右键run/debug，而是不管修改什么文件在什么位置都要run/debug上边这个环境，不然运行不起来。（一直报错django.core.exceptions.ImproperlyConfigured: Requested setting INSTALLED_APPS, but settings are not configured. You must either define the environment variable DJANGO_SETTINGS_MODULE or call settings.configure() before accessing settings.）

 

2.6 将Django REST framework集成到Django

上边我们创建了Django项目，至于Django REST framework只是安装并没有开始操作，下边我们开始使用Django REST framework对上边的Django项目进行REST化改造。

一般而言我们不直接大幅修改Django项目的文件，而是新建一个APP实现REST，然后原来的Django项目文件只写一些包含命令即可。所谓APP可以理解为子文件夹或者一个新线程。

为了更好地证明我们的程序是能很好运行的，我这里会改用和官方例子不一样的名称包括app名称model名称等；并尽可能说明每个操作本质是在做什么。

 

2.6.1 注册drest和Django REST framework

首先，进入到manage.py所在目录新建一个app（注意打开的cmd中的python和pycharm中的python同为python3不然运行就报错了，我这里直接在前边的Anaconda Prompt中运行）：

python manage.py startapp drest

向Django项目注册drest，由于Django REST framework其实也以app形式注入所以也一同注册。编缉DjangoTest/settings.py找到INSTALLED_APPS追加以下内容：

'rest_framework',
'drest.apps.DrestConfig',

 

 2.6.2 路由关联调整等

在drest目录下新建urls.py（内容先不写），然后在DjangoTest/usrls.py中包含它；即DjangoTest/usrls.py修改如下：

from django.contrib import admin
from django.urls import path
from django.conf.urls import url, include

urlpatterns = [
    path('admin/', admin.site.urls),
    url(r'^', include('drest.urls')),
]

另外我们再在drest创建一个序列化文件serializers.py（内容先不写）用于后续序列化。到此我们的环境算搭建好了，项目目录结构如下：

 

 

三、开发示例

前边我们已搭好了环境，创建了一个app----drest，这里我们即在drest上进行开发。

3.1 创建model

这里的model不是mvc中的m，而是orm中的表对应的类，稍后数据库的表就是根据这个类来建立的。

编缉drest/model.py，写入以下内容：

from django.db import models

# Create your models here.
class Test(models.Model):
    # 这些在创建数据表时是表字段，括号内为字段对应属性
    # 不过注意default属性，是说在实例化这个类时该字段默认是这个值，创建数据表时并不会当作一行括入数据表
    created = models.DateTimeField(auto_now_add=True)
    username = models.CharField(max_length=100, default='ls', )
    password = models.CharField(max_length=100, default='toor', )

    class Meta:
        # 这个表示数据表的内容按创建时间排序
        ordering = ('created',)

 

3.2 创建model对应序例化类

编写drest/serializers.py写入以下内容：

from rest_framework import serializers
from drest.models import Test

class TestSerializer(serializers.ModelSerializer):
    class Meta:
        # 此处指明本序列化对应的model
        model = Test
        # 此处指明从model对应数据表中读出哪些字段
        # id字段我们在model中并没指明应该是框架自己创建的
        # 另外我们还创建了created字段，但这里我们不加读取他，当然你要读取加上即可
        fields = ('id', 'username', 'password')

 

3.3 设定路由

编缉drest/urls.py，写入以下内容：

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

urlpatterns = [
    url(r'^test/$', views.test),
]

 

3.4 创建视图

在REST中视图已经不是mvc中的html与后端代码混淆的那种.jsp或.aspx页面了，所指的是生成并返回json/xml结果的东西（反而更像mvc中的m）。

在路由中我们设定链接test，指向test视图；我们这里来实现test视图，该视图使用3.2中的序列化类读取3.1中对应的数据表的所有内容实现序列化并返回。

from django.http import JsonResponse
from rest_framework.parsers import JSONParser
from drest.serializers import Test
from drest.serializers import TestSerializer

def test(request):
    """
    List all code snippets, or create a new snippet.
    """
    if request.method == 'GET':# 这里应该是model对应的所有字段
        test_obj = Test.objects.all()
        # 序列化
        serializer = TestSerializer(test_obj, many=True)
        # 返回
        return JsonResponse(serializer.data, safe=False)

    # 此框架想实现原始REST的思想，如果是post就保存到数据库，这里暂且保留虽然我觉得不实用
    elif request.method == 'POST':
        data = JSONParser().parse(request)
        serializer = TestSerializer(data=data)
        if serializer.is_valid():
            serializer.save()
            return JsonResponse(serializer.data, status=201)
        return JsonResponse(serializer.errors, status=400)

 

3.5 创建model对应数据表

我们在3.1中就建好了model，在官方文档中都是建好model就建对应数据表的，但是由于我对实现步骤做了调整如果在3.1中就建表，会因程序有错误而创建失败，所以我们只能到这里才创建类据表。

指示在数据库中创建model对应的表，进入到manage.py目录执行以下命令：

python manage.py makemigrations drest
python manage.py migrate

 

执行完成后在manage.py同级目录下可以看到一个db.sqlite3文件，该文件是一个sqlite3数据库。

使用SQLiteStudio等工具打开，可以看到有一个dres_test的表其字段“created”、“username”、“password”正是我们在model中配置好的。

 

 

3.6 向drest_test表插入数据

我们一直说TestSerializer的作用是读取drest_test表的所有内容并序列化，在上一步中我们创建好了drest_test；但是我们在model的注释中也说过创建数据表时不会向表中插入数据，也就是说此时drest_test表虽创建好了但其是一个空表是没数据的，此时如果我们运行程序并访问test链接那返回是空值。所以我们要向drest_test表中插入数据。

进入到manage.py目录执行以下命令启动shell：

python manage.py shell

为了更好地说明model中default的作用我们插入两条数据：

from drest.models import Test
from drest.serializers import TestSerializer
from rest_framework.renderers import JSONRenderer
from rest_framework.parsers import JSONParser

test = Test()
test.save()
test = Test(username='root')
test.save()

此时查看drest_test表的内容，如下所示正是我们插入的两条数据：

 

3.7 启动程序并访问

我们前面说过运行django项目run的一定要是我们2.5中设置的运行环境，现在虽加项目进行了如些复杂的操作但项目还是django项目还是要运行那个环境（名为django）。

pycharm切换到manage.py----在其上右键----选择Run ‘django’，程序成功运行如下：

 我们看到监听地址为http://127.0.0.1:8000/，而我们设置的路由是test

打开浏览器访问http://127.0.0.1:8000/test，结果如下图，返回结果与预期完全一致：

 

四、使用总结

英文水平一般加上没用过Django也没写过REST，所以费了点周章但总算是完成了。

我们写程序工作总不会都是读取数据库表然后返回，主要还是一些交互逻辑代码，推测这些代码应该是写在view上在view决定好返回结果后，将结果传到serializers.Serializer的实现类（上面为了复用model我们实现的是serializers.ModelSerializer）完成序列化。更具体的还要再写写才好确定。

网上现有的很多教和感觉就是自己把英文版翻译成中文，但又不能很好地解框架到底在做什么，尤其是model其实是用来创建数据表和序列化类本质是读取数据表的内容并返回这两点，导致翻译得似是而非反而让人更难理解框架的本质。

 

参考：

https://www.runoob.com/django/django-tutorial.html

https://www.django-rest-framework.org/tutorial/1-serialization/

https://stackoverflow.com/questions/28241203/objects-all-not-returning-any-objects-in-django