drf——全局处理异常、接口文档、jwt介绍、based64编码与解码

全局异常处理原理

# 对于前端来讲，后端即便报错，也要返回统一的格式，前端便于处理
{code:999,msg:'系统异常，请联系系统管理员'}

# 只要三大认证，视图类的方法出了异常，都会执行一个函数：
    rest_framework.views import exception_handler

# drf只要出了异常就会执行 这是drf的配置文件中的
    'EXCEPTION_HANDLER': 'rest_framework.views.exception_handler'
	
"""
dispatch中处理全局异常先走response = self.handle_exception(exc)
进到handle_exception
exception_handler = self.get_exception_handler()
会去执行配置文件配置的exception_handler这个函数
"""

# 但是源码是不能改的 我们可以自定义一个函数 配置一下 以后出了异常 执行我们自己的函数
"""
需要在项目的配置文件中配置上自己写的这个函数 字典的v是函数的路径
REST_FRAMEWORK = {
    'EXCEPTION_HANDLER': 'app01.excepitons.common_exception_handler',
}
"""
# 注意：exception_handler
"""
如果异常对象是drf的APIException的对象，就会返回Response
exception_handler只处理了drf的异常，其他的异常需要我们自己处理
如果异常对象不是drf的APIException对象，就会返回None
"""
# exception_handler源码：
	def exception_handler(exc, context):  # 如果有异常会走这
        if isinstance(exc, exceptions.APIException):  # 判断是否是APIException的对象 是就返回Response 不是返回None
            if isinstance(exc.detail, (list, dict)):
                data = exc.detail
            else:
                data = {'detail': exc.detail}
            return Response(data, status=exc.status_code, headers=headers)
    	return None
    
# 补充 内置方法
isinstance()  判断一个对象是不是某个类的对象 isinstance(对象,类)
issubclass()  判断一个类,是不是另一个类的子类

全局异常处理代码

# 我们自己自定义的函数

def common_exception_handler(exc,context):
    # 只要走到这里，一定出异常了，我们正常的项目要记录日志
    res = exception_handler(exc,context)
    # 两种可能：应该是Response对象，一个是None
    if res:
        if isinstance(res.data,dict)
        # 如果res有值 说明是drf的异常，它处理了
        	detail = res.data.get('detail')
        else:
            detail = res.data
        return Response({'code':999,'msg':detail})
    else:
        # 如果res没有值返回的是None 则说明是其他异常，它没有处理
        # return Response({'code': 999, 'msg': '系统异常，请联系系统管理员'})
        return Response({'code':100,'msg':str(exc)})
    
# 项目的配置文件
REST_FRAMEWORK = {
    'EXCEPTION_HANDLER': 'app01.excepitons.common_exception_handler',
}

接口文档

# 后端把接口写好后
	登录接口
    注册接口
    查询所有图书带过滤接口
# 前端人员需要根据接口文档，进行前端开发

# 前后端需要做对接----》对接第一个东西就是这个接口文档---》前端照着接口文档开发
# 公司3个人，每个人开发了10个接口，3个人都要同时写接口文档

# 接口文档的编写形式
	1.word,md编写，大家都可以操作，写完放在git上或者是公司的文档管理平台上
    2.第三方的接口文档平台(收费)
    	https://www.showdoc.com.cn/
    3.公司自己开发接口文档平台
    4.公司使用开源的接口文档平台，搭建
    	-YAPI：百度开源的
        -https://zhuanlan.zhihu.com/p/366025001 # 如何搭建
    5.项目自动生成接口文档
    	5.1 coreapi
        5.2 swagger
        
# 使用coreapi自动生成接口文档
	使用步骤：
    	1. 安装：pip38 install coreapi
        2.加一个路由
        	from rest_framework.documentation import include_docs_urls
            urlpatterns = [
                path('docs/',include_docs_urls(title='站点页面标题'))
            ]
        3.在视图类上加注释
       	4.配置文件中配置
        'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema'
        5.表模型或序列化类的字段上写 help_text--->会显示在接口文档的字段介绍上
        6.访问地址：
        	http://127.0.0.1:8000/docs/

jwt介绍和原理

# https://www.cnblogs.com/liuqingzheng/p/16154439.html

# cookie,session,token发展历史
	会话管理
    cookie：客户端浏览器的键值对
    session：服务端的键值对(djangosession表,内存中,文件,缓存数据库)
    token：服务端生成的加密字符串，如果存在客户端浏览器上，就叫cookie
    	三部分：头，荷载，签名
        签发：登录成功，签发
        认证：认证类中认证
        
# jwt：Json web token (JWT),web方向的token认证
	长得样子：   eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ

base64编码和解码

# base64并不是一种加密反射，只是编码解码方式
# 字符串，可以转成base64编码格式：eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9
# eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9 解码成base64

import json
import base64

d = {'user_id':1,'username':'lqz'}
d_str = json.dumps(d)
# print(d_str)
# 对字符串进行base64 编码
res = base64.b64encode(bytes(d_str,encoding='utf-8'))
print(res)  # b'eyJ1c2VyX2lkIjogMSwgInVzZXJuYW1lIjogImxxeiJ9'
# 解码
res = base64.b64decode(res)
print(res)
# 括号内也可以直接放一串字符串 长度必须是4的倍数 长度不够时用=补齐
res = base64.b64decode('TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ=')
print(res)

# base64的用途
"""
1.在互联网中 前后端数据交互使用base64编码
2.jwt 字符串使用base64编码
3.互联网中一些图片 使用base64编码
"""