48、Unity 3D 开发：预处理器指令与异常处理

Unity 3D 开发：预处理器指令与异常处理

1. 预处理器指令概述

预处理器指令是一种用于启用或禁用代码块的系统，它有点像注释，但可以使用逻辑来绕过或启用代码块。Unity 3D 编辑器已经定义了许多指令，包括针对特定平台（如移动设备或控制台）启用的指令。

1.1 基本示例

以下是使用预处理器指令的基本步骤：
1. 打开 Chapter 7 Unity 项目中的 PreprocessorDirectives_Scene，找到附加到同名游戏对象的 PreprocessorDirectives 脚本。
2. 预处理器指令应放在文件的常规头部之上，使用 #define 后跟标识符来创建指令。
3. 指令的定义应在 using UnityEngine 和其他 using 语句之前，这样可以定义是否在文件中包含某些 using 语句。

示例代码如下：

#define TESTING
using UnityEngine;
// 其他 using 语句

public class PreprocessorDirectives : MonoBehaviour
{
    void Start()
    {
#if TESTING
        System.Diagnostics.Debug.WriteLine("DOT NET TEST");
#endif
    }
}

在 Visual Studio 中，点击“Attach to Unity”按钮或进入“Debug”菜单选择“Start Debugging”，然后回到 Unity 启动游戏。如果 #define TESTING 被注释掉，Visual Studio 的输出将被排除。

1.2 UNITY_EDITOR 指令

UNITY_EDITOR 指令仅在代码在编辑器中运行时定义。当游戏以独立模式或在移动设备上运行时，该指令不存在，因此任何 #if UNITY_EDITOR 预处理器指令内的代码将不会被编译到游戏中。

示例代码：

#if UNITY_EDITOR
    // 仅在编辑器中执行的代码
#endif

这可以在测试时加快速度，避免在每次启动游戏时更改数字，同时防止意外提交影响游戏最终发布的代码。

1.3 移动开发中的指令

在移动开发中，预处理器指令也非常有用。例如，在之前的练习中，使用 StreamWriter 向项目目录写入文件时，在移动设备上可能会遇到问题。

1.3.1 安卓设备开发者选项设置

如果使用安卓设备，需要启用开发者选项：
1. 打开设置。
2. 滚动到“System”（安卓 8 或更高版本）。
3. 滚动到“Build number”并点击 7 次。
4. 返回上一屏幕，会看到“Developer Options”。
5. 选择并启用“USB Debugging”。

1.3.2 移动平台代码处理

在移动平台上， System.IO.Directory.GetCurrentDirectory() 函数可能无法按预期工作。需要使用 Application.persistentDataPath 来获取正确的文件路径。

示例代码：

#if UNITY_ANDROID && !UNITY_EDITOR
    string path = Application.persistentDataPath + "/fileData.txt";
#else
    string path = System.IO.Directory.GetCurrentDirectory() + "/fileData.txt";
#endif

通过预处理器指令，可以将编辑器版本的函数与安卓版本的函数分开，使两者都能按预期运行。

1.4 警告指令

使用 #warning 可以在代码中添加提醒，当脚本被 Unity 3D 解释时，会在控制台显示警告信息。

示例代码：

#if TESTING
#warning TESTING MODE ACTIVE
#endif

警告信息可以是任何有意义的文本，并且应保持简短并使用全大写，这是一种常见的做法。

1.5 代码组织指令

#region 指令可以帮助组织代码，将代码折叠起来，便于查看和管理。

示例代码：

#region 初始化代码
// 初始化代码块
#endregion

在长类中明智地使用 #region 可以帮助观察变量之间的关系。

1.6 预处理器指令总结

预处理器指令可以基于类开头的单个 #define 来管理不同的代码块，常用于处理多平台开发，根据设备的型号或平台设置不同的屏幕分辨率等。

下面是预处理器指令使用的流程图：

graph TD;
    A[开始] --> B[定义指令];
    B --> C{是否满足条件};
    C -- 是 --> D[执行代码块];
    C -- 否 --> E[跳过代码块];
    D --> F[结束];
    E --> F;

2. Try Catch Finally 异常处理

2.1 异常处理概述

在开发过程中，处理少量警告（如未使用的变量）相对简单，但过多的警告可能会导致重要警告被忽略。因此，最好将警告数量保持在最低限度。在某些情况下，我们可能需要捕获特定的警告，以防止游戏崩溃或冻结。

2.2 基本示例

以下是一个简单的异常处理示例：

using UnityEngine;

public class TryCatchFinally : MonoBehaviour
{
    void DontUseTryCatch()
    {
        // 成功解析
        int i = int.Parse("1");
        Debug.Log("i is " + i);

        // 解析失败，游戏崩溃
        // int j = int.Parse("One");
    }

    void UseTryCatch()
    {
        try
        {
            int i = int.Parse("1");
            Debug.Log("i is " + i);

            int j = int.Parse("One"); // 解析失败
        }
        catch (Exception e)
        {
            Debug.Log("解析失败: " + e.Message);
            // 可以在这里处理异常，例如给变量赋默认值
        }
    }
}

在 UseTryCatch 方法中，使用 try-catch 模式可以防止错误输入导致游戏崩溃。 catch 块中的 (Exception e) 可以接收 try 块中抛出的异常，通过 e.Message 可以获取异常信息。

2.3 异常消息类型

Exception 是所有异常类型的通用捕获器，更具体的异常类型如 NullReferenceException 和 InvalidCastException 可以用于处理特定的异常情况。

2.4 异常处理应用

在 CheckExceptionType 函数中，可以检查不同类型的输入问题。例如，在将不同类型转换为 int 时，通常会抛出 InvalidCastException ；当捕获数组中的 null 时，会抛出 NullReferenceException 。

