drf( Restful规范——序列化与反序列化——DjangoRESTframewordk用法——原生与drf实现接口)等

发布时间 2023-12-19 13:40:58作者: 拆尼斯、帕丁顿

# Restful规范(重要-概念)

```python
# API接口---》后端要提供api接口---》2000年Roy Fielding的博士论文中

### restful是什么?
REST全称是Representational State Transfer,表征性状态转移
Web API接口的设计风格,尤其适用于前后端分离的应用模式中

# 有哪些规范 10 条
1 数据的安全保障:url链接一般都采用https协议进行传输
-https是:http+ssl 安全的超文本传输协议
2 接口特征表现:在API地址中带接口标识,咱们一般放在地址栏中(放在域名中)
https://api.baidu.com
https://www.baidu.com/api

3 多版本共存:在url链接中带版本标识
-https://api.weibo.com/2/
-https://api.weibo.com/v2/
-https://api.weibo.com/?version=2
-https://api.weibo.com/v1/login --->需要的参数name和pwd
-https://api.weibo.com/v2/login --->需要的参数name和pwd和code

4 数据即是资源,均使用名词(可复数):前后端交互的数据我们称之为资源
-资源名都是名词,尽量避免使用动词
-https://127.0.0.1/api/v1/users
-https://127.0.0.1/api/v1/get_users # 不符合规范
5 资源操作由请求方式决定(method)
-获取资源用get
-新增资源用post
-修改资源使用put
-删除资源使用delete
https://api.baidu.com/books - get请求:获取所有书
https://api.baidu.com/books/1 - get请求:获取主键为1的书
https://api.baidu.com/books - post请求:新增一本书书
https://api.baidu.com/books/1 - put请求:整体修改主键为1的书
https://api.baidu.com/books/1 - patch请求:局部修改主键为1的书
https://api.baidu.com/books/1 -delete请求:删除主键为1的书

6 url中带搜索或过滤条件
https://api.example.com/v1/zoos?name=猴子 get请求

7 响应状态码:响应中带状态码
-http响应状态码:1xx,2xx,3xx,4xx,5xx
-自己的状态码(用的多): 100成功,看公司自己
错误代码 错误信息 详细描述
10001 System error 系统错误
10002 Service unavailable 服务暂停
10003 Remote service error 远程服务错误
10004 IP limit IP限制不能请求该资源
10005 Permission denied, need a high level appkey 该资源需要appkey拥有授权

8 返回中带错误信息
{code:100,msg:成功}
"Message": "send success",

9 返回结果,符合以下规范
GET /collection:返回资源对象的列表(数组) [{name:xx,age:19},{name:xx,age:19},{}]
GET /collection/resource:返回单个资源对象 {name:xx,age:19}
POST /collection:返回新生成的资源对象 {name:yy,age:19}
PUT /collection/resource:返回完整的资源对象 {name:xx,age:20}
PATCH /collection/resource:返回完整的资源对象 {name:xx,age:20}
DELETE /collection/resource:返回一个空文档
10 返回数据中带url链接
"url": "http://blog.sina.com.cn/zaku",
```

# 2 序列化和反序列化

json pickle 序列化和反序列化

# 序列化: 把我们能识别的数据结构(python的字典,列表,对象)---》转换成其他语言(程序)能识别的数据结构
-python的字典,列表,对象-----》json格式字符串(可以是别的格式)
-前后端交互,目前通常使用 json格式字符串交互
-前后端分离模式中:主要指的是
-前端发送请求获取数据---》后端去数据库查询---》QuerySet对象---》转成json格式字符串---》返回给前端这个过程,称之为序列化


# 反序列化:把其他程序(语言)给我们的数据---》转换成我们能识别的数据结构
-前端给我们json格式数据 ---》转换成 字典,列表,对象
-前端给 name=lqz&age=19 格式数据 ---》转换成 字典,列表,对象
-前后端分离模式中:主要指的是
-前端携带json格式数据到后端----》后端拿到json格式数据---》把数据转成对象保存到数据库这个过程,咱们称之为反序列化

Django REST framework安装和快速使用

有个Book单表----》对这个表进行增删查改---》原生django实现
-1 增加一条记录
-2 删除一条记录
-3 查询所有数据
-4 查询一条数据
-5 修改一条数据

使用原生django实现5个接口

**模型类**

```python
class Book(models.Model):
    name = models.CharField(max_length=32)
    price = models.IntegerField()
```

**路由**

```python
path('books/', views.BookView.as_view()),
path('books/<int:pk>', views.BookDetailView.as_view()),
```

**视图类**

```python
from django.views import View
from .models import Book
from django.http import JsonResponse
import json


class BookView(View):
    def get(self, request):
        # 获取所有图书
        book_list = Book.objects.all()

        # Object of type QuerySet is not JSON serializable  Queryset对象不允许用json序列化
        # json能序列化什么数据类型?
        '''
         +---------------+-------------------+
        | JSON          | Python            |
        +===============+===================+
        | object        | dict              |
        +---------------+-------------------+
        | array         | list              |
        +---------------+-------------------+
        | string        | str               |
        +---------------+-------------------+
        | number (int)  | int               |
        +---------------+-------------------+
        | number (real) | float             |
        +---------------+-------------------+
        | true          | True              |
        +---------------+-------------------+
        | false         | False             |
        +---------------+-------------------+
        | null          | None              |
        +---------------+-------------------+
        '''
        # 把qs [对象1,对象2]  对象转成  [{},{}]
        l = []
        for book in book_list:
            l.append({'name': book.name, 'price': book.price})
        return JsonResponse({'code': 100, 'msg': '查询成功', 'results': l})

    def post(self, request):
        # 前端编码格式:urlencoded,json(规定)
        data = json.loads(request.body)  # 反序列化   # request.body bytes格式,json格式的 不是字符串
        # 在 Book表中插入一条记录
        book = Book.objects.create(**data)
        return JsonResponse({'code': 100, 'msg': '新增成功', 'results': {'name': book.name, 'price': book.price}})


修改一条  查询一条   删除一条 路由跟上面不一样,单独再写在一个视图类中

class BookDetailView(View):
    def get(self, request, pk):
        pass

    def delete(self, request, pk):
        pass

    def put(self, request, pk):
        pass
```

