4.8 自定义组件 (Custom Component)

文档摘要

4.8 自定义组件 (Custom Component) 4.8 自定义组件 (Custom Component) 在Unity3D的世界中，组件（Component）是构成游戏对象（GameObject）行为和属性的基础模块。Unity引擎内置了丰富的组件，例如Transform、Renderer、Collider、Rigidbody等等，它们赋予游戏对象各种各样的功能。然而，在实际的游戏开发中，我们经常需要创建自定义组件来满足项目特定的需求，实现独特的游戏逻辑和交互。自定义组件是Unity引擎强大扩展性的核心体现，它允许开发者根据项目需求量身定制功能模块，极大地提升了开发效率和代码的可维护性。 4.8.1 什么是自定义组件？

4.8 自定义组件 (Custom Component)

4.8 自定义组件 (Custom Component)

在Unity3D的世界中，组件（Component）是构成游戏对象（GameObject）行为和属性的基础模块。Unity引擎内置了丰富的组件，例如Transform、Renderer、Collider、Rigidbody等等，它们赋予游戏对象各种各样的功能。然而，在实际的游戏开发中，我们经常需要创建自定义组件来满足项目特定的需求，实现独特的游戏逻辑和交互。自定义组件是Unity引擎强大扩展性的核心体现，它允许开发者根据项目需求量身定制功能模块，极大地提升了开发效率和代码的可维护性。

4.8.1 什么是自定义组件？

简单来说，自定义组件就是我们自己编写的脚本，继承自Unity提供的基类，并附加到游戏对象上，从而赋予该游戏对象特定的行为和属性。自定义组件本质上是C#脚本，利用Unity提供的API，我们可以访问和操控游戏对象的Transform、Renderer、Collider等其他组件，以及Unity引擎的各种系统功能，例如输入、物理、动画、UI等等。

自定义组件的核心作用：

封装游戏逻辑: 将游戏对象特定的行为逻辑封装在一个独立的组件中，提高代码的模块化和可重用性。
扩展Unity编辑器功能: 通过自定义组件，我们可以扩展Unity编辑器Inspector面板的功能，自定义属性的显示和编辑方式，提升开发效率。
实现复杂的游戏机制: 自定义组件是构建复杂游戏机制的基础，例如角色控制、AI行为、物品系统、任务系统等等。
提高代码可维护性: 良好的组件化设计可以降低代码的耦合度，提高代码的可读性和可维护性，方便团队协作和后期维护。

4.8.2 创建你的第一个自定义组件

创建自定义组件非常简单，只需在Unity项目中创建一个新的C#脚本，并继承 MonoBehaviour 类即可。MonoBehaviour 是Unity脚本的基类，所有自定义组件都必须直接或间接继承自它。

步骤 1：创建C#脚本

在Unity的Project窗口中，右键点击你想要存放脚本的文件夹（例如 "Scripts" 文件夹），选择 "Create" -> "C# Script"。为你的脚本命名，例如 "MyCustomComponent"。

步骤 2：编写脚本代码

双击创建的 "MyCustomComponent.cs" 脚本，Unity将使用你配置的代码编辑器打开脚本文件。默认情况下，脚本内容如下：


using UnityEngine;
public class MyCustomComponent : MonoBehaviour
{
    // Start is called before the first frame update
    void Start()
    {
    }
    // Update is called once per frame
    void Update()
    {
    }
}

代码解释：

using UnityEngine;: 引入 Unity 引擎的命名空间，使我们可以使用 Unity 提供的各种类和方法。
public class MyCustomComponent : MonoBehaviour: 定义一个名为 MyCustomComponent 的公共类，并继承自 MonoBehaviour 类。public 关键字表示该组件可以在Unity编辑器中被访问和使用。
void Start(): Start() 方法是 Unity 的生命周期函数之一，在组件第一次被激活时调用（例如游戏对象被实例化或场景加载时）。我们可以在 Start() 方法中进行组件的初始化操作。
void Update(): Update() 方法是 Unity 的生命周期函数之一，在每一帧渲染之前调用。我们可以在 Update() 方法中编写需要每帧执行的代码，例如游戏逻辑的更新、输入检测等等。

步骤 3：将组件添加到游戏对象

在Unity编辑器中，选择一个游戏对象（例如场景中的一个 Cube），然后将 "MyCustomComponent.cs" 脚本拖拽到该游戏对象的 Inspector 面板中。或者，你也可以在 Inspector 面板中点击 "Add Component" 按钮，然后在 "Scripts" 分类下找到并添加 "MyCustomComponent" 组件。

