spdlog 日志库嵌入式 Linux C++使用指南

项目	内容
适配 spdlog 版本	v1.12.0
适用场景	ARM 架构 Linux 系统、C++11 及以上、嵌入式应用日志输出
前置依赖	CMake 3.10+、C++11 编译器、Linux glibc 2.28+

spdlog 日志库嵌入式 Linux C++使用指南 | 极客日志

对比项	spdlog	log4cpp
依赖	无	依赖 log4j、apr 等库
编译体积	小（仅需编译核心源码）	大（依赖库编译后体积大）
内存占用	低（支持按需加载）	高（初始化加载全量组件）
嵌入式适配性	优（头文件优先，支持交叉编译）	差（依赖复杂，需手动移植）

git clone https://github.com/gabime/spdlog.git
cd spdlog && git checkout v1.12.0 # 固定版本，避免兼容性问题

# 1. 添加头文件路径
include_directories(${PROJECT_SOURCE_DIR}/include)
# 2. 添加 spdlog 源码编译
file(GLOB SPDLOG_SRC ${PROJECT_SOURCE_DIR}/third_party/spdlog/*.cpp)
add_library(spdlog STATIC ${SPDLOG_SRC})
# 3. 链接 spdlog 库到项目
add_executable(your_project main.cpp)
target_link_libraries(your_project spdlog pthread) # 依赖 pthread（线程安全）
# 4. 指定 C++ 标准
set(CMAKE_CXX_STANDARD 11)
set(CMAKE_CXX_STANDARD_REQUIRED ON)

# Ubuntu/Debian 系统
sudo apt update && sudo apt install libspdlog-dev

# CMakeLists.txt 配置
find_package(spdlog REQUIRED)
add_executable(your_project main.cpp)
target_link_libraries(your_project spdlog::spdlog)

#include "spdlog/spdlog.h"

int main(){
    // 基础日志输出
    spdlog::trace("这是 TRACE 级日志（最详细）");
    spdlog::debug("这是 DEBUG 级日志（调试信息）");
    spdlog::info("这是 INFO 级日志（普通信息）");
    spdlog::warn("这是 WARN 级日志（警告信息）");
    spdlog::error("这是 ERROR 级日志（错误信息）");
    spdlog::critical("这是 CRITICAL 级日志（严重错误）");
    return 0;
}

# 编译
g++ test_spdlog.cpp -o test -std=c++11 -lspdlog -pthread
# 运行（默认输出 INFO 及以上级别日志）
./test
# 输出结果示例：
# [2025-12-23 15:30:00.123] [info] 这是 INFO 级日志（普通信息）
# [2025-12-23 15:30:00.123] [warn] 这是 WARN 级日志（警告信息）
# [2025-12-23 15:30:00.123] [error] 这是 ERROR 级日志（错误信息）
# [2025-12-23 15:30:00.123] [critical] 这是 CRITICAL 级日志（严重错误）

#include "spdlog/spdlog.h"

int main(){
    // 设置全局日志级别为 DEBUG（输出 DEBUG 及以上级别）
    spdlog::set_level(spdlog::level::debug);
    spdlog::debug("DEBUG 日志将被输出");
    spdlog::trace("TRACE 日志被屏蔽"); // 级别低于 DEBUG，不输出
    return 0;
}

#include "spdlog/spdlog.h"

int main(){
    // 创建自定义 logger
    auto logger = spdlog::get("my_logger");
    if(!logger){
        logger = spdlog::stdout_color_mt("my_logger"); // 彩色控制台输出
    }
    // 单独设置该 logger 的级别为 WARN
    logger->set_level(spdlog::level::warn);
    logger->info("INFO 日志被屏蔽");
    logger->warn("WARN 日志正常输出");
    return 0;
}

// 普通控制台（无颜色）
auto console_logger = spdlog::stdout_logger_mt("console");
// 彩色控制台（推荐，不同级别日志显示不同颜色）
auto color_console = spdlog::stdout_color_mt("color_console");
color_console->info("彩色 INFO 日志");
color_console->error("彩色 ERROR 日志");

#include "spdlog/sinks/basic_file_sink.h"

int main(){
    // 基础文件输出（覆盖模式，每次运行清空文件）
    auto file_logger = spdlog::basic_logger_mt("file_logger", "logs/app.log");
    file_logger->info("写入文件的日志信息");
    // 追加模式（保留历史日志）
    auto append_file = spdlog::basic_logger_mt("append_file", "logs/app.log", true);
    append_file->info("追加到文件末尾的日志");
    return 0;
}

#include "spdlog/sinks/rotating_file_sink.h"

int main(){
    // 按文件大小滚动：单个文件最大 10MB，最多保留 3 个备份文件
    const size_t max_file_size = 10*1024*1024; // 10MB
    const size_t max_files = 3;
    auto rotating_logger = spdlog::rotating_logger_mt("rotating_logger", "logs/rotating.log", max_file_size, max_files);
    
    // 按时间滚动（每天生成一个新文件）
    #include "spdlog/sinks/daily_file_sink.h"
    auto daily_logger = spdlog::daily_logger_mt("daily_logger", "logs/daily.log", 0, 0); // 每天 0 点 0 分新建文件
    return 0;
}

#include "spdlog/spdlog.h"

int main(){
    // 自定义格式：[时间] [进程 ID:线程 ID] [日志级别] 日志内容
    spdlog::set_pattern("[%Y-%m-%d %H:%M:%S.%e] [%P:%t] [%l] %v");
    spdlog::info("自定义格式的日志信息");
    // 输出示例：[2025-12-23 15:40:00.123] [1234:5678] [info] 自定义格式的日志信息
    return 0;
}

占位符	含义	示例
%Y-%m-%d	年 - 月 - 日	2025-12-23
%H:%M:%S.%e	时:分:秒。毫秒	15:40:00.123
%P	进程 ID	1234
%t	线程 ID	5678
%l	日志级别（小写）	info、error
%L	日志级别（大写）	INFO、ERROR
%v	日志内容	自定义日志信息

#include "spdlog/spdlog.h"
#include "spdlog/async.h"
#include "spdlog/sinks/basic_file_sink.h"

int main(){
    // 配置异步日志：队列大小 8192，线程数 1（嵌入式建议单线程）
    spdlog::init_thread_pool(8192, 1);
    // 创建文件 sink
    auto file_sink = std::make_shared<spdlog::sinks::basic_file_sink_mt>("logs/async.log", true);
    // 创建异步 logger
    auto async_logger = std::make_shared<spdlog::async_logger>("async_logger", file_sink, spdlog::thread_pool(), spdlog::async_overflow_policy::block);
    // 注册并设置为默认 logger
    spdlog::register_logger(async_logger);
    spdlog::set_default_logger(async_logger);
    // 异步输出日志（不阻塞主线程）
    for(int i = 0; i < 1000; ++i){
        spdlog::info("异步日志输出：{}", i);
    }
    // 程序退出前刷新日志（避免丢失）
    spdlog::shutdown();
    return 0;
}

#include "spdlog/spdlog.h"
#include "spdlog/sinks/stdout_color_sinks.h"
#include "spdlog/sinks/rotating_file_sink.h"

int main(){
    // 创建控制台 sink 和滚动文件 sink
    auto console_sink = std::make_shared<spdlog::sinks::stdout_color_sink_mt>();
    auto file_sink = std::make_shared<spdlog::sinks::rotating_file_sink_mt>("logs/multi_sink.log", 10*1024*1024, 3);
    // 组合 sink 到同一个 logger
    std::vector<spdlog::sink_ptr> sinks{console_sink, file_sink};
    auto multi_sink_logger = std::make_shared<spdlog::logger>("multi_sink", sinks.begin(), sinks.end());
    // 注册并使用
    spdlog::register_logger(multi_sink_logger);
    multi_sink_logger->info("同时输出到控制台和文件");
    return 0;
}

#include "spdlog/spdlog.h"
#include "spdlog/sinks/base_sink.h"
#include <unistd.h>
#include <fcntl.h>
#include <termios.h>

// 自定义串口 sink
class serial_sink : public spdlog::sinks::base_sink<std::mutex>{
private:
    int serial_fd_; // 初始化串口（嵌入式需根据硬件调整参数）
    void init_serial(const std::string& port){
        serial_fd_ = open(port.c_str(), O_RDWR | O_NOCTTY | O_NDELAY);
        if(serial_fd_ < 0){
            throw std::runtime_error("串口打开失败");
        }
        struct termios options;
        tcgetattr(serial_fd_, &options);
        cfsetispeed(&options, B115200); // 波特率 115200
        cfsetospeed(&options, B115200);
        options.c_cflag |= (CLOCAL | CREAD); // 本地连接、启用接收
        options.c_cflag &= ~PARENB; // 无校验位
        options.c_cflag &= ~CSTOPB; // 1 位停止位
        options.c_cflag &= ~CSIZE;
        options.c_cflag |= CS8; // 8 位数据位
        tcsetattr(serial_fd_, TCSANOW, &options);
    }
protected:
    void sink_it_(const spdlog::details::log_msg& msg) override {
        // 格式化日志内容
        spdlog::memory_buf_t formatted;
        spdlog::sinks::base_sink<std::mutex>::formatter_->format(msg, formatted);
        // 写入串口
        write(serial_fd_, formatted.data(), formatted.size());
    }
    void flush_() override {
        tcdrain(serial_fd_); // 等待串口数据发送完成
    }
public:
    explicit serial_sink(const std::string& port = "/dev/ttyS0"){
        init_serial(port);
    }
    ~serial_sink() override {
        if(serial_fd_ >= 0){
            close(serial_fd_);
        }
    }
};

// 使用自定义串口 sink
int main(){
    auto serial_sink_ptr = std::make_shared<serial_sink>();
    auto serial_logger = std::make_shared<spdlog::logger>("serial_logger", serial_sink_ptr);
    spdlog::register_logger(serial_logger);
    serial_logger->info("通过串口输出的日志信息");
    return 0;
}

add_compile_options(-fexec-charset=UTF-8 -finput-charset=UTF-8)

error: 'nullptr' was not declared in this scope

API	功能描述
spdlog::set_level()	设置全局日志级别
spdlog::set_pattern()	设置全局日志格式
spdlog::get(logger_name)	获取已注册的 logger 实例
spdlog::shutdown()	刷新日志队列并释放资源
logger->set_level()	设置单个 logger 的日志级别
logger->flush()	手动刷新日志到输出目标

spdlog 日志库嵌入式 Linux C++使用指南

spdlog 日志库嵌入式 Linux C++使用指南

文档信息

一、工具介绍

1.1 工具定位

1.2 核心特性

1.3 对比优势（嵌入式场景）

二、快速集成

2.1 集成方式 1：源码集成（嵌入式推荐）

步骤 1：下载源码

步骤 2：项目集成

步骤 3：CMakeLists.txt 配置

2.2 集成方式 2：包管理集成（桌面 Linux）

2.3 验证集成

测试代码（test_spdlog.cpp）

编译运行

三、基础使用

3.1 日志级别控制

3.1.1 全局级别设置

3.1.2 按 logger 实例设置级别

3.2 输出目标配置

3.2.1 控制台输出

3.2.2 文件输出

3.2.3 滚动文件输出（嵌入式推荐）

3.3 日志格式自定义

3.3.1 全局格式设置

3.3.2 格式占位符说明

四、高级特性

4.1 异步日志配置（嵌入式避坑）

4.1.1 基础异步配置

4.1.2 嵌入式避坑点

4.2 多 sink 组合输出

4.3 嵌入式串口输出（自定义 sink）

五、避坑指南/常见问题

5.1 中文乱码问题

现象

解决方案

示例 CMake 配置

5.2 同步日志阻塞主线程

现象

解决方案

5.3 编译报错：nullptr 未定义

错误信息

解决方案

5.4 日志文件占满闪存

现象

解决方案

六、附录

6.1 常用 API 速查表

6.2 参考链接

6.3 术语解释

微信扫一扫，关注极客日志

更多推荐文章

相关免费在线工具