接口作为方法参数的优势 java

内容

• Web应用模式
• api接口
• RESTful API规范
• 序列化
• Django Rest_Framework
• 环境安装与配置
• drf完全简写代码的过程

1. Web应用模式

在开发Web应用中，有两种应用模式：

1. 前后端不分离[客户端看到的内容和所有界面效果都是由服务端提供出来的。]

1. 前后端分离【把前端的界面效果(html，css，js分离到另一个服务端，python服务端只需要返回数据即可)】
   前端形成一个独立的网站，服务端构成一个独立的网站

django一般都做web网站，如果可以利用django实现前后端分离，则django就可以完成地铁站的运营调度系统，路由的终端系统，pos机的服务端系统，游戏的服务端后台，软件的服务端后台。

2. api接口

为了在团队内部形成共识、防止个人习惯差异引起的混乱，我们需要找到一种大家都觉得很好的接口实现规范，而且这种规范能够让后端写的接口，用途一目了然，减少双方之间的合作成本。

目前市面上大部分公司开发人员使用的接口服务架构主要有：restful、rpc、soap。

rpc: 翻译成中文:远程过程调用[远程服务调用].remote procedure call

服务端提供单一的请求数据的api地址：http://api.renran.cn/

post请求

action=get_all_student&params=301&sex=1

优势：

1.不需要管当前操作是什么http请求，也不需要操作url地址的编写，对接

缺点：

1.接口多了,对应函数名和参数就多了,前端在请求api接口时,就会比较难找.容易出现重复的接口

restful: 资源状态转换.

思想:把后端所有的数据/文件都看成资源. 那么接口请求数据,本质上来说就是对资源的操作了.

web项目中操作资源,无非就是增删查改.所以要求在地址栏中声明要操作的资源是什么,然后通过http请求动词来说明对资源进行哪一种操作.

POST http://www.renran.cn/api/students/ 添加学生数据

GET http://www.renran.cn/api/students/ 获取所有学生

DELETE http://www.renran.cn/api/students// 删除id=pk(primary key)的一个学生

PUT http://www.renran.cn/api/students// 修改一个学生的全部信[id,name,sex,age,]

PATCH http://www.renran.cn/api/students// 修改一个学生的部分信息[age]

优点：

1、维护开发简单，可以保证后期开发不会出现太多重复的接口

缺点：

1、有部分接口不会有明确的增删查改的区分，所以会出现一些不伦不类的接口。会因为这些语义不明，不伦不类的接口导致后期的维护成本上升。

2、因为restful把对于资源的操作都理解成了增删查改，建议使用http，所以restful接口天生局限于web开发

3. RESTful API规范

REST全称是Representational State Transfer，中文意思是表述（编者注：通常译为表征）性状态转移。 它首次出现在2000年Roy Fielding的博士论文中。

RESTful是一种定义Web API接口的设计风格，尤其适用于前后端分离的应用模式中。

这种风格的理念认为后端开发任务就是提供数据的，对外提供的是数据资源的访问接口，所以在定义接口时，客户端访问的URL路径就表示这种要操作的数据资源。

而对于数据资源分别使用POST、DELETE、GET、UPDATE等请求动作来表达对数据的增删查改。

事实上，我们可以使用任何一个框架都可以实现符合restful规范的API接口。

参考文档：http://www.runoob.com/w3cnote/restful-architecture.html

接口实施过程中，会存在幂等性。所谓幂等性是指代客户端发起多次请求是否对于服务端里面的资源产生不同结果。如果多次请求，服务端结果还是一样，则属于幂等接口，如果多次请求，服务端产生结果是不一样的，则属于非幂等接口。在http请求，get/put/patch/delete都属于幂等性接口，post属于非幂等接口。

幂等性：研究的是多次请求同一个接口对于返回数据的影响

为什么要考虑幂等性？主要就是接口操作的安全性问题。

4. 序列化

往外发数据：序列化

回收数据：反序列化

api接口开发，最核心最常见的一个过程就是序列化，所谓序列化就是把数据转换格式，序列化可以分两个阶段：

序列化： 把我们识别的数据转换成指定的格式提供给别人。

例如：我们在django中获取到的数据默认是模型对象，但是模型对象数据无法直接提供给前端或别的平台使用，所以我们需要把数据进行序列化，变成字符串或者json数据，提供给别人。

反序列化：把别人提供的数据转换/还原成我们需要的格式。

例如：前端js提供过来的json数据，对于python而言就是字符串，我们需要进行反序列化换成模型类对象，这样我们才能把数据保存到数据库中。

5. Django Rest_Framework

核心思想: 缩减编写api接口的代码

Django REST framework是一个建立在Django基础之上的Web 应用开发框架，本质来说就是一个内置在django里面的子应用，可以快速的开发REST API接口应用。

在REST framework中，提供了序列化器对象Serialzier的定义，可以帮助我们简化序列化与反序列化的过程，不仅如此，还提供丰富的类视图、扩展类、视图集来简化视图的编写工作。REST framework还提供了认证、权限、限流、过滤、分页、接口文档等功能支持。REST framework提供了一个用于测试API接口 的Web可视化界（可以浏览器直接访问接口，drf的api测试页面非常美观）来方便查看测试接口。

中文文档：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 Json web token]
• 内置了限流系统；
• 直观的 API web 界面；【方便我们调试开发api接口】
• 可扩展性，插件丰富

6. 环境安装与配置

DRF需要以下依赖：

• Python (2.7, 3.2以上)
• Django (1.10, 1.11, 2.0以上)

DRF是以Django扩展应用的方式提供的，所以我们可以直接利用已有的Django环境而无需从新创建。（若没有Django环境，需要先创建环境安装Django）

6.1 安装DRF

