.NET - 枚举的jSON序列化为字符串

Question

我有一个包含enum属性的类,在使用时序列化对象时JavaScriptSerializer,我的json结果包含枚举的整数值而不是它的string"name".有没有办法让枚举作为string我的json而不必创建自定义JavaScriptConverter？也许有一个属性,我可以装饰enum定义,或对象属性,？

举个例子:

enum Gender { Male, Female }

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

期望的json结果:

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

Answer 1

我发现Json.NET提供了我正在寻找的具有StringEnumConverter属性的确切功能:

using Newtonsoft.Json;
using Newtonsoft.Json.Converters;

[JsonConverter(typeof(StringEnumConverter))]
public Gender Gender { get; set; }

有关StringEnumConverter文档的更多详细信息.

Answer 2

没有你可以使用的特殊属性.JavaScriptSerializer序列化enums为其数值而不是其字符串表示形式.您需要使用自定义序列化来序列化enum其名称而不是数值.

编辑: 正如@OmerBakhari所指出的那样,JSON.net涵盖了这个用例(通过属性JavaScriptSerializer)以及许多其他内部.net序列化程序无法处理的用例.这是一个比较序列化器的特性和功能的链接.

Answer 3

将以下内容添加到您的global.asax中,以便将c#enum的JSON序列化作为字符串

  HttpConfiguration config = GlobalConfiguration.Configuration;
            config.Formatters.JsonFormatter.SerializerSettings.Formatting =
                Newtonsoft.Json.Formatting.Indented;

            config.Formatters.JsonFormatter.SerializerSettings.Converters.Add
                (new Newtonsoft.Json.Converters.StringEnumConverter());

Answer 4

@Iggy的答案将c#enum的JSON序列化设置为仅用于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.NET页面的更多信息

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

System.Runtime.Serialization.EnumMember

属性,像这样:

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

    [EnumMember(Value = "US/Alaska")] 
    USAlaska
}

Answer 5

我无法像最终答案(@ob.)那样更改源模型,我不想像@Iggy那样全局注册.所以我结合/sf/answers/200929431/和@ Iggy的/sf/answers/1270705971/,允许在SerializeObject命令本身期间设置字符串枚举转换器:

Newtonsoft.Json.JsonConvert.SerializeObject(
    objectToSerialize, 
    Newtonsoft.Json.Formatting.None, 
    new Newtonsoft.Json.JsonSerializerSettings()
    {
        Converters = new List<Newtonsoft.Json.JsonConverter> {
            new Newtonsoft.Json.Converters.StringEnumConverter()
        }
    })

Answer 6

Omer Bokhari和uri的答案的结合是我的解决方案,因为我想提供的价值通常与我在枚举中的价值不同,特别是如果我需要,我希望能够更改我的枚举.

所以,如果有人有兴趣,它是这样的:

public enum Gender
{
   [EnumMember(Value = "male")] 
   Male,
   [EnumMember(Value = "female")] 
   Female
}

class Person
{
    int Age { get; set; }
    [JsonConverter(typeof(StringEnumConverter))]
    Gender Gender { get; set; }
}

Answer 7

这是很容易通过添加完成ScriptIgnore属性的Gender属性,使其不被序列化,并增加了GenderString其性能确实得到连载:

class Person
{
    int Age { get; set; }

    [ScriptIgnore]
    Gender Gender { get; set; }

    string GenderString { get { return Gender.ToString(); } }
}

Answer 8

此版本的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; 
        }
    }
}

Answer 9

这是newtonsoft.json的答案

enum Gender { Male, Female }

class Person
{
    int Age { get; set; }

    [JsonConverter(typeof(StringEnumConverter))]
    Gender Gender { get; set; }
}

Answer 10

对于.NET 6.0如果您想使用内置JsonSerializer(System.Text.Json)

然后，它是开箱即用的，您只需要使用内置JsonStringEnumConverter属性即可。例如：

[JsonConverter(typeof(JsonStringEnumConverter))]
public SomeEnumType EnumProperty { get; set; }

就是这样，但请确保您SomeEnumType包含的值具有确切的字符串值，否则它将引发异常。外壳似乎不敏感。

参考： https: //learn.microsoft.com/en-us/dotnet/standard/serialization/system-text-json-customize-properties ?pivots=dotnet-6-0#enums-as-strings

Answer 11

ASP.NET核心方式:

public class Startup
{
  public IServiceProvider ConfigureServices(IServiceCollection services)
  {
    services.AddMvc().AddJsonOptions(options =>
    {
      options.SerializerSettings.Converters.Add(new Newtonsoft.Json.Converters.StringEnumConverter());
    });
  }
}

