如何刷新Entity Framework Core DbContext且保留属性特性装饰？

好问题！我之前也踩过一模一样的坑——每次用Scaffold-DbContext刷新模型，手动加上的[JsonIgnore]这类特性就被自动生成的代码覆盖，折腾了好一阵子才找到靠谱的解决办法。下面分享几个实用的方案，按推荐程度排序：

方案1：分部类 + 元数据类（最推荐） #

EF Core脚手架生成的模型默认都是分部类，这给我们留了完美的扩展空间。我们可以把自定义特性放在单独的元数据类里，再通过分部类关联，这样刷新模型时只会覆盖自动生成的那部分代码，我们的自定义配置完全不受影响。

举个例子：

1. 脚手架自动生成的模型文件（比如Patient.cs）：

// 这个文件会被Scaffold-DbContext覆盖，不要在这里加自定义代码
public partial class Patient
{
    public int Id { get; set; }
    public string FullName { get; set; }
    public virtual ICollection<LabOrder> LabOrders { get; set; }
}

2. 创建一个单独的元数据类（比如PatientMetadata.cs），在这里添加你需要的特性：

public class PatientMetadata
{
    [JsonIgnore]
    public virtual ICollection<LabOrder> LabOrders { get; set; }
}

3. 再创建一个自己的分部类文件（比如Patient.Extensions.cs），关联元数据类：

using System.ComponentModel.DataAnnotations.Schema;

[MetadataType(typeof(PatientMetadata))]
public partial class Patient
{
    // 这里还可以加自定义方法、属性，同样不会被覆盖
}

这样每次执行Scaffold-DbContext刷新模型时，只会替换自动生成的Patient.cs，我们的元数据类和扩展分部类会原封不动保留，特性自然也就保住了。

方案2：用全局序列化配置替代数据注解 #

既然你加[JsonIgnore]是为了解决循环引用序列化问题，其实完全可以不用在模型上加特性，直接在Web API的全局配置里处理循环引用，或者指定忽略特定属性。

比如在ASP.NET Core 3.0+的Program.cs里：

builder.Services.AddControllers()
    .AddJsonOptions(options =>
    {
        // 全局忽略循环引用（直接解决你的核心问题）
        options.JsonSerializerOptions.ReferenceHandler = ReferenceHandler.IgnoreCycles;
        
        // 如果需要单独忽略某个属性，可以自定义转换器
        // options.JsonSerializerOptions.Converters.Add(new JsonIgnorePropertiesConverter<Patient>(nameof(Patient.LabOrders)));
    });

这种方法的好处是完全脱离模型类，不管怎么刷新模型都不会受影响，而且一次性解决所有循环引用问题，不用逐个属性加特性。

方案3：自定义T4脚手架模板（进阶） #

如果你需要频繁刷新模型，且有定制脚手架生成逻辑的需求，可以修改EF Core的T4模板，让它自动帮你加上需要的特性。不过这个方法有一定学习成本，适合对T4模板熟悉的开发者：

1. 先导出EF Core的默认脚手架模板：执行Scaffold-DbContext时加上-OutputDir Models -ContextDir Data -Force -TemplatePath .\Templates（先创建Templates目录）
2. 找到导出的模型模板文件（比如Class.tt），修改模板逻辑，在生成属性时自动添加[JsonIgnore]或其他你需要的特性
3. 之后刷新模型时指定这个自定义模板，就能自动生成带特性的模型类

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