全局Response对象和全局异常捕获和日志

全局Response对象和全局异常捕获和日志

1. 全局Response对象

from rest_framework.response import Response


class APIResponse(Response):
    def __init__(self, code=100, msg='成功', result=None, error=None, status=None, headers=None, content_type=None,
                 **kwargs):
        data = {
            'code': code,
            'msg': msg,
        }
        if result:
            data['result'] = result
        if error:
            data['error'] = error
        data.update(kwargs)

        # 对象来调用对象的绑定方法，会自动传值
        super(APIResponse, self).__init__(data=data, status=status, headers=headers, content_type=content_type)

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

2. 全局异常捕获

# 方法,加日志

from rest_framework.views import exception_handler
# from luffyapi.utils import response
from .apiresponse import APIResponse
from .logger import log


def common_exception_handler(exc, context):
    log.error('view是：%s ，错误是%s' % (context['view'].__class__.__name__, str(exc)))
    # context['view']  是TextView的对象，想拿出这个对象对应的类名
    ret = exception_handler(exc, context)  # 是Response对象，它内部有个data

    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:
        return APIResponse(code=0, msg='error', result=ret.data)

3.日志

from logging import getLogger
from logging import config
from luffyapi.settings import dev

config.dictConfig(dev.LOGGING)
log = getLogger("django")
# 配置文件dev.py
#日志字典的配置
standard_format = '%(levelname)s [%(asctime)s][%(threadName)s:%(thread)d][日志名:%(name)s][%(filename)s:%(lineno)d]' 
                  '[%(message)s]'

simple_format = '[%(levelname)s][%(asctime)s][%(filename)s:%(lineno)d]%(message)s'

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,
            # 日志文件的数量,设置最大日志数量为10
            'backupCount': 100,
            # 日志格式:详细格式
            'formatter': 'verbose',
            # 文件内容编码
            'encoding': 'utf-8'
        },
    },
    # 日志对象
    'loggers': {
        'django': {
            'handlers': ['console', 'file'],
            'propagate': True, # 是否让日志信息继续冒泡给其他的日志处理系统
        },
    }
}

# 配置全局异常捕获
REST_FRAMEWORK = {
    'EXCEPTION_HANDLER': 'luffyapi.utils.exceptions.common_exception_handler',
}

拓展

# 可以在pycharm里面安装ideolog插件
需要注意以下两点：
1、 写入文件的日志格式format必须以levelname开头且不能有其他符号
2、 日志文件名称必须以.log结尾

效果图