如何在EF Core中无需后备字段保存CultureInfo集合？

问题背景 #

在遵循领域驱动设计（DDD）的项目中，Community实体包含List<CultureInfo>类型的OfficialLanguages集合，受DDD约束无法添加List<string>类型的后备字段存储语言代码。

对于单个CultureInfo属性（如User.Culture），可通过EF Core的HasConversion实现类型转换：

modelBuilder
    .Entity<User>()
    .Property(u => u.Culture)
    .HasConversion(c => c.Name, s => new CultureInfo(s));

但直接为集合配置类似转换时无效：

modelBuilder
    .Entity<Community>()
    .Property(c => c.OfficialLanguages)
    .HasConversion(l => string.Join(',', l), s => s.Split(',', StringSplitOptions.RemoveEmptyEntries).ToList());

解决方案：自定义值转换器 #

EF Core默认不支持直接对集合类型使用HasConversion，需创建自定义值转换器，逐个处理集合中CultureInfo与字符串的转换逻辑。

1. 实现自定义转换器 #

创建继承自ValueConverter<List<CultureInfo>, string>的转换器，分别处理集合到字符串、字符串到集合的转换：

public class CultureInfoListConverter : ValueConverter<List<CultureInfo>, string>
{
    public CultureInfoListConverter()
        : base(
            // 将List<CultureInfo>转为逗号分隔的语言代码字符串
            list => string.Join(',', list.Select(c => c.Name)),
            // 将逗号分隔的字符串转为List<CultureInfo>
            str => string.IsNullOrWhiteSpace(str) 
                ? new List<CultureInfo>() 
                : str.Split(',', StringSplitOptions.RemoveEmptyEntries)
                    .Select(s => new CultureInfo(s))
                    .ToList()
        )
    {
    }
}

2. 在模型配置中应用转换器 #

在OnModelCreating中为OfficialLanguages属性指定自定义转换器，并显式设置数据库列类型：

modelBuilder
    .Entity<Community>()
    .Property(c => c.OfficialLanguages)
    .HasConversion(new CultureInfoListConverter())
    .HasColumnType("nvarchar(max)");

进阶优化：避免分隔符冲突 #

如果语言代码可能包含逗号，建议改用JSON格式序列化/反序列化，避免分隔符冲突：

public class CultureInfoListJsonConverter : ValueConverter<List<CultureInfo>, string>
{
    public CultureInfoListJsonConverter()
        : base(
            list => JsonSerializer.Serialize(list.Select(c => c.Name), JsonSerializerOptions.Default),
            str => string.IsNullOrWhiteSpace(str) 
                ? new List<CultureInfo>() 
                : JsonSerializer.Deserialize<List<string>>(str, JsonSerializerOptions.Default)
                    .Select(s => new CultureInfo(s))
                    .ToList()
        )
    {
    }
}

使用时替换HasConversion中的转换器即可。

内容的提问来源于stack exchange，提问作者joe