示例代码：

void CheckExceptionType()
{
    object[] objects = { "One", null, 1, new object() };
    foreach (object obj in objects)
    {
        try
        {
            int value = (int)obj;
            Debug.Log("转换成功: " + value);
        }
        catch (InvalidCastException e)
        {
            Debug.Log("无效转换: " + e.Message);
        }
        catch (NullReferenceException e)
        {
            Debug.Log("空引用异常: " + e.Message);
        }
    }
}

在场景中，有一个 InputText 字段，其文本会通过 TextInputChanged 函数进行处理，使用嵌套的 try-catch 块可以提供两种将字符串转换为整数值的方法。

void TextInputChanged(string text)
{
    try
    {
        int value = int.Parse(text);
        Debug.Log("整数值: " + value);
    }
    catch (FormatException)
    {
        try
        {
            float floatValue = float.Parse(text);
            int intValue = (int)floatValue;
            Debug.Log("浮点转换为整数: " + intValue);
        }
        catch (FormatException)
        {
            Debug.Log("输入无效，请输入数字。");
        }
    }
}

异常处理的流程图如下：

graph TD;
    A[开始] --> B[执行 try 块];
    B -- 成功 --> C[继续执行后续代码];
    B -- 失败 --> D[抛出异常];
    D --> E[捕获异常];
    E --> F[处理异常];
    F --> C;

通过预处理器指令和异常处理，开发者可以更好地管理代码，提高游戏的稳定性和可维护性。

3. 预处理器指令与异常处理的综合应用

3.1 综合应用场景分析

在实际的 Unity 3D 开发中，预处理器指令和异常处理往往需要结合使用，以应对复杂的开发需求。例如，在不同平台上进行数据读取和处理时，既要考虑平台差异（使用预处理器指令），又要处理可能出现的异常情况（使用异常处理）。

3.2 示例代码展示

以下是一个综合应用的示例代码，假设我们要从文件中读取数据，并且在不同平台上有不同的文件路径处理方式，同时要处理文件读取可能出现的异常：

using UnityEngine;
using System.IO;

public class CombinedExample : MonoBehaviour
{
    void Start()
    {
#if UNITY_EDITOR
        string filePath = System.IO.Directory.GetCurrentDirectory() + "/editorData.txt";
#elif UNITY_ANDROID
        string filePath = Application.persistentDataPath + "/androidData.txt";
#else
        string filePath = "defaultData.txt";
#endif

        try
        {
            string data = File.ReadAllText(filePath);
            Debug.Log("读取的数据: " + data);
        }
        catch (FileNotFoundException e)
        {
            Debug.Log("文件未找到: " + e.Message);
        }
        catch (IOException e)
        {
            Debug.Log("读取文件时发生 I/O 错误: " + e.Message);
        }
    }
}

在这个示例中，首先使用预处理器指令根据不同的平台确定文件路径，然后使用 try-catch 块来处理文件读取过程中可能出现的异常，如文件未找到或 I/O 错误。

3.3 综合应用的优势

• 提高代码的可维护性 ：通过预处理器指令将不同平台的代码分离，使得代码结构更加清晰，易于维护和扩展。
• 增强游戏的稳定性 ：使用异常处理可以捕获并处理可能出现的错误，避免游戏因异常情况而崩溃。

3.4 实际项目中的注意事项

• 指令的定义顺序 ：预处理器指令的定义应遵循一定的顺序，通常将 #define 语句放在类的顶部，避免在代码体中定义新的指令。
• 异常处理的粒度 ：在进行异常处理时，要根据具体情况选择合适的异常类型进行捕获，避免捕获过于宽泛的异常类型，导致难以定位问题。

4. 总结与展望

4.1 知识总结

本文主要介绍了 Unity 3D 开发中的预处理器指令和异常处理：
- 预处理器指令 ：用于启用或禁用代码块，可根据不同平台和开发环境进行代码的选择性编译，常见的指令有 #define 、 #if 、 #elif 、 #endif 等，还可以使用 #warning 和 #region 进行代码提醒和组织。
- 异常处理 ：使用 try-catch 模式可以捕获并处理代码中可能出现的异常，避免游戏因错误输入或其他异常情况而崩溃，不同的异常类型可以用于处理特定的异常情况。

4.2 应用建议

• 在多平台开发中，充分利用预处理器指令来处理不同平台的差异，提高代码的可移植性。
• 在处理用户输入或与外部资源交互时，使用异常处理来增强游戏的稳定性和健壮性。

4.3 未来发展趋势

随着 Unity 3D 技术的不断发展，预处理器指令和异常处理机制可能会更加完善和智能化。例如，可能会提供更多的预定义指令，以满足不同开发场景的需求；异常处理可能会与人工智能技术结合，实现自动诊断和修复异常的功能。

下面是综合应用的流程图：

graph TD;
    A[开始] --> B[使用预处理器指令确定平台];
    B --> C{是否为编辑器环境};
    C -- 是 --> D[设置编辑器文件路径];
    C -- 否 --> E{是否为安卓平台};
    E -- 是 --> F[设置安卓文件路径];
    E -- 否 --> G[设置默认文件路径];
    D --> H[尝试读取文件];
    F --> H;
    G --> H;
    H -- 成功 --> I[输出读取的数据];
    H -- 失败 --> J{是否为文件未找到异常};
    J -- 是 --> K[输出文件未找到信息];
    J -- 否 --> L[输出 I/O 错误信息];
    I --> M[结束];
    K --> M;
    L --> M;

通过掌握预处理器指令和异常处理的知识，开发者可以更好地应对 Unity 3D 开发中的各种挑战，提高开发效率和游戏质量。