c++ std::source_location怎么用 c++日志与断言增强【详解】

c++kquote>std::source_location是C++20引入的编译期自动捕获位置信息的轻量工具,通过current()静态函数获取调用点的文件名、函数名、行号和列号,零开销、类型安全,适用于日志与断言。

std::source_location 是 C++20 引入的轻量级工具,用于在编译期自动捕获当前代码的文件名、函数名、行号和列号,无需手动传参。它不依赖运行时栈遍历,零开销、类型安全、天然适配日志与断言场景。

一、基础用法:自动获取调用点位置信息

std::source_location 本身不可直接构造(私有构造函数),必须通过其静态成员函数 current() 获取——该调用在编译期由编译器注入实际调用处的位置信息:

  • 不写参数时,默认为 current(),编译器自动填充
  • 不能用变量或表达式“传递”一个 source_location;它只反映调用它的那一行代码的位置

示例:

void log(const char* msg, std::source_location loc = std::source_location::current()) {
    std::cout << "[" << loc.file_name() << ":" << loc.line()
              << " in " << loc.function_name() << "] "
              << msg << "\n";
}
// 调用
log("user logged in"); // 输出类似:[main.cpp:12 in main] user logged in

二、集成到日志系统:避免手写 __FILE__ / __LINE__

传统宏日志(如 #define LOG(x) std::cout )难以类型安全、无法携带函数名、且宏展开易出错。用 source_location + 内联函数 可彻底替代:

  • 定义一个内联日志函数,参数含 source_location,默认 current()
  • 支持流式输出(需重载 operator
  • 可轻松扩展为带级别(INFO/WARN/ERROR)、时间戳、线程 ID 的结构化日志入

简化版支持流式:

template
void debug_log(const T& msg, std::source_location loc = std::source_location::current()) {
    std::cout << "[" << loc.file_name() << ":" << loc.line()
              << " (" << loc.function_name() << ")] "
              << msg << "\n";
}
// 使用(自动推导类型,无需宏)
debug_log("value = " << 42); // 输出:[calc.cpp:7 (compute)] value = 42

三、强化断言:让 assert 失败时显示更准确定位

标准 assert 只显示条件和文件行号,缺少函数上下文。用 source_location 可自定义断言宏(仍保持 C++20 兼容性):

  • 用内联函数封装断言逻辑,接收 source_location
  • 失败时打印函数名 + 行号 + 文件 + 实际检查表达式(需配合宏传入字符串字面量)
  • 避免宏污染命名空间,同时保留调试信息精度

示例:

#define MY_ASSERT(expr) \
    do { \
        if (!(expr)) { \
            my_assert_fail(#expr, std::source_location::current()); \
        } \
    } while(0)

void my_assert_fail(const char* expr_str, std::source_location loc) { std::cerr << "Assertion failed: " << expr_str << "\n" << " at " << loc.file_name() << ":" << loc.line() << " in " << loc.function_name() << "\n"; } // 使用 int x = 0; MY_ASSERT(x != 0); // 输出含函数名,比原生 assert 更易定位

四、注意事项与常见误区

source_location 看似简单,但几个关键点直接影响效果:

  • 必须作为函数参数(默认值),不能存为类成员或静态变量——它的值绑定在调用点,不是运行时动态获取
  • clang/gcc/msvc 均已支持(GCC ≥ 10, Clang ≥ 11, MSVC ≥ 19.29),但需开启 C++20(-std=c++20)
  • file_name() 返回 const char*,指向编译器内部字符串;通常为绝对路径,可用 std::filesystem::path 简化显示
  • function_name() 不是标准化格式(各编译器不同),GCC/Clang 返回带签名的完整名,MSVC 较简洁;生产环境建议截取首个空格前部分