Django日志集成 & MySQL/Redis 异常捕获

“ 一位合格的开发难道会在日常开发中使用print作为主要的输出debug工具？python的web开发框架Django的异常能捕获MySQL和Redis的全部异常吗？”

​

本文针对的是Django开发框架，其他开发框架参考思想即可。

 Django日志集成

        首先 print 那是在 Pycharm 等 IDE 的控制台里看到的，同时 print 也挺消耗性能，正常运行项目都会放在服务器上，一是服务器有控制台吗？二是那么多的 print 经得其性能消耗吗？运行得卡吞吞的不是我们想要的吧。

        所以 日志 的必要性就来了（一般会把日志输出到某个或某些文件下，运维人员会需要这类文件），对项目的整体运行的把控就必要地需要日志，此外，此外 DeBug 等环境下，可以把日志输出到控制台。同时日志能提供更好、更全面、更结构化的信息。

    

Python的日志由四个部分组成：

    ① loggers  类似于定义日志器（代码会用到它的命名）

    ② handlers   日志处理方法

    ③ filters  日志过滤处理

    ④ formatters  日志信息显示的格式

注意在Django的官网中把日志级别分为五个级别：

    DEBUG/INFO/WARNING/ERROR/CRITICAL

    （其中INFO为最低级别）

在Django项目中会在settings.py文件中配置日志集成器，或者在（预）开发环境中的dev.py文件配置。

类似如下配置↓

#日志
LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,  # 是否禁用已经存在的日志器
    'formatters': {  # 日志信息显示的格式
        'verbose': {
 # %s为字符串 %d为整数，levelname代表级别，asctime为时间，module打印模块名称，lineno打印日志级别的数值，message为信息
          'format': '%(levelname)s %(asctime)s %(module)s %(lineno)d %(message)s'   
        },
    },
    'filters': {  # 对日志进行过滤
        'require_debug_true': {  # django在debug模式下才输出日志
          '()': 'django.utils.log.RequireDebugTrue',  # Debug为True
        },
    },
    'handlers': {  # 日志处理方法
        'console': {  # 向终端中输出日志
            'level': 'INFO',   # 输出级别
             # 指定上面写的过滤器（过滤添加为Debug为true才能向控制台输出） 
            'filters': ['require_debug_true'], 
            'class': 'logging.StreamHandler',
            'formatter': 'verbose'  # 输出格式，也是上面写的格式verbose
        },
        'file': {  # 向文件中输出日志
            'level': 'INFO',
            'class': 'logging.handlers.RotatingFileHandler',
            # 日志文件的位置（需要创建目录logs），那么就需要BASE_DIR的dirname即上一级目录
            'filename': os.path.join(os.path.dirname(BASE_DIR), "logs/xxx.log"),  
            'maxBytes': 100 * 1024 * 1024,  # 100兆，若超过，则再创建一个，在文件名后加1 2...
            'backupCount': 5,               # 若文件超过五个，将会删除
            'formatter': 'verbose',         # 输出格式，也是上面写的格式verbose
        },
    },
    'loggers': {  # 日志器
        'xxx': {  # 定义了一个名为xxx的日志器（后续获取logger对象的时候会使用到）
            'handlers': ['console', 'file'],  # 可以同时向终端与文件中输出日志
            'propagate': True,  # 是否继续传递日志信息
            'level': 'INFO',  # 日志器接收的最低日志级别
        },
    },
}

Django官网中有log details(levelname/model/...)

Django documentation | Django documentation | Django

【注意：日志文件是不需要上传到代码仓库的，而且在团队开发中，直接就产生互相覆盖的矛盾】

        比如创建的日志文件夹名称为logs，.gitignore会把logs和logs下log文件全部忽略，如果想上传空的logs，那么只需要在logs文件夹下创建文件.gitkeep。

# 日志文件logs/*.log

Django对MySQL和Redis的异常捕获

        其实Django对MySQL和Redis特殊异常是不敏感的，相当于未做任何日志处理，显然这很重要。

        可能你启动了一个在没缓存起Redis时（项目有使用到），Redis并未开启，但Django仍然能不报错正常运行，我们接下来做的事情就是得避免它们的发生。

    在实际开发中，一般会创建一个utils包，在里面创建一个exceptions包来放这个py处理文件。（本文使用的是目前主流的DRF框架）

    思想就是：相当于在原有的DRF异常捕获机制下，捕获没有捕获到的MySQL和Redis异常。（相当于给DRF的异常处理函数多套一层外套，把drf_exception_handler覆盖成我们的exception_xxx）[xxx可以自命名]

logger = logging.getLogger('xxx')   # 获取我们前面定义的日志器
​
​
# exc: 异常实例对象  context: 抛出异常的上下文
def exception_xxx(exc, context):
    # 调用drf框架原生的异常处理方法（相当于给DRF异常处理函数套一层）
    response = drf_exception_handler(exc, context)    
    # 没有得到响应
    if response is None:
        # 判断是否是MySQL数据库错误或Redis缓存错误
        if isinstance(exc, DatabaseError) or isinstance(exc, RedisError):
            # 数据库异常
            logger.error('[%s] %s' % (context['view'], exc))
            # HTTP507状态码代表的意思是服务器无法存储请求
            response = Response({'message': '服务器内部错误'}, status=status.HTTP_507_INSUFFICIENT_STORAGE)
    return response

    在配置文件中加上REST_FRAMEWORK即可：

# DRF配置项REST_FRAMEWORK = {    ...    # 异常处理    'EXCEPTION_HANDLER': 'xxx.utils.exceptions.exception_xxx',}

【还有更多开发小技巧，欢迎关注公众号：一路向东】