如何告诉我们的asp.net核心Web Api服务如何序列化枚举对象

Question

我们目前正在重写我们多年前编写的 API 服务。我们正在使用 .Net Core 2.1 和 MVC 对其进行更新。搜索后我无法弄清楚或找到一些扭结。最大的一个是客户发送的枚举，是枚举描述。无论出于何种原因，程序员都在每个描述（A、B、C、D...等）中添加了一个字母，因此许多客户将这些字母作为其有效的枚举发送。现在它不起作用。我们不能更改名称，因为它也在使用中。而且我不能手动转换它（据我所知），因为 MVC 负责为我们的控制器序列化对象。

示例

public enum RentCode
{
    [Description("")]
    None = 0,

    [Description("A")]
    Buying = 1,

    [Description("B")]
    Renting= 2,

    [Description("C")]
    Own = 3,

    [Description("D")]
    Land = 4
}

我怎样才能得到它，以便 MVC 在序列化对象时处理数字、枚举值和描述？

Answer 1

我使用扩展方法来实现：

  public static class EnumExtensions
        {
public static string GetDisplayName(this Enum enu)
        {
            var attr = GetDisplayAttribute(enu);
            return attr != null ? attr.Name : enu.ToString();
        }

        public static string GetDescription(this Enum enu)
        {
            var attr = GetDisplayAttribute(enu);
            return attr != null ? attr.Description : enu.ToString();
        }

    private static DisplayAttribute GetDisplayAttribute(object value)
            {
                Type type = value.GetType();
                if (!type.IsEnum)
                {
                    throw new ArgumentException(string.Format("Type {0} is not an enum", type));
                }

                // Get the enum field.
                var field = type.GetField(value.ToString());
                return field == null ? null : field.GetCustomAttribute<DisplayAttribute>();
            }
        }

我这样称呼它：

//status is an instance of the enum
myObject.StatusLabel = status.GetDisplayName();

我的枚举看起来像这样：

public enum Status
    {
    [Display(Name = "In Progress")]
            InProgress = 1,
            [Display(Name = "Complete")]
            Completed = 2
}