前后端开发模式、API接口、接口测试工具postman、restful规范、序列化和反序列化、drf快速使用、cbv源码分析

前后端开发模式

传统的开发模式

前端写好静态的HTML页面交付给后端开发。静态页面可以本地开发，也无需考虑业务逻辑只需要实现View即可。后端使用模板引擎去套模板，同时内嵌一些后端提供的模板变量和一些逻辑操作。然后前后端集成对接，遇到问题，前台返工，后台返工。然后在集成，直至集成成功。

这种模式的问题

在前端调试的时候要安装完整的一套后端开发工具，要把后端程序完全启动起来。遇到问题需要后端开发来帮忙调试。我们发现前后端严重耦合，还要要求后端人员会一些HTML，JS等前端语言。前端页面里还嵌入了很多后端的代码。一旦后端换了一种语言开发，简直就要重做。

像这种增加了大量的沟通成本，调试成本等，而且前后端的开发进度相互影响，从而大大降低了开发效率。

前后端分离的开发模式

前后端分离不只是开发模式，而是web应用的一种架构模式。在开发阶段，前后端工程师约定好数据交互接口，实现并行开发和测试；在运行阶段前后端分离模式需要对web应用进行分离部署，前后端之前使用HTTP或者其他协议进行交互请求。

客户端和服务端采用restful api的交互方式进行交互

前后端代码库分离

在传统架构模式中，前后端代码存放于同一个代码库中，甚至是同一个工程目录下。页面中还夹杂着后端代码。前后端工程师进行开发时，都必须把整个项目导入到开发工具中。

前后端代码库分离，前端代码中有可以进行Mock测试(通过构造虚拟测试对象以简化测试环境的方法)的伪后端，能够支持前端的独立开发和测试。而后端代码中除了功能实现外，还有着详细的测试用例，以保证API的可用性，降低集成风险。

API接口

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

通过网络，规定了前后台信息交互规则的url链接，也就是前后台信息交互的媒介

Web API接口和一般的url链接还是有区别的，Web API接口简单概括有下面四大特点：

url:长得像返回数据的url链接

https://api.map.baidu.com/place/v2/search
'采用get方式请求上方接口'

请求方式:get 、post、put、patch、delete
请求参数:json或xml格式的key-value类型数据

ak：6E823f587c95f0148c19993539b99295
region：上海
query：肯德基
output：json

响应结果：json或xml格式的数据

上方请求参数的output参数数值决定了响应数据的格式

数据

# xml格式
https://api.map.baidu.com/place/v2/search?ak=6E823f587c95f0148c19993539b99295&region=%E4%B8%8A%E6%B5%B7&query=%E8%82%AF%E5%BE%B7%E5%9F%BA&output=xml
#json格式
https://api.map.baidu.com/place/v2/search?ak=6E823f587c95f0148c19993539b99295&region=%E4%B8%8A%E6%B5%B7&query=%E8%82%AF%E5%BE%B7%E5%9F%BA&output=json
{
    "status":0,
  	"message":"ok",
    "results":[
        {
            "name":"肯德基(罗餐厅)",
            "location":{
                "lat":31.415354,
                "lng":121.357339
            },
            "address":"月罗路2380号",
            "province":"上海市",
            "city":"上海市",
            "area":"宝山区",
            "street_id":"339ed41ae1d6dc320a5cb37c",
            "telephone":"(021)56761006",
            "detail":1,
            "uid":"339ed41ae1d6dc320a5cb37c"
        }
      	...
		]
}

接口测试工具postman

Postman是一款接口调试工具，是一款免费的可视化软件，同时支持各种操作系统平台，是测试接口的首选工具。

man可以直接从官网：https://www.getpostman.com/downloads/下载获得，然后进行傻瓜式安装。

案例：请求百度地图接口

restful规范

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

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

restful规范有十大点(公司有自己的风格规范)

数据的安全保障

url链接一般都采用https协议进行传输，为了保证数据安全使用https协议传输

https即：http+ssl/tsl  # 即数据传输以http为安全通道，并在此基础上通过传输加密和身份认真保证了传输过程的安全性

接口中带api关键字

https://api.baidu.com/books   域名中
https://www.baidu.com/api     地址中

多数据版本共存

即接口地址中标识版本标识

https://api.baidu.com/v1
https://api.weibo.com/2/statuses/user_timeline.json

如果迭代了一个接口，老的接口代码不应该动，应该新开一个接口，并在接口地址中标识版本

数据即是资源，均使用名词(可用复数)

都是用名词，没法区分是增加，删除，修改，查询

资源操作由请求方式决定

获取数据：get请求
删除数据：delete请求
新增数据：post请求
修改数据值：put，patch请求
请求地址一样，通过请求方式决定对资源进行什么操作

url地址中带过滤参数

搜索条件之类的应该放在url中(get请求)

获取动物园中所有动物

127.0.0.1/api/v1/animals

获取动物园所有哺乳类动物

127.0.0.1/api/v1/animals?type=哺乳类

响应带状态码

http状态码大全网址

http状态码

1xx:表示请求正在处理，一般看不到
2xx:表示请求处理成功，有很多，200请求成功,201创建成功
3xx:重定向 302 301  问301和302的区别？301是永久重定向，302是临时重定向
4xx:客户端错误  403 404
   403：服务器理解请求客户端的请求，但是拒绝执行此次请求
   404：服务器无法根据客户端的请求找到资源网页
5xx:服务端错误

响应体中写状态码

公司都有规范，在响应体中写状态码

