在spdlog中实现按日志级别动态控制格式显示

概述

在使用spdlog进行日志记录时，开发者有时需要针对不同级别的日志消息采用不同的格式化方式。本文介绍如何通过自定义格式化器来实现这一需求，特别是如何隐藏特定级别（如debug）的日志前缀，同时保留其他级别（如trace、info）的格式标记。

需求场景

一个常见的日志格式化需求是：

• 对trace级别保留[trace]前缀
• 对debug级别完全隐藏前缀（仅显示原始消息）
• 对info级别保留[info]前缀

期望输出示例：

[trace] 这是一条trace日志
这是一条debug日志
[info] 这是一条info日志

技术实现方案

方案一：自定义格式化器

spdlog允许开发者通过继承spdlog::custom_flag_formatter类来实现自定义的格式化逻辑。我们可以创建一个针对不同日志级别采用不同格式的自定义格式化器。

实现步骤：

1. 继承spdlog::custom_flag_formatter类
2. 重写format方法，根据日志级别选择不同的格式化方式
3. 在格式化方法中，可以针对debug级别直接输出原始消息，对其他级别添加标准前缀

关键代码结构：

class level_specific_formatter : public spdlog::custom_flag_formatter {
public:
    void format(const spdlog::details::log_msg& msg, const std::tm&, spdlog::memory_buf_t& dest) override {
        if(msg.level == spdlog::level::debug) {
            // 直接添加消息内容，不加前缀
            dest.append(msg.payload.data(), msg.payload.data() + msg.payload.size());
        } else {
            // 添加标准格式前缀
            std::string prefix = "[" + std::string(spdlog::level::to_string_view(msg.level)) + "] ";
            dest.append(prefix.data(), prefix.data() + prefix.size());
            dest.append(msg.payload.data(), msg.payload.data() + msg.payload.size());
        }
    }
    
    std::unique_ptr<custom_flag_formatter> clone() const override {
        return spdlog::details::make_unique<level_specific_formatter>();
    }
};

方案二：多sink组合方式

另一种实现思路是为不同级别的日志配置不同的sink，每个sink使用不同的格式化器：

1. 创建两个sink实例
2. 为debug级别的sink配置仅输出消息内容的格式化器
3. 为其他级别的sink配置标准格式化器
4. 使用spdlog::sinks::dist_sink组合这些sink

这种方法虽然也能实现需求，但相比自定义格式化器方案略显复杂，且需要维护多个sink实例。

最佳实践建议

1. 性能考虑：自定义格式化器方案通常性能更好，因为它避免了多sink带来的额外开销

2. 扩展性：自定义格式化器可以轻松扩展，支持更复杂的级别特定格式化需求

3. 维护性：单一格式化器方案更易于维护，所有格式化逻辑集中在一处

4. 线程安全：spdlog本身是线程安全的，自定义格式化器也应当保持线程安全

实现示例

以下是完整的自定义格式化器实现示例：

#include <spdlog/spdlog.h>
#include <spdlog/pattern_formatter.h>
#include <spdlog/sinks/basic_file_sink.h>

class level_specific_formatter : public spdlog::custom_flag_formatter {
public:
    void format(const spdlog::details::log_msg& msg, const std::tm&, spdlog::memory_buf_t& dest) override {
        if(msg.level == spdlog::level::debug) {
            // 直接添加消息内容，不加前缀
            dest.append(msg.payload.data(), msg.payload.data() + msg.payload.size());
        } else {
            // 添加标准格式前缀
            std::string prefix = "[" + std::string(spdlog::level::to_string_view(msg.level)) + "] ";
            dest.append(prefix.data(), prefix.data() + prefix.size());
            dest.append(msg.payload.data(), msg.payload.data() + msg.payload.size());
        }
    }
    
    std::unique_ptr<custom_flag_formatter> clone() const override {
        return spdlog::details::make_unique<level_specific_formatter>();
    }
};

int main() {
    auto logger = spdlog::basic_logger_mt("custom_logger", "logs.txt");
    
    auto formatter = std::make_unique<spdlog::pattern_formatter>();
    formatter->add_flag<level_specific_formatter>('*').set_pattern("%*");
    logger->set_formatter(std::move(formatter));
    
    logger->trace("这是一条trace日志");
    logger->debug("这是一条debug日志");
    logger->info("这是一条info日志");
    
    return 0;
}

总结

通过spdlog的自定义格式化器功能，开发者可以灵活地控制不同级别日志的显示格式。本文介绍的自定义格式化器方案是实现级别特定格式化的最佳选择，它既保持了代码的简洁性，又提供了良好的扩展性和性能表现。在实际项目中，开发者可以根据具体需求调整格式化逻辑，实现更复杂的日志显示效果。