使用drf实现5个接口

**路由**

```python
from rest_framework.routers import SimpleRouter
router = SimpleRouter()
router.register('books', views.BookView, 'books')
urlpatterns = [
]
urlpatterns += router.urls
```



**视图类**

```python
from .models import Book
from .serializer import BookSerializer
from rest_framework.viewsets import ModelViewSet
class BookView(ModelViewSet):
    queryset = Book.objects.all()
    serializer_class = BookSerializer
```



**序列化类**

```python
from rest_framework import serializers
from .models import Book
class BookSerializer(serializers.ModelSerializer):
    class Meta:
        model = Book
        fields = '__all__'
```

 

json可以序列化和反序列化的类型

 

回顾cbv执行流程

#1 请求来了---》执行 ---》views.BookView.as_view()(request)--->执行View类中as_view类方法中得 闭包函数 view
@classonlymethod
def as_view(cls, **initkwargs):
     def view(request, *args, **kwargs):
        self = cls(**initkwargs) # BookView类实例化得到对象
        self.dispatch(request, *args, **kwargs) # BookView类的dispatch
        
# 2 BookView类的dispatch没有---》View的dispatch
    # 根据请求方式,通过反射去视图类中【BookView】反射出跟请求方式同名的方法,执行
    def dispatch(self, request, *args, **kwargs):
        if request.method.lower() in self.http_method_names:
            handler = getattr(self, request.method.lower(), self.http_method_not_allowed)
        else:
            handler = self.http_method_not_allowed
        return handler(request, *args, **kwargs)
    
    
    
# 3 以什么请求方式访问---》就会执行视图类中 跟请求方式同名的方法
    比如:http://127.0.0.1:8000/books/  get请求
    执行BookView类中get方法

APIView执行流程源码分析(了解)

使用drf写符合restful规范的接口---》都继承 APIView

# 小案例:继承 APIView 写5个接口
### 注意:
1 / 严格
2 删除了id为1的记录---》判断查询结果有没有,再序列化




### #### 继承APIView+Response和django原生View区别到底在哪?####
-记住(drf是个app):要在app中 注册app,rest_framework,注册后
-在浏览器中访问:drf好看的样子(必须要注册)
-在postman中访问:纯json

 

源码分析

path('books/', views.BookView.as_view()),
# 1 请求来了---》会执行views.BookView.as_view()(request) ---》找as_view---》BookView找不到---》APIView中找---》as_view--->就干了一个事--》去除了csrf认证
    @classmethod
    def as_view(cls, **initkwargs):
        view = super().as_view(**initkwargs) # 调用父类---》django原生View的as_view
        view=csrf_exempt(view) 
        # 等同于
        '''
        @csrf_exempt
        def view:
            pass
        '''
    
        return view             # 当前请求,去除掉了csrf认证
    
    
# 2 views.BookView.as_view()(request) 本质是执行  csrf_exempt(view)(request)
    -执行View的 中as_view内的view函数--》去除了csrf认证
# 3 本质在执行:self.dispatch(request, *args, **kwargs)
    BookView的dispatch---》BookView没有---》APIView找---》找到了
    def dispatch(self, request, *args, **kwargs):
        # 包装新的request
        request = self.initialize_request(request, *args, **kwargs)
        try:
            # 执行三大认证
            self.initial(request, *args, **kwargs)
            # 执行跟请求方式同名的视图类中得方法
            if request.method.lower() in self.http_method_names:
                handler = getattr(self, request.method.lower(),
                                  self.http_method_not_allowed)
            else:
                handler = self.http_method_not_allowed
            response = handler(request, *args, **kwargs)
            
            
        except Exception as exc:
            # 处理了全局异常
            response = self.handle_exception(exc)
        self.response = self.finalize_response(request, response, *args, **kwargs)
        return self.response
    
    
    
    
# 总结:
    1 APIView执行流程---》去除csrf--》执行了APIView的dispatch
    2 执行的as_view是APIView的as_view
    3 执行的dispatch也是APIView的dispatch
    

 

局部去除csrf认证

from django.views.decorators.csrf import csrf_exempt
@csrf_exempt  #本质 index= csrf_exempt(index)
def index(request):
    return render(request,'index.html')

  

总结

1 继承APIView后,所有视图类,都没有csrf认证了,我们也不需要注释全局中间件了
1 csrf_exempt(view) ---》
2 装饰器

补充前端

# 混合项目,基于别人的写
-copy 别的html页面,加模板语法
# 老一些的
jq,bootstrap3:后台管理:hplus4.1-master.zip
layui:类似于bootstrap 官网http://layui.apixx.net/
基于layui的后台管理:X-admin-master.zip

# 新一些的
-bootstrap5和jq写的 bootstrap-admin-V2.0.1.zip
-http://lyear.itshubao.com/lyear_ui_buttons.html

 

分生题目

# 1 基于django原生,编写5个接口
-1 增加一条记录
-2 删除一条记录
-3 查询所有数据
-4 查询一条数据
-5 修改一条数据

   2 基于drf,编写5个接口


# 3 继承APIView+Response写5个接口

# 4 读:APIView的dispatch源码,分析出
-1 包装了新的request对象
-2 执行了三大认证
-3 执行了跟请求方式同名的视图类中得方法
-4 处理了全局异常