现在，你已经成功创建并将第一个自定义组件添加到了游戏对象上！虽然目前这个组件还没有任何具体的功能，但它已经具备了组件的基本结构。

4.8.3 自定义组件的核心元素

一个实用的自定义组件通常包含以下核心元素：

公共变量 (Public Variables): 用于在Inspector面板中暴露可编辑的属性，允许我们在编辑器中调整组件的行为和参数，无需修改代码。
私有变量 (Private Variables): 用于组件内部的数据存储，外部无法直接访问和修改，保证数据的封装性和安全性。
公共方法 (Public Methods): 用于提供组件的功能接口，允许其他组件或脚本调用，实现组件之间的交互和协作。
私有方法 (Private Methods): 用于组件内部的逻辑实现，外部无法直接调用，提高代码的模块化和可维护性。
Unity 生命周期函数 (Lifecycle Functions): 例如 Start(), Update(), Awake(), OnEnable(), OnDisable(), OnDestroy() 等，用于在组件的不同生命周期阶段执行特定的代码。
属性 (Attributes): 用于修饰变量和方法，控制它们在Inspector面板中的显示和行为，例如 SerializeField, Header, Range, Tooltip 等。

4.8.4 公共变量与 Inspector 面板

公共变量是自定义组件与Unity编辑器交互的重要桥梁。当我们声明一个公共变量时，Unity会自动在 Inspector 面板中为该变量创建一个可编辑的字段。

示例代码：


using UnityEngine;
public class MovementController : MonoBehaviour
{
    public float moveSpeed = 5f; // 公共变量，控制移动速度
    void Update()
    {
        float horizontalInput = Input.GetAxis("Horizontal");
        float verticalInput = Input.GetAxis("Vertical");
        Vector3 movement = new Vector3(horizontalInput, 0f, verticalInput) * moveSpeed * Time.deltaTime;
        transform.Translate(movement);
    }
}

代码解释：

public float moveSpeed = 5f;: 声明一个公共的浮点型变量 moveSpeed，并初始化为 5f。
在 Update() 方法中，我们使用 moveSpeed 变量来控制游戏对象移动的速度。

实践步骤：

创建一个新的 C# 脚本，命名为 "MovementController"，并将代码复制到脚本中。
创建一个 3D Object (例如 Cube) 并添加 "MovementController" 组件。
在 Inspector 面板中，你会看到 "Move Speed" 字段，它的默认值为 5。
运行游戏，使用键盘的 "A" "D" "W" "S" 键控制 Cube 移动。
在游戏运行时，修改 Inspector 面板中的 "Move Speed" 值，观察 Cube 移动速度的变化。

SerializeField 属性

默认情况下，只有 public 类型的变量会在 Inspector 面板中显示。如果你想在 Inspector 面板中显示 private 类型的变量，可以使用 SerializeField 属性。

示例代码：


using UnityEngine;
public class HealthSystem : MonoBehaviour
{
    [SerializeField] private int maxHealth = 100; // 私有变量，但会在 Inspector 面板中显示
    private int currentHealth;
    void Start()
    {
        currentHealth = maxHealth;
    }
    public void TakeDamage(int damageAmount)
    {
        currentHealth -= damageAmount;
        Debug.Log("Damage taken: " + damageAmount + ", Current Health: " + currentHealth);
        if (currentHealth <= 0)
        {
            Die();
        }
    }
    private void Die()
    {
        Debug.Log("GameObject Died!");
        Destroy(gameObject); // 销毁游戏对象
    }
}

代码解释：

[SerializeField] private int maxHealth = 100;: 使用 [SerializeField] 属性修饰了私有变量 maxHealth，使其在 Inspector 面板中可见和可编辑。

实践步骤：

创建一个新的 C# 脚本，命名为 "HealthSystem"，并将代码复制到脚本中。
创建一个 3D Object (例如 Cube) 并添加 "HealthSystem" 组件。
在 Inspector 面板中，你会看到 "Max Health" 字段，即使 maxHealth 变量是 private 的。
创建另一个 C# 脚本，命名为 "DamageDealer"，代码如下：


