std::source_location是C++20引入的轻量级结构体,用于编译期捕获调用点的文件名、函数名、行号和列号;适用于日志、断言、内存调试等需精准位置信息的场景,须通过默认参数+std::source_location::current()正确传递。

std::source_location 是什么,什么时候该用它
std::source_location 是 C++20 引入的轻量级结构体,用于在编译期捕获调用点的文件名、函数名、行号和列号。它不依赖运行时栈回溯,开销极低,适合高频日志场景。但要注意:它只反映调用该函数的位置,不是函数定义处——这点常被误读。
常见错误现象是以为 std::source_location::current() 会自动记录日志语句所在行,结果发现所有日志都显示同一行(比如封装的日志函数内部行号)。根本原因是没在日志入口处显式传入。
使用场景包括:
- 统一日志宏中自动注入位置信息
- 断言失败时输出精确上下文
- 调试内存分配器时标记调用点
- 替代手写 __FILE__ / __LINE__ 宏,提升类型安全
如何正确传递 source_location 到日志函数
必须将 std::source_location 设为函数的默认参数,并在调用点由编译器自动填充。不能手动构造或跨函数传递(除非你明确想“冻结”某个位置)。
void log_debug(const char* msg,
const std::source_location& loc = std::source_location::current()) {
std::fprintf(stderr, "[%s:%d] %s\n",
loc.file_name(), loc.line(), msg);
}
关键点:
立即学习“C++免费学习笔记(深入)”;
- 默认参数必须放在参数列表末尾
-
std::source_location::current()是静态成员函数,不是构造函数 - 不要写成
std::source_location loc{}或std::source_location()—— 这会得到空值(空字符串、0 行号) - 如果函数被内联,位置信息仍准确;如果被优化掉(如 -O3 + noinline),可能失效,需加
[[gnu::used]]或类似属性保活
与传统宏方案对比:为什么推荐用 source_location
传统方式靠 <strong>FILE</strong> 和 <strong>LINE</strong> 拼接字符串,容易出错且类型不安全:
#define LOG_DEBUG(msg) fprintf(stderr, "[%s:%d] %s\n", __FILE__, __LINE__, msg)
问题包括:
-
<strong>FILE</strong>是宏,无法被 constexpr 函数接受 - 字符串字面量长度受限,大路径可能截断
- 无法获取函数名(
<strong>func</strong>是 C99,C++ 中非标准) - 宏展开后调试器难追踪,IDE 不识别跳转
而 std::source_location 提供:
-
file_name()返回const char*,保证以 \0 结尾 -
function_name()在支持编译器(GCC 12+、Clang 14+、MSVC 19.32+)下可用 - 所有字段都是 constexpr,可参与编译期计算
- 类型安全,避免格式化错误(比如误把
<strong>LINE</strong>当整数传给 %s)
实际日志宏封装要注意的坑
直接用函数替代宏虽简洁,但在高频日志场景下可能带来隐式构造开销(即使 trivial)。更稳妥的做法是保留宏外壳,只把 std::source_location 注入进函数:
#define LOG_DEBUG(msg) ::log_debug(msg, std::source_location::current())
容易踩的坑:
- 忘记在头文件中包含
<source_location></source_location> - 在模板函数里用
std::source_location::current(),结果记录的是模板实例化点而非调用点(应改为调用者传入) - 使用
std::format时传入loc.function_name()可能触发临时字符串构造,影响性能 - 在 shared library 中,
file_name()返回相对路径还是绝对路径取决于编译选项(如-frecord-gcc-switches),CI 环境下可能不一致
std::source_location 的价值不在炫技,而在让位置信息真正“属于调用者”。一旦漏掉 ::current() 或放错参数位置,就退回手工拼接的老路。


















