EFCorePowerTools 中处理 SQL Server 计算列的最佳实践

在数据库设计中，计算列（Computed Column）是一个非常有用的特性，它允许我们基于其他列的值自动计算结果。本文将介绍如何在使用 EFCorePowerTools 工具时，正确处理 SQL Server 中的计算列，使其在 C# 代码中表现为只读属性。

计算列的类型与特点

SQL Server 中的计算列主要分为两种类型：

1. 持久化计算列（PERSISTED）：这类列的值会实际存储在数据库中，当依赖的列值发生变化时，计算列的值会自动更新并保存。

2. 非持久化计算列：这类列的值不会存储在数据库中，而是在每次查询时动态计算得出。

计算列通常用于以下场景：

• 组合多个列的值（如全名=姓+名）
• 基于日期计算年龄
• 复杂的业务逻辑计算

在 C# 中实现计算列只读

在使用 EFCorePowerTools 生成实体类时，我们希望计算列在 C# 中表现为只读属性，防止应用程序意外修改这些自动计算的值。以下是实现这一目标的步骤：

1. 识别计算列：通过检查 GetComputedColumnSql() 方法可以确定一个属性是否对应数据库中的计算列。

2. 修改 T4 模板：在 EntityType.t4 模板中添加条件判断，为计算列生成只读属性。

具体实现方案

在 EFCorePowerTools 的 T4 模板中，可以添加如下代码段来处理计算列：

var computedColumnSql = property.GetComputedColumnSql();
if (!string.IsNullOrEmpty(computedColumnSql))
{
    // 生成只读属性
#>
    public <#= code.Reference(property.ClrType) #><#= needsNullable ? "?" : "" #> <#= property.Name #> { get; }<#= needsInitializer ? " = null!;" : "" #>
<#
}
else
{
    // 生成普通可读写属性
#>
    public <#= code.Reference(property.ClrType) #><#= needsNullable ? "?" : "" #> <#= property.Name #> { get; set; }<#= needsInitializer ? " = null!;" : "" #>
<#
}

注意事项

1. 错误处理：在修改 T4 模板时，确保语法正确，避免出现空引用异常。

2. 版本兼容性：此方案适用于较新版本的 EFCorePowerTools 和 Entity Framework Core。

3. 性能考虑：对于频繁访问的计算列，考虑使用持久化计算列以提高查询性能。

总结

通过合理配置 EFCorePowerTools 的 T4 模板，我们可以自动将数据库中的计算列映射为 C# 中的只读属性，既保持了数据的一致性，又提供了良好的开发体验。这种方法特别适合那些需要确保数据计算逻辑集中管理、避免业务层意外修改的场景。

对于已有项目，如果计算列数量不多，也可以选择手动修改生成的实体类，但对于大型项目或频繁变更的数据库结构，使用 T4 模板自动化处理无疑是更高效的选择。