Asp.net core Enum as string + ef core value convertor

更新: 2021-12-30

OData DataContract EnumMember 要全部写

[DataContract]
public enum ProductStatus
{
    [EnumMember(Value = "In Stock")]
    InStock,

    [EnumMember(Value = "Out of Stock")]
    OutOfStock,

    [EnumMember(Value = "Other")]
    Other
}

Other 没有改变 by right 可以不需要写 EnumMember, 但是 OData DataContract 很笨. 如果你没有写, 它在 $filter 的时候会直接坏掉

$filter=status eq 'Other' error 500. 所以要写就写到完. 

 

更新: 2021-09-26

虽然 web api json 是有 dll 可以解决了，但是 form post 还是不行. 

form post 只可以写 number 或者 enum string 

目前是没有办法支持 EnumMember, 但我也觉得算了呗. 不可能为了统一非要自己去搞吧.

 

更新: 2021-06-12

虽然 enum to string 是 ok 了, 但是....如果我们需要 + EnumMember 它就会坏掉了. 是不是很恐怖一下... 

比如: 

[DataContract]
public enum ProductStatus
{
    [EnumMember(Value = "In Stock")]
    InStock,
    [EnumMember(Value = "Not Available")]
    NotAvailable,
    Draft
}

这个 enum to string 涉及到 3 个主要的地方, ef core, web api, odata

ef core 现在做 enum to string, 只要声明 <string> 就可以了, 

 

 

它内部会调用 

builder.Property(e => e.Status).HasConversion(new StringEnumConverter<ProductStatus>());

这个是不处理 EnumMember 的, 我们需要自己实现一个

另外一个地方是 web api 的 json

已经有好心人 fix 了 

https://github.com/Macross-Software/core/tree/develop/ClassLibraries/Macross.Json.Extensions

最后就 odata 了, 我自己提了一个 issue, 算是勉强能用啦. 

https://github.com/OData/WebApi/issues/2264

这里做一个计入, 希望之后会慢慢好呗

 

 

 

更新 : 2019-06-08 

build in convertor 

https://docs.microsoft.com/en-us/ef/core/modeling/value-conversions#built-in-converters

注意 : value null 是不走 convertor 的哦, 所以我们也不需要顾虑 nullable 的情况.

 

更新 2019-06-01 

string jsonWithConverter = JsonConvert.SerializeObject(new Dada { name = "keatkeat", type = Type.Completed }, new StringEnumConverter());

 

 

写 c# 我们喜欢用 enum. 但是 enum to sql， enum to fronend 都是麻烦. 

因为 enum 一般会转换成 int 而不是 string. 可是这样就不可读了. 

所以呢，我们的要动点手脚 

 

ef core convert 

modelBuilder.Entity<Order>().Property(p => p.status).IsRequired().HasMaxLength(128).HasConversion(
    v => v.ToString(),
    v => (OrderStatus)Enum.Parse(typeof(OrderStatus), v)
);

有了这个在数据库就可以看见 string 了.

 

然后是 web api 

services.AddMvc(options =>
{
    options.EnableEndpointRouting = false;
})
.AddJsonOptions(options =>
{
    options.SerializerSettings.Converters.Add(new StringEnumConverter());
})

这样 GET 就可以输出 string 了,  POST 的时候 binding, asp.net core 会自动转换, 所以前端传 string or int 都可以. 

 

OData

非常聪明，啥也不用弄，它本来就输出 string ... 也有点恐怖啦..

 

typescript 

enum StringStatus { 
    pending = 'pending',
    completed = 'completed'
}
enum NumberStatus { 
    pending,
    completed = 13
}
console.log(StringStatus.pending); // 'pending'
console.log(NumberStatus.pending); // 0
console.log(NumberStatus.completed); // 13