C中EF Core的值转换器使用与配置指南

值转换器可在EF Core中实现CLR类型与数据库类型的双向转换，如将枚举转为字符串存储、序列化List为JSON等，通过Fluent API在OnModelCreating中配置，支持内置和自定义转换器，提升模型灵活性与数据库兼容性。

在 C# 中使用 EF Core 的值转换器（Value Converters）可以让你在将数据写入数据库和从数据库读取时，自动转换属性的值。这在实体模型中的类型与数据库列类型不一致时特别有用，比如使用 枚举字符串存储、加密字段、或处理 复杂类型如 List/JSON 等场景。

1. 什么是值转换器？

EF Core 值转换器允许你在 CLR 类型和数据库表示之间进行双向转换。例如：

• 将 enum 转为字符串存储到数据库
• 将 DateTimeOffset 转为 UTC 时间存储
• 将 List<string> 序列化为 JSON 字符串

转换发生在 EF Core 写入数据库前和读取后，对业务代码透明。

2. 如何配置值转换器？

值转换器可以通过 Fluent API 在 OnModelCreating 方法中配置。以下是常见用法示例：

示例1：使用内置转换器（Enum 转字符串）

假设你有一个用户状态枚举：

public enum UserStatus
{
    Active,
    Inactive,
    Pending
}
public class User
{
public int Id { get; set; }
public string Name { get; set; }
public UserStatus Status { get; set; }
}

你想把 Status 以字符串形式存入数据库：

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity<User>()
        .Property(e => e.Status)
        .HasConversion<string>();
}

这样 EF Core 会自动将 Active 存为 "Active" 字符串。

示例2：自定义转换器（List 转 JSON）

如果你想将一个字符串列表序列化为 JSON 存储：

public class Product
{
    public int Id { get; set; }
    public string Name { get; set; }
    public List<string> Tags { get; set; }
}

使用 ValueConverter 配置：

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity<Product>()
        .Property(e => e.Tags)
        .HasConversion(
            v => JsonSerializer.Serialize(v, (JsonSerializerOptions)null),
            v => JsonSerializer.Deserialize<List<string>>(v, new JsonSerializerOptions())
        );
}

这样 Tags 会被序列化成 JSON 字符串存入数据库。

示例3：创建可复用的转换器类

对于复杂逻辑，建议封装成类：

public class JsonValueConverter<T> : ValueConverter<T, string>
    where T : class, new()
{
    public JsonValueConverter() : base(
        v => JsonSerializer.Serialize(v, (JsonSerializerOptions)null),
        v => JsonSerializer.Deserialize<T>(v, new JsonSerializerOptions()) ?? new T())
    {
    }
}

然后在模型中使用：

modelBuilder.Entity<Product>()
    .Property(e => e.Tags)
    .HasConversion(new JsonValueConverter<List<string>>());

3. 注意事项

• 转换器只影响数据库读写，不影响内存中的实体操作
• LINQ 查询中涉及转换字段时，EF Core 需能翻译转换逻辑，否则可能抛异常
• 尽量避免在转换器中做耗时操作（如加解密），会影响性能
• 如果字段用于查询或索引，确保转换后的值适合数据库操作

基本上就这些。值转换器是 EF Core 处理类型映射的灵活方式，合理使用可以让模型设计更贴近业务，同时保持数据库兼容性。配置简单，但功能强大。

本文转载于：互联网 如有侵犯，请联系zhengruancom@outlook.com删除。
免责声明：正软商城发布此文仅为传递信息，不代表正软商城认同其观点或证实其描述。