{"status":0,
 "message":"ok",}

返回错误信息

响应体中带错误信息

{"code":100,"msg":成功}

返回结果，针对不同操作，服务器向用户返回的结果应该符合以下规范

GET /collection：返回资源对象的列表(数组)[{},{}]
GET /collection/resource：返回单个资源对象 {}
POST /collection：返回新生成的资源对象 {}
PUT /collection/resource：返回完整的资源对象 {}
PATCH /collection/resource：返回完整的资源对象 {}
DELETE /collection/resource：返回一个空文档

'获取所有'
{code:100,msg:成功,data:[{name:金梅,price:99},{name:西游记,price:88}]}
'获取单条'
{code:100,msg:成功,data:{name:金梅,price:99}}
'新增数据'
{code:100,msg:新增成功,data:{name:西游记,price:99}}
'修改数据'
{code:100,msg:修改成功,data:{name:西游记v2版本,price:99}}
'删除数据'
{code:100,msg:删除成功}

响应中带链接

# Hypermedia API，RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么
{
  	"status": 0,
  	"msg": "ok",
  	"results":[
        {
            "name":"肯德基(罗餐厅)",
            "img": "https://image.baidu.com/kfc/001.png"
        }
      	...
		]
}

比较好的接口返回

# 响应数据要有状态码、状态信息以及数据本身
{
  	"status": 0,
  	"msg": "ok",
  	"results":[
        {
            "name":"肯德基(罗餐厅)",
            "location":{
                "lat":31.415354,
                "lng":121.357339
            },
            "address":"月罗路2380号",
            "province":"上海市",
            "city":"上海市",
            "area":"宝山区",
            "street_id":"339ed41ae1d6dc320a5cb37c",
            "telephone":"(021)56761006",
            "detail":1,
            "uid":"339ed41ae1d6dc320a5cb37c"
        }
      	...
		]
}

序列化和反序列化

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

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

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

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

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

djangorestframework快速使用

虽然用django框架也能编写api接口，但是使用djangorestframework能缩减编写api接口的代码，这也是它的核心思想

django rest framework是一个建立在django基础之上的web应用开发框架，可以快速的开发rest api接口应用。在restframework中提供了序列化器Serialzier的定义，可以帮助我们简化序列化和反序列化的过程，不仅如此，还提供丰富的类视图、扩展类、视图集来简化视图的编写工作。restframework还提供了认证、权限、限流、过滤、分页、接口文档等功能支持。restframework提供了一个api的web可视化界面来方便查看测试接口

官方文档

github

安装djangorestframework

pip3.8 install djangorestframework

在我们用djangorestframework开发接口时，所有的接口都是基于以下5种接口

获取所有:get
获取单条:get
新增一条:post
修改一条:put/patch
删除一条:delete

基于drf快速实现增删改查

# models.py
class Book(models.Model):
  name=models.CharField(max_length=32)
  price=models.CharField(max_length=10)
  publish=models.CharField(max_length=32)
  
# 新建一个serializer.py文件
from rest_framework import serializers
from .models import Book
class BookSerializer(serializers.ModelSerializer):
    class Meta:
        model=Book
        fields='__all__'
        
# views.py
from .models import Book
from rest_framework.viewsets import ModelViewSet
from .serializer import BookSerializer

class BookView(ModelViewSet):
  queryset=Book.object.all()
  serializer_class=BookSerializer

# urls.py
from django.contrib import admin
from django.urls import path
from rest_framework.routers import SimpleRouter
from app01 import views

router=SimpleRouter()
router.register('books',views.BookView)
urlpatterns = [
    path('admin/', admin.site.urls),
]
urlpatterns +=router.urls

通过postman测试查、增、改、删

GET查

# GET
http://127.0.0.1:8000/books/

# GET
http://127.0.0.1:8000/books/1/

POST增

PUT改

DELETE删

http://127.0.0.1:8000/books/4/   # 返回1 表明删除成功

cbv源码分析

写一个cbv视图函数

code={
    'code':100,
    'msg':'成功'
}    
class TestView(views.View):
    def get(self,request):
        return JsonResponse(code)

配置路由

path('test/', views.TestView.as_view()),

第一个参数是路径，第二个参数是视图函数的内存地址(视图类执行as_view这个类方法,查看源码可以看出返回的是view这个函数内存地址)

# estView类中找不到View，去父类中找View
        @classonlymethod
        def as_view(cls, **initkwargs):
            def view(request, *args, **kwargs):
                return self.dispatch(request, *args, **kwargs)
            return view

当请求(request)来的时候，路由匹配成功，会执行view(request),然后view中返回了self.dispatch(request,*args,**kwargs)这个方法，通过此方法中的反射执行视图类中的请求方法

-去View中找到了dispatch
    def dispatch(self, request, *args, **kwargs):
        # 请求方式转成小写，假设 get 请求，符合if条件
        if request.method.lower() in self.http_method_names:
            # 反射 getattr(对象,'字符串','对象中没有字符串的方法或属性返回的默认值')
            # self是TestView的对象
            # handler 就是TestView类的get方法
            handler = getattr(self, 'get', self.http_method_not_allowed)
        else:
            handler = self.http_method_not_allowed
        return handler(request, *args, **kwargs)  # get(request)

posted @ 2022-09-23 17:58 荀飞阅读(162) 评论(0) 编辑收藏举报

刷新页面返回顶部

前后端开发模式、API接口、接口测试工具postman、restful规范、序列化和反序列化、drf快速使用、cbv源码分析