NaughtyAttributes项目中实现运行时只读属性的技术方案

在Unity开发中，我们经常需要在编辑器模式下允许修改某些属性，但在游戏运行时将其设为只读状态。本文将探讨如何在NaughtyAttributes项目中实现这一功能，并分析相关技术细节。

需求分析

开发者在游戏开发中常遇到这样的场景：某些属性在编辑模式下需要可配置，但在游戏运行时需要锁定以防止意外修改。例如：

• 游戏配置参数在编辑时调整，运行时固定
• 计算属性在运行时显示但不允许修改
• 数组/列表在运行时锁定整个结构

基础实现方案

最简单的实现方式是创建一个自定义PropertyDrawer：

[CustomPropertyDrawer(typeof(RuntimeReadOnlyAttribute))]
public class RuntimeReadOnlyDrawer : PropertyDrawer
{
    public override void OnGUI(Rect position, SerializedProperty property, GUIContent label)
    {
        EditorGUI.BeginProperty(position, label, property);
        
        position = EditorGUI.PrefixLabel(position, GUIUtility.GetControlID(FocusType.Passive), label);

        using(new EditorGUI.DisabledScope(Application.isPlaying))
        {
            EditorGUI.PropertyField(position, property, GUIContent.none);
        }

        EditorGUI.EndProperty();
    }
}

这种实现虽然简单，但存在以下局限性：

1. 无法正确处理数组/列表的加减按钮
2. 不支持直接在属性上使用
3. 功能较为基础，缺乏灵活性

进阶实现方案

要实现更完善的运行时只读功能，需要考虑以下几个方面：

1. 编辑器级别控制

真正的解决方案需要在Editor层面实现，而不是简单的PropertyDrawer。通过继承UnityEditor.Editor类，可以更全面地控制整个Inspector的绘制过程。

2. 数组/列表处理

对于集合类型，需要特别处理其加减按钮和元素操作。这需要在OnInspectorGUI方法中统一控制，而不是单个属性的绘制。

3. 属性支持

Unity默认不支持直接在属性上使用自定义Drawer，需要通过[field: SerializeField]标记和特殊处理来实现。

4. 模式切换

除了简单的运行时/编辑时切换，还可以考虑更复杂的条件控制，如：

• 特定游戏状态下的只读
• 依赖其他属性值的条件只读
• 多场景下的差异化控制

替代方案比较

如果不想自行实现完整功能，可以考虑以下替代方案：

1. SaintsField项目：提供了[DisableIf]和[EnableIf]属性，支持编辑时/运行时切换，并能处理属性和集合类型。

2. Tri-Inspector项目：同样提供了类似功能，实现方式略有不同。

这些现成解决方案已经处理了大多数边缘情况，可以直接集成使用。

技术实现建议

如果决定在NaughtyAttributes中自行实现，建议参考以下架构：

1. 创建基础属性标记：

[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property)]
public class RuntimeReadOnlyAttribute : PropertyAttribute { }

2. 实现自定义Editor：

[CustomEditor(typeof(MonoBehaviour), true)]
public class RuntimeReadOnlyEditor : UnityEditor.Editor
{
    public override void OnInspectorGUI()
    {
        serializedObject.Update();
        
        SerializedProperty iterator = serializedObject.GetIterator();
        bool enterChildren = true;
        
        while (iterator.NextVisible(enterChildren))
        {
            enterChildren = false;
            
            var attr = GetRuntimeReadOnlyAttribute(iterator);
            using (new EditorGUI.DisabledScope(attr != null && Application.isPlaying))
            {
                EditorGUILayout.PropertyField(iterator, true);
            }
        }
        
        serializedObject.ApplyModifiedProperties();
    }
    
    private RuntimeReadOnlyAttribute GetRuntimeReadOnlyAttribute(SerializedProperty property)
    {
        // 实现属性查找逻辑
    }
}

3. 处理特殊情况：

• 嵌套对象处理
• 数组/列表操作
• 属性序列化

最佳实践

1. 明确使用场景：只对确实需要在运行时保护的数据使用此功能，避免过度使用影响开发效率。

2. 视觉区分：可以考虑在只读状态下改变显示颜色或样式，使状态更明显。

3. 文档说明：为团队提供清晰的文档，说明哪些属性会在运行时锁定及原因。

4. 性能考虑：反射操作会影响编辑器性能，应尽量减少属性查找的开销。

总结

实现一个完善的运行时只读属性系统需要考虑多方面因素，从简单的属性标记到复杂的编辑器控制。对于大多数项目，使用现有成熟解决方案可能是更高效的选择；而对于需要深度定制的场景，理解底层原理后自行实现也能获得更好的控制力。无论选择哪种方式，明确需求、设计清晰的架构都是成功实现的关键。