53 lines
1.2 KiB
Markdown
53 lines
1.2 KiB
Markdown
|
# ConsoleLogSink
|
|||
|
|
|
|||
|
|
**命名空间**: `XCEngine::Debug`
|
|||
|
|
|
|||
|
|
**类型**: `class`
|
|||
|
|
|
|||
|
|
**描述**: 控制台日志输出槽，将日志输出到标准控制台，支持彩色输出。
|
|||
|
|
|
|||
|
|
## 概述
|
|||
|
|
|
|||
|
|
`ConsoleLogSink` 是 `ILogSink` 的控制台实现。它将日志输出到 stdout/stderr，支持按日志级别设置不同颜色。
|
|||
|
|
|
|||
|
|
## 公共方法
|
|||
|
|
|
|||
|
|
### 构造/析构
|
|||
|
|
|
|||
|
|
| 方法 | 描述 |
|
|||
|
|
|------|------|
|
|||
|
|
| `ConsoleLogSink()` | 默认构造函数 |
|
|||
|
|
| `~ConsoleLogSink()` | 析构函数 |
|
|||
|
|
|
|||
|
|
### ILogSink 实现
|
|||
|
|
|
|||
|
|
| 方法 | 描述 |
|
|||
|
|
|------|------|
|
|||
|
|
| `void Log(const LogEntry& entry) override` | 输出日志到控制台 |
|
|||
|
|
| `void Flush() override` | 刷新标准输出流 |
|
|||
|
|
|
|||
|
|
### 配置
|
|||
|
|
|
|||
|
|
| 方法 | 描述 |
|
|||
|
|
|------|------|
|
|||
|
|
| `void SetColorOutput(bool enable)` | 启用/禁用彩色输出 |
|
|||
|
|
| `void SetMinimumLevel(LogLevel level)` | 设置最小输出级别 |
|
|||
|
|
|
|||
|
|
## 使用示例
|
|||
|
|
|
|||
|
|
```cpp
|
|||
|
|
// 创建并配置
|
|||
|
|
auto sink = std::make_unique<ConsoleLogSink>();
|
|||
|
|
sink->SetColorOutput(true);
|
|||
|
|
sink->SetMinimumLevel(LogLevel::Debug);
|
|||
|
|
|
|||
|
|
// 添加到 Logger
|
|||
|
|
Logger::Get().AddSink(std::move(sink));
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## 相关文档
|
|||
|
|
|
|||
|
|
- [Logger](./debug-logger.md) - 日志记录器
|
|||
|
|
- [ILogSink](./debug-ilogsink.md) - 日志输出接口
|
|||
|
|
- [FileLogSink](./debug-filelogsink.md) - 文件输出
|