我有一个包含枚举属性的类,在使用JavaScriptSerializer序列化对象时,我的json结果包含枚举的整数值,而不是它的字符串“name”。有没有一种方法来获得枚举作为字符串在我的json而不必创建一个自定义JavaScriptConverter?也许有一个属性,我可以装饰枚举定义,或对象属性?

举个例子:

enum Gender { Male, Female }

class Person
{
    int Age { get; set; }
    Gender Gender { get; set; }
}

期望的JSON结果:

{ "Age": 35, "Gender": "Male" }

理想情况下,用内置的。net框架类来寻找答案,如果没有可能的替代方案(如Json.net)也是受欢迎的。


当前回答

这是一个老问题,但以防万一,我想我还是要发表一下。在我的项目中,我为任何Json请求使用单独的模型。模型通常具有与域对象相同的名称,并以“Json”为前缀。模型使用AutoMapper进行映射。通过让json模型声明一个在域类上是enum的字符串属性,AutoMapper将解析为它的字符串表示形式。

如果你想知道,我需要为Json序列化类单独的模型,因为内置的序列化器会提出循环引用,否则。

希望这能帮助到一些人。

其他回答

这个版本的Stephen的回答没有改变JSON中的名称:

[DataContract(
    Namespace = 
       "http://schemas.datacontract.org/2004/07/Whatever")]
class Person
{
    [DataMember]
    int Age { get; set; }

    Gender Gender { get; set; }

    [DataMember(Name = "Gender")]
    string GenderString
    {
        get { return this.Gender.ToString(); }
        set 
        { 
            Gender g; 
            this.Gender = Enum.TryParse(value, true, out g) ? g : Gender.Male; 
        }
    }
}

下面是一个简单的解决方案,它将服务器端c#枚举序列化为JSON,并使用结果填充客户端<select>元素。这适用于简单枚举和位标志枚举。

我已经包含了端到端解决方案,因为我认为大多数想要将c#枚举序列化为JSON的人也可能会使用它来填充<select>下拉列表。

是:

枚举例子

public enum Role
{
    None = Permission.None,
    Guest = Permission.Browse,
    Reader = Permission.Browse| Permission.Help ,
    Manager = Permission.Browse | Permission.Help | Permission.Customise
}

使用按位or生成权限系统的复杂枚举。所以你不能依赖于简单的索引[0,1,2..为enum的整数值。

服务器端- c#

Get["/roles"] = _ =>
{
    var type = typeof(Role);
    var data = Enum
        .GetNames(type)
        .Select(name => new 
            {
                Id = (int)Enum.Parse(type, name), 
                Name = name 
            })
        .ToArray();

    return Response.AsJson(data);
};

上面的代码使用NancyFX框架来处理Get请求。它使用Nancy的Response.AsJson()助手方法——但是不要担心,您可以使用任何标准的JSON格式化器,因为枚举已经被投射到一个简单的匿名类型,可以序列化。

生成的JSON

[
    {"Id":0,"Name":"None"},
    {"Id":2097155,"Name":"Guest"},
    {"Id":2916367,"Name":"Reader"},
    {"Id":4186095,"Name":"Manager"}
]

客户端- CoffeeScript

fillSelect=(id, url, selectedValue=0)->
    $select = $ id
    $option = (item)-> $ "<option/>", 
        {
            value:"#{item.Id}"
            html:"#{item.Name}"
            selected:"selected" if item.Id is selectedValue
        }
    $.getJSON(url).done (data)->$option(item).appendTo $select for item in data

$ ->
    fillSelect "#role", "/roles", 2916367

HTML之前

<select id="role" name="role"></select>

HTML后

<select id="role" name="role">
    <option value="0">None</option>
    <option value="2097155">Guest</option>
    <option value="2916367" selected="selected">Reader</option>
    <option value="4186095">Manager</option>
</select>

@Iggy回答设置JSON序列化c# enum字符串仅为ASP。NET (Web API等等)。

但是为了使它也适用于特殊的序列化,在开始类中添加以下内容(如Global。asax Application_Start)

//convert Enums to Strings (instead of Integer) globally
JsonConvert.DefaultSettings = (() =>
{
    var settings = new JsonSerializerSettings();
    settings.Converters.Add(new StringEnumConverter { CamelCaseText = true });
    return settings;
});

更多关于Json的信息。网络页面

此外,要让枚举成员序列化/反序列化特定文本,请使用

System.Runtime.Serialization.EnumMember

属性,像这样:

public enum time_zone_enum
{
    [EnumMember(Value = "Europe/London")] 
    EuropeLondon,

    [EnumMember(Value = "US/Alaska")] 
    USAlaska
}
        Person p = new Person();
        p.Age = 35;
        p.Gender = Gender.Male;
        //1.  male="Male";
        string male = Gender.Male.ToString();

        p.Gender = Gender.Female;

        //2.  female="Female";
        string female = Enum.GetName(typeof(Gender), p.Gender);

        JObject jobj = new JObject();
        jobj["Age"] = p.Age;
        jobj["Gender"] = male;
        jobj["Gender2"] = female;

        //you result:  josn= {"Age": 35,"Gender": "Male","Gender2": "Female"}
        string json = jobj.ToString();

一个稍微更经得起考验的选择

面对同样的问题,我们决定需要一个自定义版本的StringEnumConverter,以确保枚举值可以随着时间的推移而扩展,而不会在反序列化方面发生灾难性的破坏(参见下面的背景)。使用下面的SafeEnumConverter允许反序列化完成,即使有效负载包含没有命名定义的枚举的值,这更接近于int-to-enum转换的工作方式。

用法:

[SafeEnumConverter]
public enum Colors
{
    Red,
    Green,
    Blue,
    Unsupported = -1
}

or

[SafeEnumConverter((int) Colors.Blue)]
public enum Colors
{
    Red,
    Green,
    Blue
}

来源:

public class SafeEnumConverter : StringEnumConverter
{
    private readonly int _defaultValue;

    public SafeEnumConverter()
    {
        // if you've been careful to *always* create enums with `0` reserved
        // as an unknown/default value (which you should), you could use 0 here. 
        _defaultValue = -1;
    }

    public SafeEnumConverter(int defaultValue)
    {
        _defaultValue = defaultValue;
    }

    /// <summary>
    /// Reads the provided JSON and attempts to convert using StringEnumConverter. If that fails set the value to the default value.
    /// </summary>
    /// <returns>The deserialized value of the enum if it exists or the default value if it does not.</returns>
    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        try
        {
            return base.ReadJson(reader, objectType, existingValue, serializer);
        }
        catch
        {
            return Enum.Parse(objectType, $"{_defaultValue}");
        }
    }

    public override bool CanConvert(Type objectType)
    {
        return base.CanConvert(objectType) && objectType.GetTypeInfo().IsEnum;
    }
}

背景

当我们考虑使用StringEnumConverter时,我们遇到的问题是,当添加了一个新的enum值时,我们还需要被动式,但并不是每个客户端都能立即意识到新值。在这些情况下,与Newtonsoft JSON打包的StringEnumConverter抛出类似于“将SomeString值转换为EnumType类型错误”的JsonSerializationException,然后整个反序列化过程失败。这对我们来说是一个问题,因为即使客户端计划忽略/丢弃它不理解的属性值,它仍然需要能够反序列化剩余的有效负载!