Unity C#高级特性 Partial 详细使用案例

文章目录

      • 实例 1:分隔UI逻辑
      • 实例 2:Unity编辑器自动生成代码
      • 实例 3:数据模型分割
      • 实例 4:序列化扩展
      • 实例 5:多视图架构
      • 实例 6:Unity编辑器自定义 inspectors

在Unity中,部分类(Partial Classes)是C#语言中的一个特性,它允许我们将一个类的定义分散到多个文件中。这意味着你可以在不同文件中为同一个类编写代码,编译器会自动将这些分散的部分合并成一个完整的类。

作用和优势:

  1. 代码组织性增强:对于大型项目或自动生成的代码(如Unity编辑器生成的MonoBehaviour脚本),可以使用partial classes将手动编写的逻辑与自动生成的代码分开。
  2. 团队协作:不同开发人员可以分别处理同一类的不同部分,而不会相互干扰。
  3. 保持自动生成代码的完整性:当你需要向由工具生成的类添加额外功能时,无需直接修改原始生成的代码,避免被后续工具更新覆盖。

5个实例说明:

实例 1:分隔UI逻辑

// File: MyScript.cs
partial class MyScript : MonoBehaviour
{
    public void CustomMethod()
    {
        Debug.Log("Custom method called.");
    }
}

// File: MyScript.UI.cs
// Unity不自动生成此部分,这是开发者自己添加的用于处理UI事件的代码
partial class MyScript : MonoBehaviour
{
    public void OnButtonClick()
    {
        CustomMethod();
    }
}

在这个例子中,MyScript 类的一部分用于实现通用游戏逻辑,另一部分专门处理UI事件。

实例 2:Unity编辑器自动生成代码

// File: AutoGenerated.cs (由Unity编辑器自动生成)
partial class MyPlayerController : MonoBehaviour
{
    private void Update()
    {
        // 自动化生成的运动逻辑...
    }
}

// File: MyPlayerController.cs
partial class MyPlayerController : MonoBehaviour
{
    public void PlayerJump()
    {
        // 开发者添加的跳跃功能实现...
    }

    [SerializeField] private float speed;
    private void FixedUpdate()
    {
        // 手动编写的物理移动逻辑...
    }
}

在此案例中,MyPlayerController 的一部分是Unity编辑器根据组件设置自动生成的,而另一部分则包含开发者手动添加的功能。

实例 3:数据模型分割

// File: GameData.cs
partial class GameData
{
    public int Health { get; set; }
    public int Mana { get; set; }
}

// File: GameData_Stats.cs
partial class GameData
{
    public int Strength { get; set; }
    public int Agility { get; set; }
    public int Intelligence { get; set; }
}

这里将游戏角色的数据模型属性分成两部分来管理,便于维护。

实例 4:序列化扩展

// File: SerializedData.cs (Unity编辑器生成)
[Serializable]
partial class SerializedData
{
    public string AutoGeneratedField;
}

// File: SerializedData_Custom.cs
[Serializable]
partial class SerializedData
{
    [HideInInspector] public List<Item> Inventory;
    public CustomData CustomSerializedData;
}

在这个例子中,Unity可能会为某个脚本生成一些默认字段,而开发者可以扩展该类,添加自己的可序列化的字段。

实例 5:多视图架构

// File: GameObjectModel.cs
partial class GameObjectModel
{
    public string Name { get; set; }
    public Vector3 Position { get; set; }
}

// File: GameObjectView.cs
partial class GameObjectModel
{
    public void UpdatePositionInScene()
    {
        // 更新场景中的对象位置...
    }
}

在复杂的应用场景下,类的部分可能专注于数据结构,而其他部分则关注于如何操作或展示这些数据(如视图层逻辑)。虽然这不是Unity典型的用法,但在某些架构设计中可能会这样划分。

注意:在Unity的实际使用中,由于MonoBehaviour的工作方式,将MonoBehaviour类分为多个部分的情况相对较少见,但确实可以用于组织代码。而在非Unity相关的C#应用中,partial classes的用途更为广泛。

实例 6:Unity编辑器自定义 inspectors

在Unity中,有时我们会为MonoBehaviour类编写自定义的Editor脚本来定制Inspector界面。这时,可以将MonoBehaviour的业务逻辑和Inspector相关逻辑分开到不同的partial class中。

// File: MyCustomComponent.cs
[RequireComponent(typeof(Collider2D))]
partial class MyCustomComponent : MonoBehaviour
{
    [SerializeField] private float speed;
    public int Health { get; set; }

    // 业务逻辑方法
    private void FixedUpdate()
    {
        transform.position += Vector3.right * speed * Time.fixedDeltaTime;
    }
}

// File: MyCustomComponent_Editor.cs
[CustomEditor(typeof(MyCustomComponent))]
public class MyCustomComponentEditor : Editor
{
    private SerializedProperty _speedProp;
    private SerializedProperty _healthProp;

    private void OnEnable()
    {
        _speedProp = serializedObject.FindProperty("speed");
        _healthProp = serializedObject.FindProperty("Health");
    }

    public override void OnInspectorGUI()
    {
        serializedObject.Update();

        EditorGUILayout.PropertyField(_speedProp);
        EditorGUILayout.IntSlider(_healthProp, 0, 100, new GUIContent("Health"));

        serializedObject.ApplyModifiedProperties();
    }
}

在这个例子中,MyCustomComponent 是一个MonoBehaviour,其核心功能(如运动逻辑)在第一个文件中定义。而在第二个文件 MyCustomComponent_Editor.cs 中,我们创建了一个自定义编辑器来调整Inspector展示方式,虽然这不是严格意义上的partial class,但是体现了对同一组件的不同方面进行模块化处理的思想。

通过这些实例,我们可以看到C#的partial classes特性在Unity项目中的多种应用场景,它有助于代码组织、团队协作以及保持与Unity编辑器自动生成代码的良好兼容性。

python推荐学习汇总连接:
50个开发必备的Python经典脚本(1-10)

50个开发必备的Python经典脚本(11-20)

50个开发必备的Python经典脚本(21-30)

50个开发必备的Python经典脚本(31-40)

50个开发必备的Python经典脚本(41-50)
————————————————

​最后我们放松一下眼睛
在这里插入图片描述

你可能感兴趣的:(unity,游戏引擎,c#)