如何配置EF Core将Cosmos DB中复杂属性的Enum序列化为字符串

在.NET项目中使用EF Core和Azure Cosmos DB，现有User实体包含AuditStandardUserInfo实体集合，两者均拥有AuditCompetence（枚举类型）的Competence属性。希望配置EF Core将该属性序列化为字符串存储到Cosmos DB，但尝试的方案均存在问题：

• 使用OnModelCreating中的HasConversion方法仅对User直接的Competence生效，集合内的属性未转换；
• 为AuditCompetence枚举添加Newtonsoft.Json的[JsonConverter(typeof(StringEnumConverter))]特性也无效。

相关代码：

public enum AuditCompetence
{
    None,
    Low,
    Medium,
    High
}

public class User
{
    public string UserId { get; set; } = Guid.NewGuid().ToString();
    // ... other properties ...
    public ICollection<AuditStandardUserInfo> UserAuditStandards { get; set; } = new List<AuditStandardUserInfo>();
    public AuditCompetence? Competence { get; set; }
}

public class AuditStandardUserInfo
{
    public string AuditStandardId { get; set; }
    // ... other properties ...
    public AuditCompetence Competence { get; set; }
}

public class MyDbContext : DbContext
{
    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        // ... configuration code ...
    }
}

方案1：单独配置嵌套实体的枚举转换 #

在OnModelCreating中，不仅配置User实体的Competence属性，还要显式配置嵌套实体AuditStandardUserInfo的对应属性：

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    // 配置User实体的Competence枚举转字符串
    modelBuilder.Entity<User>()
        .Property(u => u.Competence)
        .HasConversion<string>();

    // 配置AuditStandardUserInfo实体的Competence枚举转字符串
    modelBuilder.Entity<AuditStandardUserInfo>()
        .Property(a => a.Competence)
        .HasConversion<string>();
}

方案2：全局配置所有AuditCompetence枚举属性 #

如果项目中有多个实体用到AuditCompetence枚举，可通过遍历所有实体属性统一配置，避免重复代码：

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    foreach (var entityType in modelBuilder.Model.GetEntityTypes())
    {
        foreach (var property in entityType.GetProperties())
        {
            // 匹配AuditCompetence及可空类型
            if (property.ClrType == typeof(AuditCompetence) || 
                property.ClrType == typeof(AuditCompetence?))
            {
                property.SetConversion<string>();
            }
        }
    }
}

方案3：配置EF Core Cosmos的JSON序列化器 #

EF Core Cosmos默认使用System.Text.Json，若之前的Newtonsoft特性无效，可直接配置序列化器的字符串枚举转换器：

protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
{
    optionsBuilder.UseCosmos(
        "你的Cosmos DB连接字符串",
        "数据库名称",
        options =>
        {
            options.SerializerOptions.Converters.Add(new JsonStringEnumConverter());
        });
}

若需切换为Newtonsoft.Json序列化，先安装Microsoft.EntityFrameworkCore.Cosmos.NewtonsoftJson包，再配置：

protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
{
    optionsBuilder.UseCosmos(
        "你的Cosmos DB连接字符串",
        "数据库名称")
        .UseNewtonsoftJson(options =>
        {
            options.Converters.Add(new StringEnumConverter());
        });
}

内容的提问来源于stack exchange，提问作者Christian Maaß