C++ `std::source_location`：C++20 获取调用源文件信息

好嘞！准备好坐稳扶好，咱们要开讲啦！今天的主题是C++20的std::source_location，这玩意儿就像一个代码界的GPS，能告诉你代码是从哪里出发的。

开场白：代码也需要身份证！

各位码农，大家好！有没有遇到过这种情况：代码跑飞了，日志里一堆堆的错误信息，让你抓耳挠腮，不知道问题到底出在哪一行？就像大海捞针一样痛苦！

别担心，C++20 给我们带来了一个神器：std::source_location。它可以让你在代码里拿到当前代码的文件名、函数名、行号、列号。有了这些信息，就像给每一行代码都贴上了身份证，查错的时候就能精准定位，妈妈再也不用担心我debug到秃头了！

std::source_location 是个啥？

std::source_location 是 C++20 标准库提供的一个类，它用来表示代码在源代码中的位置。简单来说，就是告诉你“我”现在在哪个文件的哪一行，哪个函数里。

std::source_location 的成员函数

std::source_location 主要有以下几个成员函数：

成员函数	返回值类型	作用
`file_name()`	`const char*`	返回源代码文件名。
`function_name()`	`const char*`	返回包含该位置的函数名。
`line()`	`unsigned int`	返回源代码行号。
`column()`	`unsigned int`	返回源代码列号 (某些编译器可能不支持，返回0)。
`static constexpr source_location current(string_view file_path = __builtin_FILE(), string_view function_name = __builtin_FUNCTION(), uint_least32_t line = __builtin_LINE(), uint_least32_t column = __builtin_COLUMN()) noexcept`	`source_location`	创建一个 `source_location` 对象，默认捕获当前位置信息。

std::source_location 怎么用？

最简单的用法就是直接创建一个 std::source_location 对象，然后调用它的成员函数来获取信息。

#include <iostream>
#include <source_location>

void foo(const std::source_location& location = std::source_location::current()) {
  std::cout << "File: " << location.file_name() << std::endl;
  std::cout << "Function: " << location.function_name() << std::endl;
  std::cout << "Line: " << location.line() << std::endl;
  std::cout << "Column: " << location.column() << std::endl;
}

int main() {
  foo(); // 自动捕获调用位置
  return 0;
}

运行这段代码，你会看到类似下面的输出：

File: main.cpp
Function: main
Line: 12
Column: 3

默认参数的妙用

注意到 foo 函数的参数列表里，std::source_location& location = std::source_location::current() 这一句了吗？这就是 std::source_location 最常用的方式。

默认参数： 这意味着在调用 foo 函数时，如果没有显式地传递 std::source_location 对象，编译器会自动创建一个 std::source_location 对象，并用调用 foo 函数的位置信息来初始化它。
std::source_location::current()： 这是一个静态成员函数，用于创建一个表示当前源代码位置的 std::source_location 对象。

所以，当我们直接调用 foo() 时，它会自动捕获 main 函数中调用它的位置。这种方式非常方便，可以在很多场景下简化代码。

应用场景一：自定义日志系统

有了 std::source_location，打造一个更强大的日志系统简直易如反掌。我们可以把 std::source_location 信息添加到日志消息中，这样在排查问题时就能快速定位到出错的代码。

#include <iostream>
#include <fstream>
#include <source_location>
#include <string>
#include <chrono>
#include <ctime>
#include <iomanip>

void log_message(const std::string& message, const std::source_location& location = std::source_location::current()) {
  // 获取当前时间
  auto now = std::chrono::system_clock::now();
  auto now_c = std::chrono::system_clock::to_time_t(now);
  std::tm now_tm;
  localtime_r(&now_c, &now_tm); // 使用线程安全的 localtime_r

  // 格式化时间
  std::stringstream ss;
  ss << std::put_time(&now_tm, "%Y-%m-%d %H:%M:%S");
  std::string timestamp = ss.str();

  std::ofstream log_file("my_log.txt", std::ios::app); // 追加模式
  if (log_file.is_open()) {
    log_file << "[" << timestamp << "] "
             << "[" << location.file_name() << ":" << location.line() << "] "
             << "[" << location.function_name() << "] "
             << message << std::endl;
    log_file.close();
  } else {
    std::cerr << "Error opening log file!" << std::endl;
  }
}

void do_something() {
  log_message("Doing something...");
}

int main() {
  log_message("Application started.");
  do_something();
  log_message("Application finished.");
  return 0;
}

这段代码会将日志信息写入到 my_log.txt 文件中，每条日志包含时间戳、文件名、行号、函数名和消息内容。这样，即使是复杂的程序，也能轻松追踪到每个日志消息的来源。

应用场景二：断言（Assertions）

断言是调试代码的利器。当断言失败时，程序会终止，并输出一些错误信息。我们可以利用 std::source_location 来增强断言的错误信息，使其更加清晰明了。

#include <iostream>
#include <source_location>
#include <string>

void my_assert(bool condition, const std::string& message, const std::source_location& location = std::source_location::current()) {
  if (!condition) {
    std::cerr << "Assertion failed: " << message << std::endl;
    std::cerr << "File: " << location.file_name() << std::endl;
    std::cerr << "Function: " << location.function_name() << std::endl;
    std::cerr << "Line: " << location.line() << std::endl;
    std::cerr << "Column: " << location.column() << std::endl;
    std::abort(); // 终止程序
  }
}

int main() {
  int x = 5;
  my_assert(x > 10, "x should be greater than 10"); // 断言失败
  std::cout << "This line will not be executed." << std::endl;
  return 0;
}