https://gist.github.com/regisdiogo/27f62ef83a804668eb0d9d0f63989e3e

Answer 12

带有 System.Text.Json 的 Asp.Net Core 3

public void ConfigureServices(IServiceCollection services)
{

    services
        .AddControllers()
        .AddJsonOptions(options => 
           options.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter())
        );

    //...
 }

Answer 13

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

我已经包含了端到端解决方案,因为我认为大多数人想要将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 ..]作为枚举的整数值.

服务器端 - 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>

Answer 14

JsonSerializer如果您不想使用JsonConverter属性,还可以为您添加转换器:

string SerializedResponse = JsonConvert.SerializeObject(
     objToSerialize, 
     new Newtonsoft.Json.Converters.StringEnumConverter()
); 

它将适用于enum序列化过程中看到的每一个.

Answer 15

对于ASP.Net核心，只需将以下内容添加到您的启动类中：

JsonConvert.DefaultSettings = (() =>
        {
            var settings = new JsonSerializerSettings();
            settings.Converters.Add(new StringEnumConverter { AllowIntegerValues = false });
            return settings;
        });

Answer 16

您可以通过调用JsonConverter.SerializeObject来创建JsonSerializerSettings,如下所示:

var result = JsonConvert.SerializeObject
            (
                dataObject,
                new JsonSerializerSettings
                {
                    Converters = new [] {new StringEnumConverter()}
                }
            );

Answer 17

注意到存在Description属性时没有序列化的答案.

这是我的实现,它支持Description属性.

public class CustomStringEnumConverter : Newtonsoft.Json.Converters.StringEnumConverter
{
    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        Type type = value.GetType() as Type;

        if (!type.IsEnum) throw new InvalidOperationException("Only type Enum is supported");
        foreach (var field in type.GetFields())
        {
            if (field.Name == value.ToString())
            {
                var attribute = Attribute.GetCustomAttribute(field, typeof(DescriptionAttribute)) as DescriptionAttribute;
                writer.WriteValue(attribute != null ? attribute.Description : field.Name);

                return;
            }
        }

        throw new ArgumentException("Enum not found");
    }
}

枚举:

public enum FooEnum
{
    // Will be serialized as "Not Applicable"
    [Description("Not Applicable")]
    NotApplicable,

    // Will be serialized as "Applicable"
    Applicable
}

用法:

[JsonConverter(typeof(CustomStringEnumConverter))]
public FooEnum test { get; set; }

Answer 18

对于.Net Core Web Api: -

public void ConfigureServices(IServiceCollection services)
{
    ...
    services.AddJsonFormatters(f => f.Converters.Add(new StringEnumConverter()));
    ...
}

Answer 19

用这个：

using Newtonsoft.Json;
using Newtonsoft.Json.Converters;

[Serializable]
[JsonConverter(typeof(StringEnumConverter))]
public enum Gender { Male, Female }

Answer 20

这是一个老问题,但我认为我会做出贡献以防万一.在我的项目中,我为任何Json请求使用单独的模型.模型通常与具有"Json"前缀的域对象具有相同的名称.使用AutoMapper映射模型.通过让json模型声明一个字符串属性是域类的枚举,AutoMapper将解析为它的字符串表示.

如果您想知道,我需要Json序列化类的单独模型,因为内置的序列化器会提供循环引用.

希望这有助于某人.

Answer 21

以防万一有人发现上述不足，我最终解决了这个过载：

JsonConvert.SerializeObject(objToSerialize, Formatting.Indented, new Newtonsoft.Json.Converters.StringEnumConverter())

Answer 22

在.net core 3中，现在可以通过System.Text.Json中的内置类来实现：

var person = new Person();
// Create and add a converter which will use the string representation instead of the numeric value.
var stringEnumConverter = new System.Text.Json.Serialization.JsonStringEnumConverter();
JsonSerializerOptions opts = new JsonSerializerOptions();
opts.Converters.Add(stringEnumConverter);
// Generate json string.
var json = JsonSerializer.Serialize<Person>(person, opts);

为JsonStringEnumConverter特定属性配置属性装饰：

using System.Text.Json.Serialization;

[JsonConverter(typeof(JsonStringEnumConverter))]
public Gender Gender { get; set; }

如果要始终将枚举转换为字符串，请将属性放在枚举本身。

[JsonConverter(typeof(JsonStringEnumConverter))] 
enum Gender { Male, Female }