在c++程序开发中，标准输出通常用于打印调试信息、运行状态等内容，当程序需要长期运行或者部署到服务器环境时，直接输出到控制台的内容很难留存，把标准输出重定向到日志文件是更实用的选择。通过操作streambuf可以全局接管标准输出的底层缓冲，实现所有输出内容自动写入日志文件的效果。
streambuf的基本工作原理
c++的标准输入输出流都基于streambuf实现，<iostream>中的std::cout、std::cerr等对象，它们的底层输出操作实际上都是由关联的streambuf对象完成的。每个流对象都维护一个指向streambuf的指针，当调用<<运算符输出内容时，最终会调用streambuf的sputn或者overflow等函数把数据写入缓冲。
我们可以通过替换流对象关联的streambuf，来改变输出的目标位置。比如把std::cout的streambuf替换成我们自定义的、指向日志文件的streambuf，这样所有通过std::cout输出的内容都会写入日志文件。
实现标准输出重定向的核心步骤
1. 自定义日志文件streambuf类
我们需要继承std::streambuf，重写输出相关的函数，把数据写入到指定的日志文件中。核心需要重写overflow函数，这个函数在缓冲满或者需要输出单个字符时会被调用。
#include <iostream>
#include <fstream>
#include <streambuf>
#include <string>
// 自定义streambuf，用于将输出写入日志文件
class LogFileStreamBuf : public std::streambuf {
private:
std::ofstream log_file; // 日志文件输出流
char buffer[1024]; // 内部缓冲，大小可以根据需求调整
public:
// 构造函数，打开指定的日志文件
LogFileStreamBuf(const std::string& file_path) {
log_file.open(file_path, std::ios::out | std::ios::app);
if (!log_file.is_open()) {
throw std::runtime_error("无法打开日志文件: " + file_path);
}
// 设置缓冲区间，使用内部的buffer数组
setp(buffer, buffer + sizeof(buffer));
}
// 析构函数，关闭文件
~LogFileStreamBuf() {
// 先把剩余缓冲的内容写入文件
sync();
if (log_file.is_open()) {
log_file.close();
}
}
protected:
// 重写overflow函数，处理缓冲溢出或者单个字符输出
int_type overflow(int_type c = traits_type::eof()) override {
// 如果缓冲中有数据，先写入文件
if (pbase() != pptr()) {
std::streamsize size = pptr() - pbase();
log_file.write(pbase(), size);
setp(buffer, buffer + sizeof(buffer)); // 重置缓冲指针
}
// 如果传入的不是eof，写入单个字符
if (c != traits_type::eof()) {
char ch = traits_type::to_char_type(c);
log_file.put(ch);
}
return c;
}
// 重写sync函数，刷新缓冲到文件
int sync() override {
if (pbase() != pptr()) {
std::streamsize size = pptr() - pbase();
log_file.write(pbase(), size);
setp(buffer, buffer + sizeof(buffer));
}
log_file.flush();
return 0;
}
};
2. 替换标准输出的streambuf
获取std::cout原来的streambuf保存起来，然后把我们自定义的LogFileStreamBuf关联到std::cout，这样后续的所有std::cout输出都会走到日志文件。需要注意在程序退出前恢复原来的streambuf，避免资源泄漏。
#include <iostream>
#include <fstream>
// 全局保存原来的cout streambuf，用于后续恢复
std::streambuf* original_cout_buf = nullptr;
// 开始重定向标准输出到日志文件
void start_redirect_stdout(const std::string& log_path) {
// 保存原来的cout streambuf
original_cout_buf = std::cout.rdbuf();
// 创建自定义的日志streambuf
LogFileStreamBuf* log_buf = new LogFileStreamBuf(log_path);
// 把cout的streambuf替换成自定义的
std::cout.rdbuf(log_buf);
}
// 停止重定向，恢复原来的标准输出
void stop_redirect_stdout() {
if (original_cout_buf != nullptr) {
// 获取当前cout关联的自定义buf
std::streambuf* current_buf = std::cout.rdbuf();
// 恢复原来的buf
std::cout.rdbuf(original_cout_buf);
// 释放自定义的buf，会触发析构函数写入剩余内容并关闭文件
delete current_buf;
original_cout_buf = nullptr;
}
}
3. 测试重定向效果
编写测试代码验证重定向是否生效，同时测试恢复标准输出后是否恢复正常打印。
int main() {
// 测试未重定向时的输出
std::cout << "这是重定向前的标准输出，会打印到控制台" << std::endl;
// 开始重定向到日志文件
try {
start_redirect_stdout("app_run.log");
} catch (const std::exception& e) {
std::cerr << "重定向失败: " << e.what() << std::endl;
return 1;
}
// 这些输出都会写入日志文件，不会打印到控制台
std::cout << "这是重定向后的输出，会写入日志文件" << std::endl;
std::cout << "第二条日志内容，包含数字: " << 123 << " 和字符串: test" << std::endl;
// 停止重定向，恢复标准输出
stop_redirect_stdout();
// 恢复后的输出会重新打印到控制台
std::cout << "这是恢复后的标准输出，会打印到控制台" << std::endl;
return 0;
}
注意事项
- 重定向范围：上述示例只重定向了
std::cout，如果需要同时重定向std::cerr或者std::clog，可以对这些流对象执行相同的替换操作，分别保存它们原来的streambuf即可。 - 异常安全：如果程序在重定向期间抛出异常，需要确保能够恢复原来的streambuf，可以使用RAII的方式封装重定向逻辑，在析构函数中自动恢复，避免流对象关联野指针。
- 多线程场景：如果程序是多线程的，重定向标准输出会影响所有线程的输出，需要确认是否符合预期，必要时可以加锁保证日志写入的线程安全。
- 资源释放：自定义的LogFileStreamBuf需要手动释放，或者在封装类中管理生命周期，避免内存泄漏，同时析构时要确保缓冲中的剩余内容全部写入文件。
扩展：同时重定向标准错误
如果需要把标准错误也一起捕获到日志文件，可以参考下面的实现方式，分别处理std::cerr的原streambuf：
std::streambuf* original_cerr_buf = nullptr;
void start_redirect_all(const std::string& log_path) {
// 重定向cout
original_cout_buf = std::cout.rdbuf();
std::cout.rdbuf(new LogFileStreamBuf(log_path));
// 重定向cerr
original_cerr_buf = std::cerr.rdbuf();
std::cerr.rdbuf(new LogFileStreamBuf(log_path));
}
void stop_redirect_all() {
if (original_cout_buf != nullptr) {
std::streambuf* cur_cout = std::cout.rdbuf();
std::cout.rdbuf(original_cout_buf);
delete cur_cout;
original_cout_buf = nullptr;
}
if (original_cerr_buf != nullptr) {
std::streambuf* cur_cerr = std::cerr.rdbuf();
std::cerr.rdbuf(original_cerr_buf);
delete cur_cerr;
original_cerr_buf = nullptr;
}
}