如何向 EF Core SqlServer 目标构建器添加对结构化注释的支持？

Question

使用接受object 类型参数的HasAnnotation 方法向EF 模型添加纯字符串注释很容易，但尝试添加结构化注释会在构建迁移时出错：

        modelBuilder.Entity<Group>().HasAnnotation($"{GetType().FullName}.Constraint3", new ValueTuple<string,string>( "aaa", "bbb" ));

The current CSharpHelper cannot scaffold literals of type 'System.ValueTuple`2[System.String,System.String]'. Configure your services to use one that can.

        modelBuilder.Entity<Group>().HasAnnotation($"{GetType().FullName}.Constraint2", new[] { "aaa", "bbb" });

The current CSharpHelper cannot scaffold literals of type 'System.String[]'. Configure your services to use one that can.

我们是否有办法向target builder 注入有助于序列化结构化注释的方法？

为什么我需要它？只是试图在一个地方收集所有数据库元数据。而元通常是结构化信息。

Answer 1

据我所知（关于这方面的信息很少，如果有的话），这个想法是使用简单的名称/值对，其中的值是原始类型（string、int、@987654328 @、DateTime 等加上 enums) 和名称构成了结构。所有 EF Core 注释都遵循该原则。例如，名称："SqlServer:ValueGenerationStrategy" 类型：SqlServerValueGenerationStrategy 等

可能最简单的方法就是遵循该约定。但无论如何，负责的服务是ICSharpHelper - UnknownLiteral 方法。而默认实现在CSharpHelper类中。

因此您可以从中派生，覆盖 UnknownLiteral 方法并在那里进行自己的（预处理）处理：

using Microsoft.EntityFrameworkCore.Design.Internal;

public class MyCSharpHelper : CSharpHelper
{
    public override string UnknownLiteral(object value)
    {
        // Preprocess the value here...
        return base.UnknownLiteral(value);
    }
}

然后用你的替换标准服务：

using Microsoft.EntityFrameworkCore.Design;
using Microsoft.Extensions.DependencyInjection;

public class MyDesignTimeServices : IDesignTimeServices
{
    public void ConfigureDesignTimeServices(IServiceCollection services)
    {
        services.AddSingleton<ICSharpHelper, MyCSharpHelper>();
    }
}