我有一个包含枚举属性的类，在使用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)也是受欢迎的。
当前回答
注意，当存在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; }
其他回答
下面是一个简单的解决方案，它将服务器端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>
对于。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
不确定这是否仍然相关，但我必须直接写一个json文件，我想出了以下拼凑几个stackoverflow的答案在一起
public class LowercaseJsonSerializer
{
private static readonly JsonSerializerSettings Settings = new JsonSerializerSettings
{
ContractResolver = new LowercaseContractResolver()
};
public static void Serialize(TextWriter file, object o)
{
JsonSerializer serializer = new JsonSerializer()
{
ContractResolver = new LowercaseContractResolver(),
Formatting = Formatting.Indented,
NullValueHandling = NullValueHandling.Ignore
};
serializer.Converters.Add(new Newtonsoft.Json.Converters.StringEnumConverter());
serializer.Serialize(file, o);
}
public class LowercaseContractResolver : DefaultContractResolver
{
protected override string ResolvePropertyName(string propertyName)
{
return Char.ToLowerInvariant(propertyName[0]) + propertyName.Substring(1);
}
}
}
它确保我所有的json键小写开始根据json“规则”。将其格式化为干净的缩进格式，并忽略输出中的空值。此外，通过添加一个StringEnumConverter，它打印枚举及其字符串值。
就我个人而言，我发现这是我能想到的最干净的方法，而不必用注释弄脏模型。
用法:
internal void SaveJson(string fileName)
{
// serialize JSON directly to a file
using (StreamWriter file = File.CreateText(@fileName))
{
LowercaseJsonSerializer.Serialize(file, jsonobject);
}
}
我用牛顿软件把这个解的所有部分都拼在了一起。Json库。它修复了枚举问题，也使错误处理变得更好，并且它在IIS托管服务中工作。这是相当多的代码，所以你可以在GitHub上找到它:https://github.com/jongrant/wcfjsonserializer/blob/master/NewtonsoftJsonFormatter.cs
您必须向Web添加一些条目。配置让它工作，你可以在这里看到一个例子文件: https://github.com/jongrant/wcfjsonserializer/blob/master/Web.config
我发现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)构造函数来控制大小写和数字是否仍然被接受。
