在日常开发中,我们经常会遇到需要传参和返回枚举值,默认情况下我们使用数值,需要双方约定好各种数值代表什么。这样的表示并不明确,无法见名知意。所以我们有没有办法让传参变成字符串,并且我们还能正确转换成枚举值呢?答案是可以。
用原生的JsonStringEnumConverter
或者Newtonsoft.Json
的StringEnumConverter
都可以实现。
以下使用原生的JsonStringEnumConverter
说明,只需要在Program.cs
添加如下配置即可。
builder.Services.AddControllers()
.AddJsonOptions(options => { options.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter()); });
根据JsonStringEnumConverter 类的说明,JsonStringEnumConverter
可以将枚举值转换为字符串以及从字符串转换为枚举值,并且支持自定义属性名称和值。
如果想使用Newtonsoft.Json
,可以参考