C++如何使用std::source_location在日志模块中自动注入函数名与行号

千丽大大_5919

千丽大大_5919

2026-07-16

307人浏览

原创

c++oding="utf-8" ?>

std::source_location不能直接拿到可读函数名,其function_name()返回编译器符号名或空字符串;应配合__func__获取函数名,用source_location获取文件名、行号和列号。

c++如何使用std::source_location在日志模块中自动注入函数名与行号

std::source_location 是什么,它能直接拿到函数名吗

std::source_location 是 C++20 引入的轻量结构体,用于在编译期捕获调用点的源码位置信息。它本身不存储函数名(function_name() 返回的是编译器生成的符号名,比如 "void log_info(const char*)" 或更糟的 "_Z8log_infoPKc"),但能稳定提供 file_name()、line()、column()。

所以别指望它“自动注入可读函数名”——你得靠宏 + __func__(或 __FUNCTION__)配合使用。

常见错误:直接写 std::source_location::current().function_name() 并期待得到 "main" 这样的干净名字,结果看到一堆乱码或空字符串(某些编译器/标准库实现返回空)。

  • std::source_location::current() 必须在被调用函数内部调用,不能提前取值再传参,否则位置信息指向宏展开处而非实际调用点
  • MSVC 和 GCC 12+ 支持较好;Clang 14+ 基本可用,但 function_name() 在 Clang 上常为空,务必实测
  • 若需跨平台一致行为,函数名必须用 __func__,位置信息用 std::source_location

如何用宏把 __func__ 和 std::source_location 组装进日志调用

核心思路:定义一个带默认参数的日志函数,让宏自动补全 __func__ 和 std::source_location::current(),避免每次手动传。

示例定义:

C++ Code Review Master
C++ Code Review Master

组合式C++代码评审方案,融合静态分析、AI推理、多轮迭代评审和C++专项检查,适用于PR审查、增量代码审查、全项目评审和代码质量评分,触发词包括review cpp、cpp代码评审、C++review、代码审查。

下载
void log_debug(const char* msg,
               const char* func = __func__,
               const std::source_location& loc = std::source_location::current()) {
    std::fprintf(stderr, "[%s:%d] %s — %s\n",
                 loc.file_name(), loc.line(),
                 func, msg);
}

调用时直接写 log_debug("user logged in"),无需传函数名或位置——宏不是必须的,但上面这种默认参数写法已足够简洁且无宏污染。

  • 不要用 #define LOG_DEBUG(msg) log_debug(msg, __func__, std::source_location::current()):这会破坏调试栈(__func__ 变成宏名所在函数,不是调用者)
  • 默认参数方式下,__func__ 展开在调用点,std::source_location::current() 也在调用点求值,行为可靠
  • 注意:std::source_location 是 trivial 类型,按值传递零开销;__func__ 是静态字符串字面量,也不额外分配

为什么不能把 source_location 当作普通参数传给异步日志队列

如果你把日志异步化(比如 push 到线程安全队列里延后打印),std::source_location 里的 file_name() 返回的是 const char*,指向编译器内建的只读字符串字面量——它生命周期是整个程序运行期,没问题;但关键陷阱在于:__func__ 也是局部作用域的字符串字面量,同样安全。

真正危险的是:别在异步回调里用 std::source_location::current()!那会记录日志系统内部函数的位置,不是原始调用点。

  • 必须在同步入口处(即用户调用日志函数那一刻)完成 std::source_location::current() 的求值,并把结果(含 file_name() 指针、line() 等)拷贝进日志消息结构体
  • 不要存 std::source_location 的引用或指针,它不是 RAII 类型,只是几个整数和 const char* 字段
  • 如果日志结构体需要长期持有文件名,确保不依赖 std::string 动态分配(小字符串优化可能不够快),多数场景直接存 const char* 就够了

GCC/Clang 下 function_name() 返回空字符串怎么办

这是真实存在的兼容性坑:Clang 默认不填充 function_name() 字段,GCC 12 开始支持但需开启 -g;即使有调试信息,libc++ 实现也可能返回空。