如果 x 的值小于等于 10，断言就会失败，程序会输出包含文件名、行号、函数名和错误信息的错误提示，并终止执行。

应用场景三：单元测试

在单元测试中，我们经常需要知道哪个测试用例失败了。 std::source_location 可以帮助我们轻松地获取测试用例的位置信息，从而更快地定位到问题。

#include <iostream>
#include <source_location>
#include <string>

void assert_equal(int expected, int actual, const std::string& message, const std::source_location& location = std::source_location::current()) {
  if (expected != actual) {
    std::cerr << "Test failed: " << message << std::endl;
    std::cerr << "Expected: " << expected << ", Actual: " << actual << std::endl;
    std::cerr << "File: " << location.file_name() << std::endl;
    std::cerr << "Function: " << location.function_name() << std::endl;
    std::cerr << "Line: " << location.line() << std::endl;
    std::cerr << "Column: " << location.column() << std::endl;
    // 可以选择抛出异常或者终止程序
    throw std::runtime_error("Test failed");
  } else {
    std::cout << "Test passed: " << message << std::endl;
  }
}

int add(int a, int b) {
  return a + b;
}

int main() {
  assert_equal(5, add(2, 3), "2 + 3 should be 5");
  assert_equal(10, add(4, 5), "4 + 5 should be 10"); // 测试失败
  return 0;
}

在这个例子中，第二个 assert_equal 会失败，并输出详细的错误信息，包括文件名、行号、函数名、期望值和实际值。

应用场景四：AOP(面向切面编程) 实现

std::source_location 在实现简单的 AOP 风格的功能时也能派上用场。比如，你可能想在某个函数执行前后自动记录日志，而不想在每个函数里都手动添加日志代码。

#include <iostream>
#include <source_location>
#include <string>

// 定义一个通用的函数执行前后记录日志的函数
template <typename Func, typename... Args>
auto log_execution(Func func, Args&&... args, const std::source_location& location = std::source_location::current()) {
  std::cout << "Entering function: " << location.function_name() << std::endl;

  // 执行函数，并捕获返回值
  auto result = func(std::forward<Args>(args)...);

  std::cout << "Exiting function: " << location.function_name() << std::endl;
  return result;
}

int my_function(int x, int y) {
  std::cout << "Inside my_function" << std::endl;
  return x + y;
}

int main() {
  // 使用 log_execution 包装 my_function
  int result = log_execution(my_function, 2, 3);
  std::cout << "Result: " << result << std::endl;

  return 0;
}

这段代码中，log_execution 函数接收一个函数作为参数，并在执行该函数前后记录日志。这样，我们就可以在不修改 my_function 函数代码的情况下，为其添加日志功能。

std::source_location 的限制和注意事项

C++20： std::source_location 是 C++20 的新特性，需要使用支持 C++20 的编译器才能编译。
编译器支持： 虽然 std::source_location 是标准库的一部分，但不同编译器对它的支持程度可能有所不同。某些编译器可能不支持 column() 成员函数，或者在某些情况下无法正确获取函数名。
性能影响： 创建 std::source_location 对象会带来一定的性能开销，尤其是在频繁调用的函数中。因此，在使用时需要权衡利弊。
编译时信息： std::source_location 捕获的是编译时的信息，而不是运行时的信息。也就是说，它只能告诉你代码在源代码中的位置，而无法告诉你代码在运行时的调用栈信息。

std::source_location vs. 宏 (__FILE__, __LINE__, __FUNCTION__)

在 std::source_location 出现之前，我们通常使用预定义的宏 __FILE__、__LINE__ 和 __FUNCTION__ 来获取源代码的位置信息。那么，std::source_location 相比于这些宏有什么优势呢？

特性	`std::source_location`	宏 (`__FILE__`, `__LINE__`, `__FUNCTION__`)
类型安全	是	否
可传递性	是	否
默认参数	支持	不支持
可扩展性	可以自定义	不可以
调试信息	更清晰	较为简单

类型安全： std::source_location 是一个类，具有明确的类型，可以进行类型检查。而宏只是简单的文本替换，没有类型安全的概念。
可传递性： std::source_location 对象可以作为参数传递给函数，方便在不同的函数之间共享位置信息。宏则只能在当前作用域内使用。
默认参数： std::source_location 可以作为函数的默认参数，简化代码。宏不支持默认参数。
可扩展性： 我们可以自定义 std::source_location 类的行为，例如添加自定义的成员函数。宏则无法扩展。
调试信息： std::source_location 可以提供更清晰的调试信息，例如列号。

总的来说，std::source_location 相比于宏，更加类型安全、灵活和易于使用。它是 C++ 中一种更现代、更强大的获取源代码位置信息的方式。

std::source_location 的一些高级用法

自定义 source_location 类： 你可以继承 std::source_location 类，并添加自定义的成员函数，以满足特定的需求。例如，你可以添加一个成员函数来获取当前代码的 commit ID。
与异常处理结合使用： 你可以将 std::source_location 信息添加到异常对象中，以便在捕获异常时能够快速定位到异常发生的位置。

总结：有了 std::source_location，代码debug不再难！

std::source_location 是 C++20 中一个非常有用的特性，它可以帮助我们获取源代码的位置信息，从而更好地进行调试、日志记录、单元测试和 AOP 等操作。掌握 std::source_location 的使用方法，可以大大提高我们的开发效率和代码质量。

希望今天的讲解对大家有所帮助！记住，有了 std::source_location，代码 debug 不再难！祝大家编码愉快！

发表回复 取消回复

发表回复取消回复