2026-03-18 17:49:22 +08:00
|
|
|
|
# Logger
|
|
|
|
|
|
|
|
|
|
|
|
**命名空间**: `XCEngine::Debug`
|
|
|
|
|
|
|
|
|
|
|
|
**类型**: `class` (singleton)
|
|
|
|
|
|
|
|
|
|
|
|
**头文件**: `XCEngine/Debug/Logger.h`
|
|
|
|
|
|
|
2026-03-20 02:35:07 +08:00
|
|
|
|
**描述**: 日志系统,提供分级日志记录功能
|
2026-03-18 17:49:22 +08:00
|
|
|
|
|
|
|
|
|
|
## 概述
|
|
|
|
|
|
|
2026-03-20 02:35:07 +08:00
|
|
|
|
Logger 是 XCEngine 的核心日志系统,采用单例模式设计。它提供多级别(Verbose、Debug、Info、Warning、Error、Fatal)和多分类(General、Rendering、Physics 等)的日志记录功能,支持自定义日志输出槽(Sink)。
|
2026-03-18 17:49:22 +08:00
|
|
|
|
|
2026-03-20 02:35:07 +08:00
|
|
|
|
Logger 支持多个 Sink 组件,每个 Sink 可以将日志输出到不同的目的地(如文件、控制台、远程服务器等)。系统还提供宏定义 `XE_LOG` 和 `XE_ASSERT` 方便快速记录日志。
|
2026-03-18 17:49:22 +08:00
|
|
|
|
|
|
|
|
|
|
## 公共方法
|
|
|
|
|
|
|
|
|
|
|
|
| 方法 | 描述 |
|
|
|
|
|
|
|------|------|
|
2026-03-20 02:35:07 +08:00
|
|
|
|
| [`Get`](get.md) | 获取 Logger 单例实例 |
|
|
|
|
|
|
| [`Initialize`](initialize.md) | 初始化日志系统 |
|
|
|
|
|
|
| [`Shutdown`](shutdown.md) | 关闭日志系统 |
|
|
|
|
|
|
| [`AddSink`](addsink.md) | 添加日志输出槽 |
|
|
|
|
|
|
| [`RemoveSink`](removesink.md) | 移除日志输出槽 |
|
|
|
|
|
|
| [`Log`](log.md) | 通用日志记录方法 |
|
|
|
|
|
|
| [`Verbose`](verbose.md) | 记录 Verbose 级别日志 |
|
|
|
|
|
|
| [`Debug`](debug.md) | 记录 Debug 级别日志 |
|
|
|
|
|
|
| [`Info`](info.md) | 记录 Info 级别日志 |
|
|
|
|
|
|
| [`Warning`](warning.md) | 记录 Warning 级别日志 |
|
|
|
|
|
|
| [`Error`](error.md) | 记录 Error 级别日志 |
|
|
|
|
|
|
| [`Fatal`](fatal.md) | 记录 Fatal 级别日志 |
|
|
|
|
|
|
| [`SetMinimumLevel`](setminimumlevel.md) | 设置最低日志级别 |
|
|
|
|
|
|
| [`SetCategoryEnabled`](setcategoryenabled.md) | 设置分类日志开关 |
|
2026-03-18 17:49:22 +08:00
|
|
|
|
|
2026-03-20 02:35:07 +08:00
|
|
|
|
## 使用示例
|
2026-03-18 17:49:22 +08:00
|
|
|
|
|
|
|
|
|
|
```cpp
|
2026-03-20 02:35:07 +08:00
|
|
|
|
#include "XCEngine/Debug/Logger.h"
|
|
|
|
|
|
#include "XCEngine/Debug/ConsoleSink.h"
|
2026-03-18 17:49:22 +08:00
|
|
|
|
|
2026-03-20 02:35:07 +08:00
|
|
|
|
using namespace XCEngine::Debug;
|
2026-03-18 17:49:22 +08:00
|
|
|
|
|
2026-03-20 02:35:07 +08:00
|
|
|
|
// 获取单例
|
|
|
|
|
|
Logger& logger = Logger::Get();
|
2026-03-18 17:49:22 +08:00
|
|
|
|
|
|
|
|
|
|
// 初始化
|
2026-03-20 02:35:07 +08:00
|
|
|
|
logger.Initialize();
|
|
|
|
|
|
|
|
|
|
|
|
// 添加控制台输出Sink
|
|
|
|
|
|
logger.AddSink(std::make_unique<ConsoleSink>());
|
2026-03-18 17:49:22 +08:00
|
|
|
|
|
2026-03-20 02:35:07 +08:00
|
|
|
|
// 使用便捷方法记录日志
|
|
|
|
|
|
logger.Info(LogCategory::General, "Application started");
|
|
|
|
|
|
logger.Warning(LogCategory::Rendering, "Low memory warning");
|
|
|
|
|
|
logger.Error(LogCategory::Network, "Connection failed");
|
2026-03-18 17:49:22 +08:00
|
|
|
|
|
2026-03-20 02:35:07 +08:00
|
|
|
|
// 使用宏记录日志(自动包含文件、行号、函数信息)
|
|
|
|
|
|
XE_LOG(LogCategory::General, LogLevel::Info, "User logged in");
|
2026-03-18 17:49:22 +08:00
|
|
|
|
|
2026-03-20 02:35:07 +08:00
|
|
|
|
// 设置最低日志级别
|
|
|
|
|
|
logger.SetMinimumLevel(LogLevel::Warning); // 只记录 Warning 及以上
|
2026-03-18 17:49:22 +08:00
|
|
|
|
|
2026-03-20 02:35:07 +08:00
|
|
|
|
// 关闭
|
|
|
|
|
|
logger.Shutdown();
|
2026-03-18 17:49:22 +08:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
## 相关文档
|
|
|
|
|
|
|
docs: 重构 API 文档结构并修正源码准确性
- 重组文档目录结构: 每个模块的概述页移动到模块子目录
- 重命名 index.md 为 main.md
- 修正所有模块文档中的错误:
- math: FromEuler→FromEulerAngles, TransformDirection 包含缩放, Box 是 OBB, Color::ToRGBA 格式
- containers: 新增 operator==/!= 文档, 补充 std::hash DJB 算法细节
- core: 修复 types 链接错误
- debug: LogLevelToString 返回大写, timestamp 是秒, Profiler 空实现标注, Windows API vs ANSI
- memory: 修复头文件路径, malloc vs operator new, 新增方法文档
- resources: 修复 Shader/Texture 链接错误
- threading: TaskSystem::Wait 空实现标注, ReadWriteLock 重入描述, LambdaTask 链接
- 验证: fix_links.py 确认 0 个断裂引用
2026-03-19 00:22:30 +08:00
|
|
|
|
- [LogLevel](../loglevel/loglevel.md) - 日志级别枚举
|
2026-03-20 02:35:07 +08:00
|
|
|
|
- [LogCategory](../logcategory/logcategory.md) - 日志分类枚举
|
|
|
|
|
|
- [ILogSink](../ilogsink/ilogsink.md) - 日志输出槽接口
|