结论很明确:永远不要依赖 std::source_location::function_name() 做功能逻辑,它只是个“尽力而为”的提示字段。

  • 坚持用 __func__ 获取函数名——它是 C++11 标准保证的,所有编译器都支持,内容可读
  • 如果非要统一接口,可以封装一个辅助函数:
    inline const char* safe_func_name(const std::source_location& loc) {
        auto fn = loc.function_name();
        return *fn ? fn : __func__;
    }
    但注意:这个 __func__ 在辅助函数里展开,返回的是辅助函数自己的名字,不是调用者——所以这写法无效。正确做法仍是让日志函数接收 const char* func = __func__
  • 测试手段:在不同编译器下打印 loc.function_name() 内容,确认是否为空;CI 中建议加断言检查(仅 debug 模式)

最简、最稳的组合就是:__func__ 负责函数名,std::source_location 负责文件与行号,两者缺一不可,但职责分明。

C++免费学习笔记(深入):立即使用
在学习笔记中,你将探索 C++ 的入门与实战技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

c++ c++入门教程 c++编程

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
c++和c语言的区别有哪些
c++和c语言的区别有哪些

c++和c语言的区别:1、面向对象编程(OOP)支持不同;2、新增特性不同;3、标准库不同;4、编译方式不同;5、命名空间不同等等。想了解更多c++的相关内容,可以阅读本专题下面的文章。

2024.03.14

2208

9

c++和python学习顺序推荐
c++和python学习顺序推荐

一般建议先学习C++,再学习Python,因为这样可以逐步从较为底层的编程语言向更高级的语言过渡。想了解更多python的相关内容,可以阅读本专题下面的文章。

2024.03.14

979

6

python和c++学习性价比分析
python和c++学习性价比分析

Python易于学习,广泛应用于Web开发、数据科学和人工智能等领域,但性能较低。C语言性能高,适用于对性能要求较高的场景,如游戏开发和系统编程,但学习曲线陡峭,错误处理复杂。想了解更多python的相关内容,可以阅读本专题下面的文章。

2024.03.14

407

5

c语言和c++一样吗
c语言和c++一样吗

c语言和c++是两种不同的编程语言,虽然有相似之处,但存在显著差异。c语言专注于过程式编程和系统级开发,以简洁、高效著称。c++作为c语言的超集,引入了面向对象编程,增强了代码组织和管理能力,但学习曲线也更陡峭。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.03.14

307

5

c语言和c++先学哪个好
c语言和c++先学哪个好

初学者选择学习c语言还是c++语言,需要根据个人学习目标、背景以及编程兴趣和预期应用方向来决定。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.03.14

386

5

c语言和c++的区别和联系
c语言和c++的区别和联系

c语言和c++是计算机科学领域应用广泛的编程语言。虽然它们有着相似的基础,但它们在语言类型、语法功能和内存管理方面存在着显著差异。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.03.14

580

5

c++软件中文更改教程
c++软件中文更改教程

对于 ide,可通过打开设置,找到语言设置,选择中文,并保存更改。对于非 ide 应用程序,可查找设置或选项,选择语言设置,更改为中文,并保存更改。想了解更多c++的相关内容,可以阅读本专题下面的文章。

2024.03.21

1389

9

python和java和c++学习性价比分析
python和java和c++学习性价比分析

Python以其易学性、丰富的库和活跃的社区而著称,适合数据科学、人工智能和Web开发。Java以其跨平台性、企业级应用开发和Android应用开发而闻名。C++以其底层控制能力、高效性能和游戏开发而著称。选择哪种语言取决于个人兴趣、职业方向和特定需求。想了解更多python和java和c++的相关内容,可以阅读本专题下面的文章。

2024.03.22

1197

7

c++和c语言学习顺序推荐
c++和c语言学习顺序推荐

对于初学者,建议先学习C语言,掌握编程基础后再转入C++,便于理解面向对象编程概念。有编程经验者可直接学习C++,快速接触高级编程技术。想了解更多c++和c语言的相关内容,可以阅读本专题下面的文章。

2024.03.25

1305

9

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Conan 2 Essentials 免费课程
Conan 2 Essentials 免费课程

共0课时 | 0人学习

CMake 与 Conan 集成实践
CMake 与 Conan 集成实践

共0课时 | 0人学习

Conan 2 高级依赖模型介绍
Conan 2 高级依赖模型介绍

共0课时 | 0人学习