当前位置：首页 > news >正文

plog扩展开发实战：自定义格式化器与附加器完全指南

news 2026/4/14 17:15:41

plog扩展开发实战：自定义格式化器与附加器完全指南

【免费下载链接】plogPortable, simple and extensible C++ logging library项目地址: https://gitcode.com/gh_mirrors/pl/plog

plog是一款轻量级、可移植且高度可扩展的C++日志库，它允许开发者根据项目需求定制日志行为。本文将带你深入了解如何开发自定义格式化器和附加器，解锁plog的全部潜力。

为什么需要自定义扩展？

plog虽然提供了丰富的内置功能，但实际项目中往往需要：

特定格式的日志输出（如JSON、XML）
对接企业内部日志系统
实现特殊的日志过滤逻辑
满足行业合规性要求

通过自定义扩展，你可以将plog无缝集成到任何项目环境中。

自定义格式化器开发指南 🛠️

格式化器负责将日志记录转换为字符串输出。plog的格式化器基于模板实现，你可以通过继承基础类或创建全新实现来定制格式。

格式化器基础结构

查看核心格式化器接口实现：TxtFormatter.h

template<bool useUtcTime> class TxtFormatterImpl { public: static util::nstring header() { return util::nstring(); } static util::nstring format(const Record& record) { // 格式化逻辑实现 } };

开发步骤

创建格式化器类，实现header()和format()静态方法
使用Record对象获取日志详情：
- 时间戳：record.getTime()
- 日志级别：record.getSeverity()
- 线程ID：record.getTid()
- 消息内容：record.getMessage()
实现自定义格式，例如CSV格式：

class CsvFormatter { public: static util::nstring format(const Record& record) { util::nostringstream ss; ss << record.getTime().time << "," << severityToString(record.getSeverity()) << "," << record.getMessage() << "\n"; return ss.str(); } };

自定义附加器开发详解 📦

附加器负责日志的最终输出目的地，如控制台、文件或网络服务。所有附加器都需要实现IAppender接口。

IAppender接口定义

查看接口定义：IAppender.h

class PLOG_LINKAGE IAppender { public: virtual ~IAppender() {} virtual void write(const Record& record) = 0; };

开发步骤

创建附加器类，继承IAppender接口
实现write()方法，处理日志记录
管理资源生命周期，如文件句柄、网络连接

示例：将日志输出到数据库的附加器

class DatabaseAppender : public IAppender { public: void write(const Record& record) override { // 数据库连接与日志写入逻辑 std::string sql = "INSERT INTO logs (time, level, message) VALUES (?, ?, ?)"; // 执行SQL插入操作 } };

实战案例：创建JSON日志系统

让我们通过一个完整示例，创建能输出JSON格式日志的自定义格式化器和附加器。

1. JSON格式化器实现

// JsonFormatter.h #include <plog/Record.h> #include <nlohmann/json.hpp> using json = nlohmann::json; class JsonFormatter { public: static util::nstring format(const Record& record) { json j; j["timestamp"] = record.getTime().time; j["severity"] = severityToString(record.getSeverity()); j["thread"] = record.getTid(); j["message"] = record.getMessage(); return j.dump() + "\n"; } };

2. 文件附加器实现

// JsonFileAppender.h #include <plog/Appenders/IAppender.h> #include <fstream> class JsonFileAppender : public IAppender { private: std::ofstream m_file; public: JsonFileAppender(const std::string& filename) { m_file.open(filename, std::ios::app); } void write(const Record& record) override { if (m_file.is_open()) { m_file << JsonFormatter::format(record); m_file.flush(); } } };

3. 使用自定义扩展

#include <plog/Log.h> #include "JsonFileAppender.h" int main() { plog::init(plog::debug, new JsonFileAppender("app.log")); LOG_INFO << "Application started"; return 0; }

扩展注册与使用

开发完成后，你需要将自定义扩展注册到plog系统：

// 注册自定义附加器 plog::IAppender* myAppender = new MyCustomAppender(); plog::init(plog::info, myAppender); // 或结合内置组件使用 auto consoleAppender = new plog::ConsoleAppender<plog::TxtFormatter>(); auto fileAppender = new MyCustomAppender(); plog::init(plog::debug, consoleAppender).addAppender(fileAppender);