using UnityEngine;
public class DamageDealer : MonoBehaviour
{
    public int damageAmount = 20;
    void OnTriggerEnter(Collider other)
    {
        HealthSystem healthSystem = other.GetComponent<HealthSystem>();
        if (healthSystem != null)
        {
            healthSystem.TakeDamage(damageAmount);
        }
    }
}

创建另一个 3D Object (例如 Sphere)，添加 "DamageDealer" 组件，并为其添加 Collider 组件 (例如 Sphere Collider) 并设置为 Is Trigger。
将 Sphere 移动到 Cube 的 Collider 范围内，观察 Console 窗口的输出和 Cube 的 Inspector 面板中 "Max Health" 值的变化 (虽然 "Max Health" 值不会直接显示当前血量，但你可以通过 Debug.Log 输出 currentHealth 来观察)。

其他常用的 Inspector 属性

Unity 提供了丰富的属性来定制 Inspector 面板的显示效果和用户体验，常用的属性包括：

[Header("Section Name")]: 为 Inspector 面板添加一个标题分割线，用于组织相关的属性。
[Tooltip("Tooltip Text")]: 为属性添加鼠标悬停提示文本，提供更详细的说明。
[Range(min, max)]: 限制数值类型属性的取值范围，并显示滑动条。
[Space(pixels)]: 在 Inspector 面板中添加垂直间距，调整布局。
[ColorUsage(true, true)]: 允许颜色属性选择 HDR 颜色。
[Multiline(lines)]: 允许字符串属性显示多行文本框。
[TextArea(minLines, maxLines)]: 允许字符串属性显示可调整大小的多行文本区域。

示例代码 (展示多种属性应用):


using UnityEngine;
public class InspectorCustomizationExample : MonoBehaviour
{
    [Header("Movement Settings")] // 添加标题
    [Tooltip("移动速度")]        // 添加提示文本
    [Range(1f, 10f)]         // 限制范围和滑动条
    public float speed = 5f;
    [Header("Color Settings")]
    [ColorUsage(true, true)] // 允许 HDR 颜色
    public Color objectColor = Color.white;
    [Header("Description")]
    [Multiline(3)]         // 多行文本框
    public string description = "This is a multiline text area for description.";
    [Header("Notes")]
    [TextArea(5, 10)]      // 可调整大小的文本区域
    public string notes = "This is a text area for notes.";
    void Start()
    {
        GetComponent<Renderer>().material.color = objectColor;
    }
}

实践步骤：

创建一个新的 C# 脚本，命名为 "InspectorCustomizationExample"，并将代码复制到脚本中。
创建一个 3D Object (例如 Cube) 并添加 "InspectorCustomizationExample" 组件。
观察 Inspector 面板，你会看到各种属性修饰效果，尝试调整它们的值，观察 Cube 的变化。

4.8.5 Unity 生命周期函数详解

Unity 生命周期函数是自定义组件的核心组成部分，它们定义了组件在不同阶段的行为。掌握这些生命周期函数对于编写高效、稳定的自定义组件至关重要。

常用的生命周期函数:

函数名	调用时机	作用
`Awake()`	组件被实例化后立即调用 (在 `Start()` 之前)	初始化组件，例如获取其他组件的引用，进行数据初始化等。
`OnEnable()`	组件被启用时调用 (例如 GameObject 被激活或组件被启用)	执行组件启用时的操作，例如注册事件监听器，启动协程等。
`Start()`	组件第一次被激活时调用 (在第一帧 `Update()` 之前)	初始化组件，通常用于执行只需要在组件启动时执行一次的操作。
`Update()`	每一帧渲染之前调用	主要的游戏逻辑更新函数，例如处理输入、更新游戏状态、控制动画等。
`LateUpdate()`	每一帧 `Update()` 执行之后调用	用于在所有 `Update()` 完成后执行的操作，例如相机跟随、平滑移动等，确保在所有物体移动后再更新相机位置。
`FixedUpdate()`	固定时间间隔调用 (与帧率无关，通常用于物理计算)	用于物理相关的更新，例如Rigidbody的移动、碰撞检测等，确保物理模拟的稳定性和一致性。
`OnDisable()`	组件被禁用时调用 (例如 GameObject 被禁用或组件被禁用)	执行组件禁用时的清理操作，例如注销事件监听器，停止协程等。
`OnDestroy()`	组件被销毁时调用 (例如 GameObject 被销毁或场景卸载)	执行组件销毁前的清理操作，释放资源，避免内存泄漏等。

生命周期函数执行顺序 (Graph TD 图):

图表解释：

