Django 中如何优雅的记录日志(2)，吊打面试官系列

Filter 还被用来在日志输出之前对日志记录做修改。例如，当满足一定条件时，把日志级别从 ERROR 降到 WARNING 。

Filter 在 Logger 和 Handler 中都可以添加，多个 Filter 可以链接起来使用，来做多重过滤操作。

Formaters

Formatter 即格式化器，主要功能是确定最终输出的形式和内容。

实现方式

---

说了这么多理论，是时候来看看具体怎么实现了。

其实最简单的方式就是直接在文件开头 import，然后程序中调用，像下面这样：

import the logging library

import logging

Get an instance of a logger

logging.basicConfig(

format=‘%(asctime)s - %(pathname)s[%(lineno)d] - %(levelname)s: %(message)s’,

level=logging.INFO)

logger = logging.getLogger(name)

def my_view(request, arg1, arg):

…

if bad_mojo:

Log an error message

logger.error(‘Something went wrong!’)

但这种方式并不好，如果在每个文件开头都这样写一遍，第一是麻烦，第二是如果哪天要改变输出日志格式，那每个文件都要改一遍，还不累死。

很显然，如果能封装成一个类，用的时候调用这个类，修改的时候也只需要修改这一个地方，是不是就解决这个问题了呢？

自定义类

下面来看看具体这个类怎么封装：

class CommonLog(object):

“”"

日志记录

“”"

def init(self, logger, logname=‘web-log’):

self.logname = os.path.join(settings.LOGS_DIR, ‘%s’ % logname)

self.logger = logger

self.logger.setLevel(logging.DEBUG)

self.logger.propagate = False

self.formatter = logging.Formatter(‘%(asctime)s - %(name)s - %(levelname)s: %(message)s’, ‘%Y-%m-%d %H:%M:%S’)

def __console(self, level, message):

创建一个FileHandler，用于写到本地

fh = logging.handlers.TimedRotatingFileHandler(self.logname, when=‘MIDNIGHT’, interval=1, encoding=‘utf-8’)

fh = logging.FileHandler(self.logname, ‘a’, encoding=‘utf-8’)

fh.suffix = ‘%Y-%m-%d.log’

fh.setLevel(logging.DEBUG)

fh.setFormatter(self.formatter)

self.logger.addHandler(fh)

创建一个StreamHandler,用于输出到控制台

ch = logging.StreamHandler()

ch.setLevel(logging.DEBUG)

ch.setFormatter(self.formatter)

self.logger.addHandler(ch)

if level == ‘info’:

self.logger.info(message)

elif level == ‘debug’:

self.logger.debug(message)

elif level == ‘warning’:

self.logger.warning(message)

elif level == ‘error’:

self.logger.error(message)

这两行代码是为了避免日志输出重复问题

self.logger.removeHandler(ch)

self.logger.removeHandler(fh)

关闭打开的文件

fh.close()

def debug(self, message):

self.__console(‘debug’, message)

def info(self, message):

self.__console(‘info’, message)

def warning(self, message):

self.__console(‘warning’, message)

def error(self, message):

self.__console(‘error’, message)

这是我在项目中还在用的一段代码，生成的文件按天进行切分。

当时写这段代码，有个问题折腾了我很久，就是显示代码报错行数的问题。当 formatter 配置 %(lineno)d 时，每次并不是显示实际的报错行，而是显示日志类中的代码行，但这样显示就失去意义了，所以也就没有配置，用了 %(name)s 来展示实际的调用文件。

其实，如果只是为了排错方便，记录一些日志，这个类基本可以满足要求。但如果要记录访问系统的所有请求日志，那就无能为力了，因为不可能手动在每个接口代码加日志，也没必要。

这个时候，很自然就能想到 Django 中间件了。

Django 中间件

中间件日志代码一共分三个部分，分别是：Filters 代码，middleware 代码，settings 配置，如下：

local = threading.local()

class RequestLogFilter(logging.Filter):

“”"

日志过滤器

“”"

def filter(self, record):

record.sip = getattr(local, ‘sip’, ‘none’)

record.dip = getattr(local, ‘dip’, ‘none’)

record.body = getattr(local, ‘body’, ‘none’)

record.path = getattr(local, ‘path’, ‘none’)

record.method = getattr(local, ‘method’, ‘none’)

record.username = getattr(local, ‘username’, ‘none’)

record.status_code = getattr(local, ‘status_code’, ‘none’)

record.reason_phrase = getattr(local, ‘reason_phrase’, ‘none’)

return True

class RequestLogMiddleware(MiddlewareMixin):

“”"

将request的信息记录在当前的请求线程上。

“”"

def init(self, get_response=None):

self.get_response = get_response

self.apiLogger = logging.getLogger(‘web.log’)

def call(self, request):

try:

body = json.loads(request.body)

except Exception:

body = dict()

if request.method == ‘GET’:

body.update(dict(request.GET))

else:

body.update(dict(request.POST))

local.body = body

local.path = request.path

local.method = request.method

local.username = request.user

local.sip = request.META.get(‘REMOTE_ADDR’, ‘’)

local.dip = socket.gethostbyname(socket.gethostname())

response = self.get_response(request)

local.status_code = response.status_code

local.reason_phrase = response.reason_phrase

self.apiLogger.info(‘system-auto’)

return response

settings.py 文件配置：

MIDDLEWARE = [

‘django.middleware.security.SecurityMiddleware’,

‘django.contrib.sessions.middleware.SessionMiddleware’,

‘django.middleware.common.CommonMiddleware’,

‘django.middleware.csrf.CsrfViewMiddleware’,

‘django.contrib.auth.middleware.AuthenticationMiddleware’,

‘django.contrib.messages.middleware.MessageMiddleware’,

‘django.middleware.clickjacking.XFrameOptionsMiddleware’,

自定义中间件添加在最后

‘lib.log_middleware.RequestLogMiddleware’

自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数Python工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则几千的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年Python开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Python开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录大纲截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且后续会持续更新

如果你觉得这些内容对你有帮助，可以添加V获取：vip1024c （备注Python）

一、Python所有方向的学习路线

Python所有方向的技术点做的整理，形成各个领域的知识点汇总，它的用处就在于，你可以按照下面的知识点去找对应的学习资源，保证自己学得较为全面。

二、Python必备开发工具

工具都帮大家整理好了，安装就可直接上手！

三、最新Python学习笔记

当我学到一定基础，有自己的理解能力的时候，会去阅读一些前辈整理的书籍或者手写的笔记资料，这些笔记详细记载了他们对一些技术点的理解，这些理解是比较独到，可以学到不一样的思路。

四、Python视频合集

观看全面零基础学习视频，看视频学习是最快捷也是最有效果的方式，跟着视频中老师的思路，从基础到深入，还是很容易入门的。

五、实战案例

纸上得来终觉浅，要学会跟着视频一起敲，要动手实操，才能将自己的所学运用到实际当中去，这时候可以搞点实战案例来学习。

六、面试宝典

简历模板

纸上得来终觉浅，要学会跟着视频一起敲，要动手实操，才能将自己的所学运用到实际当中去，这时候可以搞点实战案例来学习。

六、面试宝典

简历模板