如何用Python logging实现类似Log4J的预定义消息字典功能？

当然可以实现！Python的logging模块灵活性很强，完全能模拟Log4J这种基于消息模板/错误码的日志方式，下面给你具体的实现思路和代码示例：

核心思路是把预配置的消息模板单独存储，再通过自定义日志工具匹配错误码、格式化消息，最后交给logging模块输出。

1. 定义消息模板 #

先创建一个存放消息模板的文件，方便统一维护。比如用Python模块存储：

# message_templates.py
MESSAGE_TEMPLATES = {
    "ERROR-1234": "The entity : {0} doesn't exist",
    "ERROR-4321": "The client : {0} with the name {1} doesn't exist"
}

注意：Python字符串格式化默认从{0}开始索引，如果你习惯从{1}开始，可以改用关键字参数（比如{entity_id}），或者手动调整模板里的索引值。

如果想让非开发人员也能轻松修改模板，用JSON文件存储会更友好：

// message_templates.json
{
    "ERROR-1234": "The entity : {0} doesn't exist",
    "ERROR-4321": "The client : {0} with the name {1} doesn't exist"
}

加载JSON模板的代码：

import json

with open("message_templates.json", "r", encoding="utf-8") as f:
    MESSAGE_TEMPLATES = json.load(f)

2. 自定义日志工具 #

我们可以扩展logging.Logger类，添加专门的模板日志方法，让调用方式和你期望的几乎一致：

import logging
from message_templates import MESSAGE_TEMPLATES

# 自定义Logger类，新增模板日志方法
class TemplateLogger(logging.Logger):
    def error_template(self, template_key, *args):
        """根据错误码获取模板并输出ERROR级日志"""
        try:
            # 匹配模板并格式化参数
            template = MESSAGE_TEMPLATES[template_key]
            formatted_msg = template.format(*args)
            # 调用原生error方法输出日志
            self.error(formatted_msg)
        except KeyError:
            # 错误码不存在时输出提示
            self.error(f"Unknown error code: {template_key}")

# 设置logging使用我们自定义的Logger类
logging.setLoggerClass(TemplateLogger)

# 配置日志格式和处理器
logger = logging.getLogger("Example")
logger.setLevel(logging.ERROR)

handler = logging.StreamHandler()
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
handler.setFormatter(formatter)
logger.addHandler(handler)

# 调用示例，和你想要的方式高度匹配
logger.error_template("ERROR-1234", "entity-1")
logger.error_template("ERROR-4321", "25", "John Smith")

3. 输出效果 #

运行上面的代码，会得到和你预期完全一致的日志输出：

2024-05-20 14:30:00,123 - Example - ERROR - The entity : entity-1 doesn't exist
2024-05-20 14:30:00,123 - Example - ERROR - The client : 25 with the name John Smith doesn't exist

扩展说明 #

• 如果需要支持INFO、WARNING等其他级别，只需给TemplateLogger添加info_template、warning_template等方法，逻辑和error_template一致即可。
• 可以给模板使用关键字参数，让调用更清晰，比如把模板改成"The entity : {entity_id} doesn't exist"，调用时用logger.error_template("ERROR-1234", entity_id="entity-1")。

内容的提问来源于stack exchange，提问作者Selorbis