Loguru项目中自定义日志处理器获取原始消息的解决方案

问题背景

在使用Python的Loguru日志库时，开发者可能会遇到一个常见问题：当实现自定义的日志处理器(Handler)时，通过Record.msg属性获取到的并不是原始的日志消息，而是已经经过格式化的完整日志内容。这与Python标准库logging模块的行为有所不同，可能导致一些预期外的结果。

问题现象

假设我们有以下日志记录代码：

logger.debug("That's it, beautiful and simple logging!")

在自定义处理器中，开发者期望通过record.message或record["message"]获取到原始消息：

"That's it, beautiful and simple logging!"

但实际上获取到的却是经过完整格式化的日志内容：

"2024-02-13 13:30:54.357 | DEBUG    | __main__:run_it:31 - That's it, beautiful and simple logging!"

问题原因

Loguru的设计理念与标准库logging有所不同。在Loguru中，默认情况下会对日志记录进行统一的格式化处理，然后再传递给各个处理器。这意味着所有处理器接收到的都是已经格式化后的消息，而不是原始消息。

解决方案

要解决这个问题，可以在添加处理器时显式指定只输出原始消息的格式。具体方法是在add()方法中设置format="{message}"参数：

logger.add(custom_handler, format="{message}")

这样配置后，自定义处理器将接收到未经格式化的原始消息内容。

深入理解

Loguru的这种设计实际上提供了更大的灵活性。通过为不同的处理器指定不同的格式，开发者可以实现：

1. 控制台输出使用一种格式（包含时间、级别等信息）
2. 文件日志使用另一种格式（可能更简洁或更详细）
3. 网络传输使用原始消息（不包含任何额外信息）

这种设计模式符合"单一职责原则"，每个处理器只关心自己需要处理的内容格式。

最佳实践

在实际项目中，建议：

1. 明确每个处理器的用途和需要的日志格式
2. 对于需要原始消息的处理器（如发送到消息队列或第三方服务），使用format="{message}"
3. 对于本地存储或显示的处理器，可以使用更丰富的格式
4. 在文档中明确记录每个处理器的预期输入格式

总结

Loguru通过灵活的格式配置，为开发者提供了强大的日志处理能力。理解并正确使用format参数，可以解决自定义处理器获取原始消息的问题，同时也能实现更复杂的日志处理场景。这种设计虽然与标准库logging有所不同，但一旦掌握，将大大提升日志处理的效率和灵活性。