Scene Load / GameObject Instantiate: 场景加载或游戏对象实例化时，生命周期开始。
Awake -> OnEnable -> Start: 组件初始化阶段，按照 Awake(), OnEnable(), Start() 的顺序执行。
Frame Loop (帧循环): Update(), LateUpdate(), FixedUpdate() 在每一帧循环中被调用，其中 FixedUpdate() 的调用频率与帧率无关，由物理引擎控制。
GameObject Disable / Component Disable: 游戏对象或组件被禁用时，调用 OnDisable()。
GameObject Destroy / Scene Unload: 游戏对象被销毁或场景卸载时，先调用 OnDisable(), 然后调用 OnDestroy()。

代码示例 (展示生命周期函数的使用):


using UnityEngine;
public class LifecycleExample : MonoBehaviour
{
    void Awake()
    {
        Debug.Log("Awake() is called");
    }
    void OnEnable()
    {
        Debug.Log("OnEnable() is called");
    }
    void Start()
    {
        Debug.Log("Start() is called");
    }
    void FixedUpdate()
    {
        //Debug.Log("FixedUpdate() is called"); // 每帧输出会很多，注释掉
    }
    void Update()
    {
        //Debug.Log("Update() is called"); // 每帧输出会很多，注释掉
    }
    void LateUpdate()
    {
        //Debug.Log("LateUpdate() is called"); // 每帧输出会很多，注释掉
    }
    void OnDisable()
    {
        Debug.Log("OnDisable() is called");
    }
    void OnDestroy()
    {
        Debug.Log("OnDestroy() is called");
    }
}

实践步骤：

创建一个新的 C# 脚本，命名为 "LifecycleExample"，并将代码复制到脚本中。
创建一个 3D Object (例如 Cube) 并添加 "LifecycleExample" 组件。
运行游戏，观察 Console 窗口的输出，了解 Awake(), OnEnable(), Start() 的调用顺序。
在游戏运行时，禁用 Cube 游戏对象 (在 Inspector 面板中取消勾选 GameObject 左侧的复选框)，观察 OnDisable() 的调用。
停止游戏，或者销毁 Cube 游戏对象，观察 OnDestroy() 的调用。
取消注释 FixedUpdate(), Update(), LateUpdate() 中的 Debug.Log 代码，再次运行游戏，观察这些函数在帧循环中的调用。

4.8.6 组件间的通信与交互

自定义组件通常不是孤立存在的，它们需要与其他组件进行通信和交互，共同完成复杂的游戏功能。 Unity 提供了多种组件通信的方式：

GetComponent(): 获取同一游戏对象上其他组件的引用。
GetComponentInChildren() / GetComponentInParent(): 获取子物体或父物体上组件的引用。
BroadcastMessage() / SendMessage(): 向同一游戏对象或其子物体发送消息 (方法调用)。
事件 (Events) 和委托 (Delegates): 实现组件间的松耦合通信，更灵活的事件驱动机制。
单例模式 (Singleton Pattern): 创建全局唯一的管理器组件，方便其他组件访问全局数据和功能。
Scriptable Objects: 用于存储共享数据，组件可以通过引用 Scriptable Objects 来访问和修改数据。

示例代码 (GetComponent() 的使用):


using UnityEngine;
public class ColorChanger : MonoBehaviour
{
    public Color targetColor = Color.red;
    void Start()
    {
        Renderer renderer = GetComponent<Renderer>(); // 获取 Renderer 组件
        if (renderer != null)
        {
            renderer.material.color = targetColor;
        }
        else
        {
            Debug.LogError("Renderer component not found on GameObject: " + gameObject.name);
        }
    }
}

代码解释：

Renderer renderer = GetComponent<Renderer>();: 使用 GetComponent<Renderer>() 方法获取当前游戏对象上的 Renderer 组件的引用。
代码检查 renderer 是否为 null，以避免空引用异常。
如果成功获取到 Renderer 组件，则修改其材质的颜色为 targetColor。

实践步骤：

创建一个新的 C# 脚本，命名为 "ColorChanger"，并将代码复制到脚本中。
创建一个 3D Object (例如 Cube) 并添加 "ColorChanger" 组件。
确保 Cube 游戏对象上已经有 Renderer 组件 (默认情况下，创建 3D Object 会自动添加)。
在 "Color Changer" 组件的 Inspector 面板中，修改 "Target Color" 的值。
运行游戏，观察 Cube 的颜色是否变为你设置的颜色。

