Ef Core花里胡哨系列(6) XML注释同步到数据库注释

合集 - ef core(11)

1.Ef Core花里胡哨系列(2) 移除外键、扩展操作2024-01-022.Ef Core花里胡哨系列(1) SafeDelete、ReadOnly、Audit 安全删除、只读、审计等2024-01-023.Ef Core花里胡哨系列(3) 动态修改实体对应的表(分表)、多租户2024-01-024.Ef Core花里胡哨系列(4) 多租户2024-01-025.Ef Core花里胡哨系列(5) 动态修改追踪的实体、动态查询2024-01-02

6.Ef Core花里胡哨系列(6) XML注释同步到数据库注释2024-01-02

7.Ef Core花里胡哨系列(7) 使用Ef Core也能维护表架构？2024-01-038.Ef Core花里胡哨系列(8) 如何可控管理Ef Core的迁移？2024-01-039.Ef Core花里胡哨系列(9) 阴影属性，有用还是没用？2024-01-0410.Ef Core花里胡哨系列(10) 动态起来的 DbContext2024-01-0411.Ef Core花里胡哨系列(11) ef8 无实体查询，你好!2024-01-04

收起

Ef Core花里胡哨系列(6) XML注释同步到数据库注释

参考文档：C#读取注释的方法

准备读取Xml的工具类

可以根据[参考文档]获取一个简单读取注释的方法。

实现DbContext

我们通过重写OnModelCreating方法，在生成数据库表时，使用FluentApi指定对应表以及其属性的Comment即可将Xml注释转为数据库的Comment。

public class SampleDbContext : DbContext
{
    public SampleDbContext(DbContextOptions<SampleDbContext> options) : base(options) { }

    public DbSet<User> Users { get; set; }

    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        var xmlCommentHelper = new XmlCommentHelper();
        xmlCommentHelper.LoadAll();

        foreach (var entityType in modelBuilder.Model.GetEntityTypes())
        {
            var typeComment = xmlCommentHelper.GetTypeComment(entityType.ClrType);
            modelBuilder.Entity(entityType.ClrType).ToTable(t => t.HasComment(typeComment));
            foreach (var property in entityType.ClrType.GetProperties().Where(x => x.IsPubliclyWritable()))
            {
                var propertyComment = xmlCommentHelper.GetFieldOrPropertyComment(property);
                modelBuilder.Entity(entityType.ClrType).Property(property.Name).HasComment(propertyComment);
            }
        }

        base.OnModelCreating(modelBuilder);
    }
}

/// <summary>
/// 用户表
/// </summary>
public class User
{
    /// <summary>
    /// Id
    /// </summary>
    public Guid Id { get; set; }
    /// <summary>
    /// 姓名
    /// </summary>
    public required string Name { get; set; }
    /// <summary>
    /// 邮箱
    /// </summary>
    public required string Email { get; set; }
}