前提是已经安装了django，建议安装在虚拟环境

# mkvirtualenv drfdemo -p python3
# pip install django==2.2.0  -i https://pypi.douban.com/simple

pip install djangorestframework -i https://pypi.douban.com/simple

# 因为我们需要接下来，需要开发api接口肯定要操作数据，所以安装pymysql
pip install pymysql -i https://pypi.douban.com/simple

linux的终端下 粘贴内容 快捷键： shift+insert

6.1.1 创建django项目

cd ~/Desktop
django-admin startproject drfdemo

使用pycharm打开项目，设置虚拟环境的解析器，并修改manage.py中的后缀参数（可以修改参数）

6.2 添加rest_framework应用

在settings.py的INSTALLED_APPS中添加'rest_framework'。

INSTALLED_APPS = [
    ...
    'rest_framework',
]

接下来就可以使用DRF提供的功能进行api接口开发了。在项目中如果使用rest_framework框架实现API接口，主要有以下三个步骤：

• 将请求的数据（如JSON格式）转换为模型类对象
• 通过模型类对象进行数据库操作，完成客户端请求的增删查改
• 将模型类对象转换为响应的数据（如JSON格式）

接下来，我们快速体验下我们学习完成drf以后的开发代码。

6.3 体验drf完全简写代码的过程

提供数据接口四个步骤

1. 创建模型类
2. 创建序列化器
3. 编写视图
4. 定义路由

6.3.0 创建子应用

# 项目根目录下创建子应用，用于展示当前例子。

python manage.py startapp students

6.3.1. 创建模型操作类

子应用的models.py创建模型对象

from django.db import models

# Create your models here.students

class Student(models.Model):
    # 字段声明
    # 字段名 = models.数据类型（数据约束）
    name =models.CharField(null=False, max_length=32, verbose_name="姓名")
    age = models.IntegerField(verbose_name='年龄')
    sex = models.BooleanField(default=1, verbose_name="性别")
    class_num = models.CharField(max_length=5, verbose_name="班级编号")
    description = models.TextField(max_length=1000, verbose_name="个性签名")

    # 表信息
    class Meta:
        # 声明表名
        db_table="tb_students"
        # 表名注释
        verbose_name="学生"
        verbose_name_plural=verbose_name

    # 模型的操作方法
    def __str__(self):
        return self.name

链接数据库

mysql -uroot 密码

为了方便测试，所以我们可以先创建一个数据库。

create database students charset=utf8;

退出数据库

exit

6.3.1.1 执行数据迁移

把students子应用添加到INSTALL_APPS中

初始化数据库连接

安装pymysql
pip install pymysql

主引用中__init__.py设置使用pymysql作为数据库驱动

import pymysql

pymysql.install_as_MySQLdb()

如果提示版本错误，去base.pu注释掉两行代码

# if version < (1, 3, 13):
#     raise ImproperlyConfigured('mysqlclient 1.3.13 or newer is required; you have %s.' % Database.__version__)

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行代码。

# 执行数据迁移发生以下错误：python3中bytes数据转换的问题

解决方法：

backends/mysql/operations.py146行里面替换一个行代码：

6.3.2. 创建序列化器

在students应用目录中新建serializers.py用于保存该应用的序列化器。

创建一个StudentModelSerializer用于序列化与反序列化。

from rest_framework import serializers
from .models import Student

class StudentModelSerializer(serializers.ModelSerializer):
    # 需要进行数据的转换的字段

    # 当前转换的模型类相关声明
    class Meta:
        model = Student
        fields = "__all__"

    # 验证数据的方法[反序列化：接收客户端的数据]

    # 操作数据的带密码[反序列化：保存数据（添加/更新）]

• model
• fields 指明该序列化器包含模型类中的哪些字段，'all'指明包含所有字段

6.3.3. 编写视图

在students应用的views.py中创建视图StudentViewSet，这是一个视图集合。

from django.shortcuts import render

# Create your views here.

# django的视图有两种，FBV函数视图和CBV类视图
from rest_framework.viewsets import ModelViewSet
from .models import Student
from .serializers import StudentModelSerializer

class StudentAPIView(ModelViewSet):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer

• queryset
• serializer_class

6.3.4. 定义路由

在students应用的urls.py中定义路由信息。

from .views import StudentAPIView
from rest_framework.routers import DefaultRouter

# 路由列表
urlpatterns = []

# 使用drf提供的路由类来自动生成路由
router = DefaultRouter()  # 可以处理视图的路由器
router.register("stu", StudentAPIView)  # 向路由器中注册视图集
urlpatterns += router.urls  # 将路由器中的所以路由信息追到到django的路由列表中

最后把students子应用中的路由文件加载到总路由文件中.

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

# 新版本的django把url拆分成了两个路由函数
# django.urls.path 专门编写字符串路由
# django.urls.re_path 专门编写正则路由

urlpatterns = [
    path('admin/', admin.site.urls),
    path('students/', include("students.urls"))

6.3.5. 运行测试

运行当前程序（与运行Django一样）

python manage.py runserver

在浏览器中输入网址127.0.0.1:8000，可以看到DRF提供的API Web浏览页面：

1）点击链接127.0.0.1:8000/stu/students 可以访问获取所有数据的接口，呈现如下页面：

2）在页面底下表单部分填写学生信息，可以访问添加新学生的接口，保存学生信息：

点击POST后，返回如下页面信息：

3）在浏览器中输入网址127.0.0.1:8000/stu/students/5/，可以访问获取单一学生信息的接口（id为5的学生），呈现如下页面：

4）在页面底部表单中填写学生信息，可以访问修改学生的接口：

点击PUT，返回如下页面信息：

5）点击DELETE按钮，可以访问删除学生的接口：

返回，如下页面：