示例代码 (BroadcastMessage() 的使用):


using UnityEngine;
public class MessageReceiver : MonoBehaviour
{
    public void HandleMessage(string message) // 接收消息的方法
    {
        Debug.Log("Message received by " + gameObject.name + ": " + message);
    }
}


using UnityEngine;
public class MessageSender : MonoBehaviour
{
    public string messageToSend = "Hello from Message Sender!";
    void Update()
    {
        if (Input.GetKeyDown(KeyCode.Space)) // 按下空格键发送消息
        {
            BroadcastMessage("HandleMessage", messageToSend); // 发送消息
        }
    }
}

代码解释：

MessageReceiver.cs: 定义了一个 HandleMessage() 方法，用于接收消息。
MessageSender.cs: 在 Update() 方法中检测空格键按下事件，按下空格键时调用 BroadcastMessage("HandleMessage", messageToSend) 方法。
BroadcastMessage() 方法会将消息 "HandleMessage" 和参数 messageToSend 发送到当前游戏对象及其所有子物体上，并调用所有接收者组件的 HandleMessage() 方法 (如果存在)。

实践步骤：

创建两个新的 C# 脚本，分别命名为 "MessageReceiver" 和 "MessageSender"，并将代码复制到脚本中。
创建一个空 GameObject，命名为 "MessageTest"。
在 "MessageTest" 下创建两个子物体 (例如 Cube 和 Sphere)。
将 "MessageReceiver" 组件添加到 Cube 和 Sphere 上。
将 "MessageSender" 组件添加到 "MessageTest" 上。
运行游戏，按下空格键，观察 Console 窗口的输出，可以看到 Cube 和 Sphere 都接收到了消息。

4.8.7 自定义组件的最佳实践

编写高质量的自定义组件需要遵循一些最佳实践，以提高代码的可读性、可维护性、可重用性和性能。

单一职责原则 (SRP): 每个组件应该只负责一个明确的功能，避免组件功能过于臃肿和复杂。
高内聚低耦合: 组件内部的代码应该高度内聚，完成自身的功能，组件之间应该尽量低耦合，减少依赖关系。
清晰的命名规范: 使用有意义的类名、变量名、方法名，提高代码的可读性。
代码注释: 为重要的代码段添加注释，解释代码的功能和逻辑，方便理解和维护。
属性的使用: 合理使用 Inspector 属性，定制 Inspector 面板，提高开发效率和用户体验。
生命周期函数的合理使用: 在合适的生命周期函数中执行相应的操作，避免在 Update() 中执行不必要的计算。
性能优化: 避免在 Update() 中执行耗时的操作，例如频繁的 GetComponent() 调用、复杂的计算等。可以考虑使用缓存、对象池等技术进行性能优化。
错误处理: 添加必要的错误处理代码，例如空引用检查、异常捕获等，提高代码的健壮性。
代码版本控制: 使用版本控制系统 (例如 Git) 管理代码，方便团队协作和代码回溯。

4.8.8 总结与展望

自定义组件是 Unity3D 引擎的核心功能之一，它赋予开发者强大的扩展能力，可以构建各种各样复杂而独特的游戏系统和功能。本章节我们深入探讨了自定义组件的各个方面，从基础概念到高级应用，包括组件的创建、核心元素、Inspector 面板定制、生命周期函数、组件通信以及最佳实践。

掌握自定义组件的开发技巧，将极大地提升你在 Unity3D 游戏开发中的能力和效率。希望本章节的内容能够帮助你更好地理解和应用自定义组件，创造出更加精彩的游戏作品！

未来展望:

随着 Unity 引擎的不断发展，自定义组件的功能和应用场景也将越来越丰富。例如，Unity 的 ECS (Entity Component System) 架构更加强调组件化的设计思想，将数据和逻辑完全分离，利用高性能的数据处理方式，可以构建更加复杂和高性能的游戏世界。学习和掌握自定义组件的开发，将为你迎接未来的 Unity 技术挑战打下坚实的基础。

作者与出处

原作者：灏天文库

来源：灏天文库

原文： https://aiknowledge.cn/collection/221-unity3d%E6%B8%B8%E6%88%8F%E5%BC%80%E5%8F%91%E5%AE%9E%E6%88%98%E6%95%99%E7%A8%8B

整理：灏天文库整理

由灏天文库平台收录，内容或由平台用户上传，仅供学习交流