1. Web应用模式
在开发Web应用中，有两种应用模式：
-
前后端不分离
2.前后端分离
2. api接口
为了在团队内部形成共识、防止个人习惯差异引起的混乱，我们需要找到一种大家都觉得很好的接口实现规范，而且这种规范能够让后端写的接口，用途一目了然，减少双方之间的合作成本。
目前市面上大部分公司开发人员使用的接口服务架构主要有：restful、rpc。
rpc: 翻译成中文:远程过程调用[远程服务调用].
post请求
action=get_all_student¶ms=301&sex=1
接口多了,对应函数名和参数就多了,前端在请求api接口时,就会比较难找.容易出现重复的接口
restful: 翻译成中文: 资源状态转换.
把后端所有的数据/文件都看成资源.
那么接口请求数据,本质上来说就是对资源的操作了.
web项目中操作资源,无非就是增删查改.所以要求在地址栏中声明要操作的资源是什么,然后通过http请求动词来说明对资源进行哪一种操作.
eg:POST http://www.lufei.com/api/students/ 添加学生数据
GET http://www.lufei.com/api/students/ 获取所有学生
DELETE http://www.lufei.com/api/students/<pk> 删除1个学生
RESTful是一种定义Web API接口的设计风格，尤其适用于前后端分离的应用模式中。
这种风格的理念认为后端开发任务就是提供数据的，对外提供的是数据资源的访问接口，所以在定义接口时，客户端访问的URL路径就表示这种要操作的数据资源。
而对于数据资源分别使用POST、DELETE、GET、UPDATE等请求动作来表达对数据的增删查改。
| 请求方法 | 请求地址 | 后端操作 |
|---|---|---|
| GET | /students | 获取所有学生 |
| POST | /students | 增加学生 |
| GET | /students/<pk> | 获取编号为pk的学生 |
| PUT | /students/<pk> | 修改编号为pk的学生 |
| DELETE | /students/<pk> | 删除编号为pk的学生 |
事实上，我们可以使用任何一个框架都可以实现符合restful规范的API接口。
参考文档：http://www.runoob.com/w3cnote/restful-architecture.html
4. 序列化
api接口开发，最核心最常见的一个过程就是序列化，所谓序列化就是把数据转换格式，序列化可以分两个阶段：
序列化： 把我们识别的数据转换成指定的格式提供给别人。
反序列化：把别人提供的数据转换/还原成我们需要的格式。
例如：前端js提供过来的json数据，对于python而言就是字符串，我们需要进行反序列化换成模型类对象，这样我们才能把数据保存到数据库中。
5. Django Rest_Framework
核心思想: 缩减编写api接口的代码
Django REST framework是一个建立在Django基础之上的Web 应用开发框架，可以快速的开发REST API接口应用。在REST framework中，提供了序列化器Serialzier的定义，可以帮助我们简化序列化与反序列化的过程，不仅如此，还提供丰富的类视图、扩展类、视图集来简化视图的编写工作。REST framework还提供了认证、权限、限流、过滤、分页、接口文档等功能支持。REST framework提供了一个API 的Web可视化界面来方便查看测试接口。
中文文档：https://q1mi.github.io/Django-REST-framework-documentation/#django-rest-framework
github: https://github.com/encode/django-rest-framework/tree/master
特点
-
提供了定义序列化器Serializer的方法，可以快速根据 Django ORM 或者其它库自动序列化/反序列化；
-
提供了丰富的类视图、Mixin扩展类，简化视图的编写；
-
丰富的定制层级：函数视图、类视图、视图集合到自动生成 API，满足各种需要；
-
多种身份认证和权限认证方式的支持；[jwt]
-
内置了限流系统；
-
直观的 API web 界面；
-
6. 环境安装与配置
DRF需要以下依赖：
-
Python (2.7, 3.2, 3.3, 3.4, 3.5, 3.6)
-
Django (1.10, 1.11, 2.0)
DRF是以Django扩展应用的方式提供的，所以我们可以直接利用已有的Django环境而无需从新创建。（若没有Django环境，需要先创建环境安装Django）
6.1 安装DRF
前提是已经安装了django，建议安装在虚拟环境
# mkvirtualenv drfdemo -p python3
# pip install django
pip install djangorestframework
pip install pymysql
linux 复制 shift+insert
6.1.1 创建django项目
cd ~/Desktop
django-admin startproject drfdemo
6.2 添加rest_framework应用
在settings.py的INSTALLED_APPS中添加'rest_framework'。
INSTALLED_APPS = [
...
'rest_framework',
]
接下来就可以使用DRF提供的功能进行api接口开发了。在项目中如果使用rest_framework框架实现API接口，主要有以下三个步骤：
-
将请求的数据（如JSON格式）转换为模型类对象
-
操作数据库
-
将模型类对象转换为响应的数据（如JSON格式）
6.3.1. 创建模型操作类
class Student(models.Model):
# 模型字段
name = models.CharField(max_length=100,verbose_name="姓名")
sex = models.BooleanField(default=1,verbose_name="性别")
age = models.IntegerField(verbose_name="年龄")
class_null = models.CharField(max_length=5,verbose_name="班级编号")
description = models.TextField(max_length=1000,verbose_name="个性签名")
class Meta:
db_table="tb_student"
verbose_name = "学生"
verbose_name_plural = verbose_name
为了方便测试，所以我们可以先创建一个数据库。
create database students charset=utf8;
6.3.1.1 执行数据迁移
初始化数据库连接
安装pymysql
pip install pymysql
主引用中__init__.py设置使用pymysql作为数据库驱动
import pymysql
pymysql.install_as_MySQLdb()
settings.py配置文件中设置mysql的账号密码
DATABASES = {
# 'default': {
# 'ENGINE': 'django.db.backends.sqlite3',
# 'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
# },
'default': {
'ENGINE': 'django.db.backends.mysql',
'NAME': "students",
"HOST": "127.0.0.1",
"PORT": 3306,
"USER": "root",
"PASSWORD":"123",
}
}
终端下，执行数据迁移。
python manage.py makemigrations
python manage.py migrate
# 执行数据迁移 python manage.py makemigrations 报错如下：
解决方案：
注释掉 backends/mysql/base.py中的35和36行代码。
# 执行数据迁移发生以下错误：
解决方法：
backends/mysql/operations.py146行里面新增一个行代码：
6.3.2. 创建序列化器
例如，在django项目中创建学生子应用。
python manage.py startapp students
在syudents应用目录中新建serializers.py用于保存该应用的序列化器。
创建一个StudentModelSerializer用于序列化与反序列化。
from rest_framework import serializers
from .models import Student
# 创建序列化器类，回头会在试图中被调用
class StudentModelSerializer(serializers.ModelSerializer):
class Meta:
model = Student
fields = "__all__"
-
model 指明该序列化器处理的数据字段从模型类BookInfo参考生成
-
fields 指明该序列化器包含模型类中的哪些字段，'all'指明包含所有字段
###########第一种 所有字段 从models导入########### from rest_framework import serializers from .models import Student # 创建序列化器类，回头会在试图中被调用 class StudentModelSerializer(serializers.ModelSerializer): class Meta: model = Student fields = "__all__" ###########第二种 自己定义字段 跟models对########### from rest_framework import serializers # 声明序列化器，所有的序列化器都要直接或者间接继承于 Serializer # 其中，ModelSerializer是Serializer的子类，ModelSerializer在Serializer的基础上进行了代码简化 class StudentSerializer(serializers.Serializer): """学生信息序列化器""" # 1. 需要进行数据转换的字段 id = serializers.IntegerField() name = serializers.CharField() age = serializers.IntegerField() sex = serializers.BooleanField() description = serializers.CharField() # 2. 如果序列化器集成的是ModelSerializer，则需要声明调用的模型信息 # 3. 验证代码 # 4. 编写添加和更新模型的代码
6.3.3. 编写视图
在students应用的views.py中创建视图StudentViewSet，这是一个视图集合。
from rest_framework.viewsets import ModelViewSet
from .models import Student
from .serializers import StudentModelSerializer
# Create your views here.
class StudentViewSet(ModelViewSet):
queryset = Student.objects.all()
serializer_class = StudentModelSerializer
-
queryset 指明该视图集在查询数据时使用的查询集
-
serializer_class 指明该视图在进行序列化或反序列化时使用的序列化器
#########第一种方式######## 在students应用的views.py中创建视图StudentViewSet，这是一个视图集合。继承rest_framework.viewset的视图集类 from rest_framework.viewsets import ModelViewSet from .models import Student from .serializers import StudentModelSerializer # Create your views here. class StudentViewSet(ModelViewSet): queryset = Student.objects.all() serializer_class = StudentModelSerializer #########第二种方式############## 自定义Django视图类 继承django.views # Create your views here. from django.views import View from students.models import Student from .serializers import StudentSerializer from django.http.response import JsonResponse class StudentsView(View): """使用序列化器序列化转换多个模型数据""" def get(self,request): # 获取数据 student_list = Student.objects.all() # 转换数据[序列化过程] # 如果转换多个模型对象数据，则需要加上many=True serializer = StudentSerializer(instance=student_list,many=True) print( serializer.data ) # 序列化器转换后的数据 # 响应数据给客户端 # 返回的json数据，如果是列表，则需要声明safe=False return JsonResponse(serializer.data,safe=False) class StudentView(View): """使用序列化器序列化转换单个模型数据""" def get(self,request,pk): # 获取数据 student = Student.objects.get(pk=pk) # 数据转换[序列化过程] serializer = StudentSerializer(instance=student) print(serializer.data) # 响应数据 return JsonResponse(serializer.data)
6.3.4. 定义路由
在students应用的urls.py中定义路由信息。
from . import views
from rest_framework.routers import DefaultRouter
# 路由列表
urlpatterns = []
router = DefaultRouter() # 可以处理视图的路由器
router.register('students', views.StudentViewSet) # 向路由器中注册视图集
urlpatterns += router.urls # 将路由器中的所以路由信息追到到django的路由列表中
最后把students子应用中的路由文件加载到总路由文件中.
from django.contrib import admin
from django.urls import path,include
urlpatterns = [
path('admin/', admin.site.urls),
path("stu/",include("students.urls")),
]
6.3.5. 运行测试
运行当前程序（与运行Django一样）
python manage.py runserver
在浏览器中输入网址127.0.0.1:8000，可以看到DRF提供的API Web浏览页面：
点击POST后，返回如下页面信息：
3）在浏览器中输入网址127.0.0.1:8000/stu/students/5/，可以访问获取单一学生信息的接口（id为5的学生），呈现如下页面：
点击PUT，返回如下页面信息：
返回，如下页面：
序列化小栗子 将模型对象数据序列化给web前端
# Create your views here. from django.views import View from students.models import Student from .serializers import StudentSerializer from django.http.response import JsonResponse class StudentsView(View): """使用序列化器序列化转换多个模型数据""" def get(self,request): # 获取数据 student_list = Student.objects.all() # 转换数据[序列化过程] # 如果转换多个模型对象数据，则需要加上many=True serializer = StudentSerializer(instance=student_list,many=True) #源码：def __init__(self, instance=None, data=empty, **kwargs): #模型数据序列化：instance=student_list web前端数据反序列化：data=empty, data参数接收 print( serializer.data ) # 序列化器转换后的数据 将student_list序列化 有序字典（注：字典时无序的） [OrderedDict([('id', 1), ('name', '大头'), ('age', 18), ('sex', True), ('description', 'python great')])] # 响应数据给客户端 # 返回的json数据，如果是列表，则需要声明safe=False return JsonResponse(serializer.data,safe=False) class StudentView(View): """使用序列化器序列化转换单个模型数据""" def get(self,request,pk): # 获取数据 student = Student.objects.get(pk=pk) # 数据转换[序列化过程] serializer = StudentSerializer(instance=student) print(serializer.data) #{'id': 1, 'name': '大头', 'age': 18, 'sex': True, 'description': 'python great'} # 响应数据 return JsonResponse(serializer.data)
from rest_framework import serializers # 声明序列化器，所有的序列化器都要直接或者间接继承于 Serializer # 其中，ModelSerializer是Serializer的子类，ModelSerializer在Serializer的基础上进行了代码简化 class StudentSerializer(serializers.Serializer): """学生信息序列化器""" # 1. 需要进行数据转换的字段 id = serializers.IntegerField() name = serializers.CharField() age = serializers.IntegerField() sex = serializers.BooleanField() description = serializers.CharField() # 2. 如果序列化器集成的是ModelSerializer，则需要声明调用的模型信息 # 3. 验证代码 # 4. 编写添加和更新模型的代码
from django.db import models # Create your models here. class Student(models.Model): name = models.CharField(max_length=100,verbose_name="姓名") sex = models.BooleanField(default=1,verbose_name="性别") age = models.IntegerField(verbose_name="年龄") class_null = models.CharField(max_length=5,verbose_name="班级编号") description = models.TextField(max_length=1000,verbose_name="个性签名") class Meta: db_table="tb_student" verbose_name ="学生" verbose_name_plural = verbose_name
from django.urls.conf import path,re_path from . import views urlpatterns = [ path(r"students/",views.StudentsView.as_view()), re_path(r"students/(?P<pk>d+)/",views.StudentView.as_view()), ]
from django.contrib import admin from django.urls import path,include urlpatterns = [ path('admin/', admin.site.urls), path("stu/",include("students.urls")) ]