Unity 将 Enum 转为中文选项

概述：

        制作UI控件、数据持久化时经常遇到将 Enum 转为汉字或传递至 Dropdown options 的困扰。使用本方案可一次性解决问题，无需在每次转换时写诸多重复代码。

        在声明 Enum 时，使用 Description 标签将中文标注添加到每个选项中，需要转换时采用Reflection 获取标签。

目标：

1. 将 Enum 当前值转为对应的中文，即实现 Enum.ToDescription()。
2. 将 Enum 所有选项传递至 Dropdown options，即实现 Dropdown.GetOptions(Type enumType)。

调用： 

using System.ComponentModel;
using TMPro;

//Enum 定义
public enum LampColor { 
    [Description("红色")] Red, 
    [Description("绿色")] Green, 
    [Description("蓝色")] Blue 
}

//调用类
public class DropdownManager : MonoBehaviour
{
    public TMP_Dropdown dropdown;
    public LampColor color;    

    void OnValidate() {
        dropdown = GetComponent<TMP_Dropdown>();

        //将 dropdown 的 options 更改为 红色、绿色、蓝色
        dropdown.GetOptions(typeof(LampColor));    
    }

    void Start() {
        string colorText = color.ToDescription();      
        Debug.Log("color:" + colorText); //输出:红色
    }

}

实现：

using System;
using System.Reflection;
using System.ComponentModel;
using System.Collections.Generic;
using TMPro;    

public static class EnumConverter {

    /// <summary>将 Enum 当前值转换为描述字符</summary>
    public static string ToDescription(this Enum value)
    {
        return EnumItemToDescription(value.GetType(), value.ToString());
    }

    /// <summary>将 Enum 选项传递至 Dropdown 选项</summary>
    public static void GetOptions(this TMP_Dropdown dropdown, Type enumType)
    {
        var descriptionList = new List<string>(GetEnumDescriptions(enumType));

        //将描述字符列表传递至 Dropdown 选项
        dropdown.options = descriptionList.ConvertAll<TMP_Dropdown.OptionData>(
            x => new TMP_Dropdown.OptionData(x)
        );
    }

    /// <summary>将 Enum 全部元素转换为描述字符</summary>
    public static string[] GetEnumDescriptions(Type enumType)
    {
        var descriptions = Enum.GetNames(enumType);
        for (int i = 0; i < descriptions.Length; i++)
        {
            descriptions[i] = EnumItemToDescription(enumType, descriptions[i]);
        }
        return descriptions;
    }

    //将 Enum 类型的某个选项转为描述字符
    private static string EnumItemToDescription(Type enumType, string optionName)
    {
        FieldInfo fieldInfo = enumType.GetField(optionName);
        
        //GetCustomAttributes 比 GetCustomAttribute 更快 
        //见https://github.com/dotnet/runtime/issues/44713
        DescriptionAttribute[] attributes =
            fieldInfo.GetCustomAttributes<DescriptionAttribute>(false)
            as DescriptionAttribute[];
        return attributes.Length > 0 ? attributes[0].Description : optionName;
    }
}

注意：

        由于使用了 Reflection，上述方法执行速度要比普通方法慢数百倍。按需单次调用不会造成可查觉的效能损耗，不建议每帧调用。