Django-封装全局response、exception和日志

全局response

封装

# 封装全局的Response
from rest_framework.response import Response


class APIResponse(Response):
    def __init__(self, code=1, msg='ok', result=None, status=None, headers=None, content_type=None, **kwargs):
        dic = {
            'code': code,
            'msg': msg
        }
        if result:  # 如果给result传值
            dic['result'] = result

        dic.update(kwargs)

        # 对象来调用对象的绑定方法，会自动将对象传进去
        super().__init__(data=dic, status=status, headers=headers, content_type=content_type)

        # 类来调用对象的绑定方法，这个方法就是一个普通的函数，有几个参数就要传几个参数，所以也需要传一个对象进去
        # Response(data=data,status=status,headers=headers,content_type=content_type)

使用

from rest_framework.views import APIView
from responses import APIResponse

class TestView(APIView):
    def get(self,request,*args,**kwargs):
        return APIResponse(code=1，msg='成功') # 根据实际情况，返回数据

 全局异常exception

from rest_framework.views import exception_handler
from .logger import log
from .response import APIResponse # 这里使用了全局response，统一响应


def common_exception_handler(exc, context):

　　　 # 记录日志，一旦这里执行了，就代表，项目肯定哪里出错了，所以在这里记录即可
　　　 log.error('view是: %s, 报错信息: %s' % (context['view'].__class__.__name__, str(exc)))

# 重写这个函数，定义一个自己的全局异常
    ret = exception_handler(exc, context)  # 先执行一遍drf自带的异常，处理drf可以处理的异常
    if not ret:  # 如果没值，代表drf处理不了这种异常，就会抛出给django去处理，在这里，我们自己去处理
        if isinstance(exc, KeyError):  # 处理了更精细一点，可以在这里加
            return APIResponse(code=0, msg='key error')

        # 上面加的自己的逻辑如果都不匹配，那就返回一个统一的
        return APIResponse(code=0, msg='error', result=str(exc))  # 直接把异常返回即可
    else:  # 如果drf可以处理，那就把处理的结果返回即可
        return APIResponse(code=0, msg='error', result=ret.data)  # 源码中返回的有data属性


# dev.py 中配置
REST_FRAMEWORK = {
    # 全局异常处理
    'EXCEPTION_HANDLER': 'luffyapi.utils.exceptions.common_exception_handler',
}

日志

封装日志

这一步在drf项目中的settings.py配置即可

# 日志配置
LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': {
        'verbose': {
            'format': '%(levelname)s %(asctime)s %(module)s %(lineno)d %(message)s'
        },
        'simple': {
            'format': '%(levelname)s %(module)s %(lineno)d %(message)s'
        },
    },
    'filters': {
        'require_debug_true': {
            '()': 'django.utils.log.RequireDebugTrue',
        },
    },
    'handlers': {
        'console': {
            # 实际开发建议使用WARNING
            'level': 'DEBUG',
            'filters': ['require_debug_true'],
            'class': 'logging.StreamHandler',
            'formatter': 'simple'
        },
        'file': {
            # 实际开发建议使用ERROR
            'level': 'INFO',
            'class': 'logging.handlers.RotatingFileHandler',
            # 日志位置,日志文件名,日志保存目录必须手动创建，注：这里的文件路径要注意BASE_DIR代表的是小luffyapi
            'filename': os.path.join(os.path.dirname(BASE_DIR), "logs", "luffy.log"),
            # 日志文件的最大值,这里我们设置300M
            'maxBytes': 300 * 1024 * 1024,
            # 日志文件的数量,设置最大日志数量为100，最多几多100个300M的日志文件
            'backupCount': 100,
            # 日志格式:详细格式
            'formatter': 'verbose',
            # 文件内容编码
            'encoding': 'utf-8'
        },
    },
    # 日志对象
    'loggers': {
        'django': {
            'handlers': ['console', 'file'],
            'propagate': True,  # 是否让日志信息继续冒泡给其他的日志处理系统
        },
    }
}

封装logging对象

在配置文件中配置完日志后，单独写一个文件，实例化对象，使用的时候直接调用

import logging

# log=logging.getLogger('名字') # 跟配置文件中loggers日志对象下的名字对应
log = logging.getLogger('django')

标签：exception,code,APIResponse,Django,result,msg,import,日志,response
来源： https://www.cnblogs.com/hushow/p/15787016.html