使用Unity的Debug工具進行錯誤排查

發布於 2024/02/27 更新於 2024/09/09

作者 Ned Hsu 7 分鐘閱讀

在 Unity 中，使用 Debug 工具進行錯誤排查是一個常見且有效的方法，能夠幫助開發者快速定位和修復問題。Unity 提供了多種 Debug 工具和方法來分析代碼和遊戲運行時的行為。以下是使用 Unity 的 Debug 工具進行錯誤排查的詳細指南：

1. 使用 Console 窗口進行 Debug

Console 窗口概述

Unity 的 Console 窗口是查看錯誤、警告和 Debug 訊息的地方。
可以通過 Window > General > Console 打開 Console 窗口。
Console 窗口顯示以下三種類型的訊息：
- 錯誤（Error）： 表示代碼中存在錯誤，通常會阻止遊戲正常運行。
- 警告（Warning）： 提示潛在的問題或不推薦的做法，通常不會阻止遊戲運行。
- Debug 訊息（Log）： 開發者自定義的輸出信息，用於查看代碼運行狀態。

使用 Debug.Log() 方法

Debug.Log() 用於在 Console 窗口中輸出自定義信息。這對於跟踪程序運行狀態和變量值非常有用。

  
void Start()
{
    Debug.Log("遊戲開始！"); // 在 Console 窗口輸出 "遊戲開始！"
}

Debug.Log() 的變體：
- Debug.LogWarning()：輸出警告訊息，會以黃色顯示。
- Debug.LogError()：輸出錯誤訊息，會以紅色顯示。

  
void Update()
{
    if (playerHealth <= 0)
    {
        Debug.LogWarning("玩家血量過低！");
        Debug.LogError("遊戲結束，玩家死亡！");
    }
}

查看堆疊追蹤（Stack Trace）

當錯誤或警告發生時，Console 窗口會顯示該訊息的堆疊追蹤（Stack Trace），這有助於定位錯誤發生的位置。
點擊 Console 窗口中的錯誤或警告訊息，Unity 會自動打開相關的腳本並跳轉到引發錯誤的代碼行。

2. 使用斷點和 Visual Studio 進行 Debug

設置斷點（Breakpoint）

使用 Visual Studio 或 Rider 等 IDE 進行 Debug，可以更深入地分析代碼執行流程。
設置斷點：
- 在 Visual Studio 中，打開你要調試的腳本。
- 在需要調試的代碼行左側的行號區域點擊，即可設置斷點（Breakpoint）。

啟動 Debug 模式

連接 Unity 到 Visual Studio：
- 在 Unity 中，進入 Edit > Preferences > External Tools，選擇 External Script Editor 為 Visual Studio。
附加到 Unity 進程：
- 在 Visual Studio 中，選擇 Debug > Attach to Unity 或 Attach Unity Debugger，選擇正運行的 Unity 進程。
開始 Debug：
- 點擊 播放 按鈕開始遊戲運行，Unity 會在設置的斷點處暫停運行。
- 此時，可以檢查變量的值、執行步驟，並一步步進行代碼分析。

3. 使用 Debug.DrawLine() 和 Debug.DrawRay() 可視化檢查

這些方法允許在場景視圖中繪製線條和射線，以進行可視化 Debug，特別適合物理相關的錯誤排查。

Debug.DrawLine()

用於在場景中畫一條線段，從起點到終點，可以設置顏色和持續時間。

  
void Update()
{
    Vector3 startPoint = transform.position;
    Vector3 endPoint = transform.position + transform.forward * 10;
    Debug.DrawLine(startPoint, endPoint, Color.red, 2.0f); // 繪製一條紅色線段，持續2秒
}

Debug.DrawRay()

用於從指定起點沿指定方向畫一條射線。

  
void Update()
{
    Vector3 direction = transform.forward;
    Debug.DrawRay(transform.position, direction * 10, Color.green); // 繪製一條綠色射線
}

4. 使用 Profiler 分析性能問題

啟用 Profiler

打開 Profiler 窗口：Window > Analysis > Profiler。
Profiler 允許你監控 CPU、GPU、內存、渲染、物理、網路等多方面的性能數據。

使用 Profiler 排查性能問題

查看 CPU 使用率： 檢查哪些函數消耗了最多的 CPU 時間。找出性能瓶頸的代碼並進行優化。
查看內存使用情況： 分析內存使用情況，查找內存洩漏或不必要的內存分配。
分析 Garbage Collection (GC)： 檢查垃圾回收頻率和持續時間，減少不必要的垃圾生成。

5. 使用 Frame Debugger 分析渲染問題

啟用 Frame Debugger

打開 Frame Debugger 窗口：Window > Analysis > Frame Debugger。
點擊 Enable 按鈕開始 Debug。

使用 Frame Debugger 分析渲染管線

逐幀查看渲染步驟： 使用 Frame Debugger 可以逐幀查看每個渲染步驟（Draw Call），找出多餘的渲染操作或不必要的圖形效果。
排查渲染錯誤： 確認材質、光照和後期處理效果是否正常工作。

6. 使用 Unity Test Framework 進行單元測試

Unity Test Framework 允許編寫自動化測試來驗證代碼邏輯，確保功能正常。
測試腳本應放置在 Assets/Tests 目錄中。
使用 [Test] 屬性標記測試方法，使用 Assert 方法進行斷言測試結果。

  
using NUnit.Framework;

public class PlayerTests
{
    [Test]
    public void PlayerHealth_ShouldBeZero_WhenDamagedToDeath()
    {
        Player player = new Player();
        player.TakeDamage(100);
        Assert.AreEqual(0, player.health);
    }
}

總結

使用 Unity 的 Debug 工具可以有效排查錯誤和優化遊戲性能。通過 Console 窗口、斷點調試、可視化工具（如 DrawLine 和 DrawRay）、Profiler、Frame Debugger 和單元測試框架，可以全面分析和優化遊戲的各個方面，從而提高遊戲的質量和用戶體驗。

Software, Unity

Unity

本文章以 CC BY 4.0 授權