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

更新 : 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().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); //
console.log(NumberStatus.completed); //