如何使用 Entity Framework Core 保存字符串列表？

假设我们有一个如下所示的类：

public class Entity
{
    public IList<string> SomeListOfValues { get; set; }

    // Other code
}

现在，假设我们想要使用 EF Core Code First 来持久化这一点，并且我们正在使用像 SQL Server 这样的 RDMBS。

一种可能的方法显然是创建一个包装类Wraper包裹字符串：

public class Wraper
{
    public int Id { get; set; }

    public string Value { get; set; }
}

并重构该类，使其现在依赖于以下列表Wraper对象。在这种情况下，EF 将生成一个表Entity，一个表Wraper并建立“一对多”关系：每个实体都有一群说唱歌手。

虽然这可行，但我不太喜欢这种方法，因为出于持久性问题，我们正在更改一个非常简单的模型。事实上，只考虑领域模型和代码，没有持久性，Wraper课堂在那里毫无意义。

除了创建包装类之外，还有其他方法可以使用 EF Core Code First 将具有字符串列表的实体持久保存到 RDBMS 中吗？当然，最终必须做同样的事情：必须创建另一个表来保存字符串，并且必须建立“一对多”关系。我只想使用 EF Core 执行此操作，而不需要在域模型中编写包装类。

EF Core 8 更新

.NET 8 现在内置支持在列中存储基本类型列表。在这里阅读有关原始集合 https://learn.microsoft.com/en-us/ef/core/what-is-new/ef-core-8.0/whatsnew#primitive-collections.

EF Core 8 之前的版本（或者如果您想手动控制序列化而不是使用 JSON）

从 Entity Framework Core 开始，可以通过更简单的方式实现这一点2.1。 EF 现在支持价值转换 https://learn.microsoft.com/en-us/ef/core/modeling/value-conversions专门解决此类需要将属性映射到不同类型进行存储的场景。

要保留字符串集合，您可以设置DbContext通过以下方式：

protected override void OnModelCreating(ModelBuilder builder)
{
    var splitStringConverter = new ValueConverter<IEnumerable<string>, string>(v => string.Join(";", v), v => v.Split(new[] { ';' }));
    builder.Entity<Entity>()
           .Property(nameof(Entity.SomeListOfValues))
           .HasConversion(splitStringConverter);
} 

请注意，此解决方案不会让您的企业级充满数据库问题。

不用说，这种解决方案必须确保字符串不能包含分隔符。当然，任何自定义逻辑都可以用于进行转换（例如从 JSON 到 JSON 的转换）。

另一个有趣的事实是空值是not传递到转换例程中，而是由框架本身处理。因此，无需担心转换例程内的空检查。然而，整个财产变成null如果数据库包含NULL value.

价值比较器怎么样？

使用此转换器创建迁移会导致以下警告：

属性“Entity.SomeListOfValues”是具有值转换器但没有值比较器的集合或枚举类型。设置值比较器以确保正确比较集合/枚举元素。

为建议的转换器设置正确的比较器取决于列表的语义。例如，如果你不关心其元素的顺序，您可以使用以下比较器：

new ValueComparer<IEnumerable<string>>(
    (c1, c2) => new HashSet<string>(c1!).SetEquals(new HashSet<string>(c2!)),
    c => c.Aggregate(0, (a, v) => HashCode.Combine(a, v.GetHashCode())),
    c => c.ToList()
);

使用此比较器，具有相同元素的重新排序列表不会被检测为更改，因此可以避免与数据库的往返。有关值比较器主题的更多信息，请考虑docs https://learn.microsoft.com/en-us/ef/core/modeling/value-comparers?tabs=ef5.

更新 EF Core 6.0

为了受益于Entity Framework Core 6.0 编译模型 https://devblogs.microsoft.com/dotnet/announcing-entity-framework-core-6-0-preview-5-compiled-models/，我们可以使用通用重载HasConversion。所以完整的图就变成了：

builder.Entity<Foo>()
    .Property(nameof(Foo.Bar))
    .HasConversion<SemicolonSplitStringConverter, SplitStringComparer>();

...

public class SplitStringComparer : ValueComparer<IEnumerable<string>>
{
    public SplitStringComparer() : base(
        (c1, c2) => new HashSet<string>(c1!).SetEquals(new HashSet<string>(c2!)),
        c => c.Aggregate(0, (a, v) => HashCode.Combine(a, v.GetHashCode())))
    {
    }
}

public abstract class SplitStringConverter : ValueConverter<IEnumerable<string>, string>
{
    protected SplitStringConverter(char delimiter) : base(
        v => string.Join(delimiter.ToString(), v),
        v => v.Split(new[] { delimiter }, StringSplitOptions.RemoveEmptyEntries))
    {
    }
}

public class SemicolonSplitStringConverter : SplitStringConverter
{
    public SemicolonSplitStringConverter() : base(';')
    {
    }
}