UnityHeapCrawler 项目教程

UnityHeapCrawler 项目教程

UnityHeapCrawler Reflection based heap shapshot tool for Unity game engine 项目地址: https://gitcode.com/gh_mirrors/un/UnityHeapCrawler

1. 项目的目录结构及介绍

UnityHeapCrawler 项目的目录结构如下：

UnityHeapCrawler/
├── Assets/
│   ├── Packages/
│   └── ProjectSettings/
├── snapshot-example-diff/
├── snapshot-example/
├── .gitignore
├── Assembly-CSharp.csproj
├── Assembly-CSharp.csproj.DotSettings
├── Doxyfile
├── DreamMemoryAnalyzer.csproj
├── DreamMemoryAnalyzer.csproj.DotSettings
├── LICENSE
├── README.md

目录结构介绍

• Assets/: 包含项目的资源文件，如脚本、材质、贴图等。
  • Packages/: 包含项目使用的 Unity 包。
  • ProjectSettings/: 包含项目的设置文件，如 Unity 编辑器设置、构建设置等。
• snapshot-example-diff/: 包含示例的差异快照文件。
• snapshot-example/: 包含示例的快照文件。
• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被 Git 跟踪。
• Assembly-CSharp.csproj: C# 项目文件，定义项目的编译设置。
• Assembly-CSharp.csproj.DotSettings: 项目设置文件，可能包含一些额外的配置。
• Doxyfile: Doxygen 配置文件，用于生成项目的文档。
• DreamMemoryAnalyzer.csproj: 另一个 C# 项目文件，可能用于内存分析工具。
• DreamMemoryAnalyzer.csproj.DotSettings: 该项目的设置文件。
• LICENSE: 项目的开源许可证文件，本项目使用 MIT 许可证。
• README.md: 项目的介绍文件，包含项目的概述、使用方法等信息。

2. 项目的启动文件介绍

UnityHeapCrawler 项目的启动文件是 HeapSnapshotCollector 类。该类位于 Assets/UnityHeapCrawler/HeapSnapshotCollector.cs 文件中。

HeapSnapshotCollector 类介绍

HeapSnapshotCollector 类是 UnityHeapCrawler 的核心类，用于爬取 Mono 堆并收集内存使用情况。该类提供了以下主要功能：

• 内存快照收集: 可以生成当前内存的快照，用于分析内存使用情况。
• 差异模式: 支持生成与之前快照的差异报告，仅显示新增的对象。
• 自定义根路径: 允许用户定义特定的根路径进行跟踪。

使用方法

要启动内存快照收集，首先需要创建 HeapSnapshotCollector 类的实例，并调用 Start() 方法。以下是一个简单的使用示例：

HeapSnapshotCollector collector = new HeapSnapshotCollector();
collector.Start();

3. 项目的配置文件介绍

UnityHeapCrawler 项目的配置文件主要包括 CrawlSettings 类和 HeapSnapshotCollector 类的配置。

CrawlSettings 类

CrawlSettings 类用于配置爬取结果的输出设置，包括内存树的输出格式、过滤条件等。

HeapSnapshotCollector 类配置

HeapSnapshotCollector 类提供了多个配置选项，可以通过修改这些选项来定制内存快照的收集行为。以下是一些常用的配置选项：

• DifferentialMode: 是否启用差异模式，仅显示新增对象。
• AddForbiddenTypes: 禁止某些类型被爬取，避免不必要的内存消耗。
• AddRootTypes: 添加自定义的根类型，用于特定的内存分析需求。

配置示例

以下是一个配置示例，展示了如何设置差异模式和禁止某些类型：

HeapSnapshotCollector collector = new HeapSnapshotCollector();
collector.DifferentialMode = true; // 启用差异模式
collector.AddForbiddenTypes(typeof(SomeType)); // 禁止爬取 SomeType 类型
collector.Start();

通过这些配置，可以灵活地调整 UnityHeapCrawler 的行为，以满足不同的内存分析需求。

UnityHeapCrawler Reflection based heap shapshot tool for Unity game engine 项目地址: https://gitcode.com/gh_mirrors/un/UnityHeapCrawler