我有一个包含枚举属性的类，在使用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)也是受欢迎的。
当前回答
在。net core 3中，现在可以使用System.Text.Json中的内置类来实现这一点(编辑:System.Text.Json也可以作为。net core 2.0和。net framework 4.7.2以及更高版本的NuGet包，根据文档):
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 }
其他回答
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
如果你不想使用JsonConverter属性，你也可以给JsonSerializer添加一个转换器:
string SerializedResponse = JsonConvert.SerializeObject(
objToSerialize,
new Newtonsoft.Json.Converters.StringEnumConverter()
);
它将适用于它在序列化期间看到的每个枚举。
没有什么特殊属性可以使用。JavaScriptSerializer将枚举序列化为它们的数值而不是它们的字符串表示。您需要使用自定义序列化将枚举序列化为其名称而不是数值。
如果可以使用JSON。JSON.net涵盖了这个用例(通过属性[JsonConverter(typeof(StringEnumConverter))])和其他许多内建的。Net序列化器无法处理的用例。下面是一个比较序列化器特性和功能的链接。
命名空间System.Text.Json.Serialization有JsonStringEnumConverter，可以像下面这样使用。 [JsonConverter typeof (JsonStringEnumConverter)))
我发现Json。NET提供了我正在寻找的StringEnumConverter属性的确切功能:
using Newtonsoft.Json;
using Newtonsoft.Json.Converters;
[JsonConverter(typeof(StringEnumConverter))]
public Gender Gender { get; set; }
更多详细信息请参见StringEnumConverter文档。
还有其他地方可以更全局地配置这个转换器:
如果你想让Enum总是被序列化/反序列化为string，则枚举本身: [JsonConverter typeof (StringEnumConverter))) enum性别{男，女} 如果有人想避免属性修饰，你可以将转换器添加到你的JsonSerializer(由Bjørn Egil建议): serializer.Converters。添加(新Newtonsoft.Json.Converters.StringEnumConverter ()); 并且它将为它在序列化期间看到的每个枚举工作(由Travis建议)。 或者JsonConverter(由banana建议): JsonConvert。SerializeObject (MyObject 新的Newtonsoft.Json.Converters.StringEnumConverter ());
此外，你可以通过使用StringEnumConverter(NamingStrategy, Boolean)构造函数来控制大小写和数字是否仍然被接受。
