引言

在应用程序中记录日志是一种重要的实践，可以帮助我们跟踪应用程序的运行状态、调试问题以及进行故障排查。然而，有时我们可能需要记录敏感信息，如明文密码，但明文密码的直接记录可能存在潜在的安全风险。为了保护这些敏感信息，我们可以使用logging模块提供的自定义filter和自定义formatter来隐藏明文密码。

logging模块简介

logging是Python的一个内置模块，提供了强大而灵活的日志记录系统。它定义了一些函数和类，用于在上层应用程序或库中实现日志记录功能。

logging模块将日志处理分为四个层次：

• Logger（记录器）：Logger向上层应用程序提供接口，通过调用Logger的方法（例如logger.info，logger.error）打印日志。
• Handler（处理器）：Handler负责将Logger创建的日志记录输出到适当的目的地，例如标准输出、错误、文件等。
• Filter（过滤器）：Filter提供了对日志记录输出进行更细粒度控制的机制。
• Formatter（格式化器）：Formatter指定了最终日志记录输出的格式。

Filter和Formatter层次提供了扩展日志行为的方式。对于明文密码打印问题，我们可以通过自定义Filter或Formatter，在日志记录中使用特定规则过滤明文密码字段。

自定义filter实现方案

自定义filter是一种过滤器，可以根据特定规则过滤日志消息。我们可以创建一个自定义的Filter类，并重写其filter方法来实现密码过滤逻辑。下面是一个示例代码：

import logging

class PasswordFilter(logging.Filter):
    def filter(self, record):
        # 检查日志消息中是否包含明文密码
        if 'password' in record.msg:
            # 将明文密码替换为占位符
            record.msg = record.msg.replace('password', '********')
        return True

# 创建日志记录器
logger = logging.getLogger('my_logger')
logger.setLevel(logging.INFO)

# 创建自定义filter并添加到日志记录器
password_filter = PasswordFilter()
logger.addFilter(password_filter)

# 记录包含明文密码的日志消息
logger.info('Login attempt with password: my_password')

在上面的示例中，我们创建了一个名为PasswordFilter的自定义filter类，并重写了其filter方法。在filter方法中，我们检查日志消息中是否包含明文密码，并将明文密码替换为占位符。然后，我们将自定义filter添加到日志记录器中。当我们使用logger.info记录包含明文密码的日志消息时，该消息将通过自定义filter进行过滤并进行相应的处理。

自定义formatter实现方案

自定义formatter用于格式化日志消息，我们可以在其中实现密码隐藏的逻辑。下面是一个示例代码：

import logging

class PasswordFormatter(logging.Formatter):
    def format(self, record):
        # 检查日志消息中是否包含明文密码
        if 'password' in record.msg:
            # 将明文密码替换为占位符
            record.msg = record.msg.replace('password', '********')
        return super().format(record)

# 创建日志记录器
logger = logging.getLogger('my_logger')
logger.setLevel(logging.INFO)

# 创建自定义formatter并添加到日志记录器
password_formatter = PasswordFormatter('%(asctime)s - %(levelname)s - %(message)s')
handler = logging.StreamHandler()
handler.setFormatter(password_formatter)
logger.addHandler(handler)

# 记录包含明文密码的日志消息
logger.info('Login attempt with password: my_password')

在上面的示例中，我们创建了一个名为PasswordFormatter的自定义formatter类，并重写了其format方法。在format方法中，我们检查日志消息中是否包含明文密码，并将明文密码替换为占位符。然后，我们将自定义formatter应用于日志记录器的处理程序中。当我们使用logger.info记录包含明文密码的日志消息时，该消息将通过自定义formatter进行格式化，并进行相应的处理。

结论

保护明文密码等敏感信息的安全非常重要，特别是在日志记录中。在本文中，我们介绍了基于Python的logging模块的两种实现方案：自定义filter和自定义formatter，用于隐藏明文密码。通过自定义filter，我们可以根据特定规则过滤日志消息并替换明文密码为占位符。而通过自定义formatter，我们可以在格式化日志消息时隐藏明文密码。

使用自定义filter时，我们创建了一个继承自logging.Filter的自定义类，并重写了其中的filter方法。在filter方法中，我们检查日志消息中是否包含明文密码，并将其替换为占位符。然后，我们将自定义filter添加到日志记录器中，以便它在日志消息通过时进行过滤操作。

使用自定义formatter时，我们创建了一个继承自logging.Formatter的自定义类，并重写了其中的format方法。在format方法中，我们检查日志消息中是否包含明文密码，并将其替换为占位符。然后，我们将自定义formatter应用于日志记录器的处理程序中，以便在格式化日志消息时进行处理。

通过这两种实现方案，我们可以有效地隐藏明文密码，提高日志记录的安全性。然而，需要注意的是，这只是一种基本的保护措施，并不能完全消除所有的安全风险。在实际应用中，还应采取其他安全措施，如加密敏感信息、限制访问权限等，以确保密码和其他敏感信息的安全性。

保护敏感信息对于应用程序的安全至关重要，开发人员应该时刻关注并采取适当的措施来保护这些信息。通过使用基于logging模块的自定义filter和自定义formatter，我们可以有效地隐藏明文密码，提高应用程序的安全性。

跟一线大厂架构师学python

《改善python代码质量的使用技巧》专栏是我最近在写的一本针对Python开发人员的实用编程指南，涵盖了Python中最强大和有用的特性和技巧。从基础知识入手，深入介绍函数式编程、面向对象编程、并发编程、网络编程、Web开发、数据处理和机器学习等内容。透彻解析Python语言特性，提供实践案例和示例代码，帮助您优雅解决各种问题。

如果您对python asyncio异步编程模型感兴趣，可以关注我的《python asyncio从入门到精通》专栏。