如何防止在Entity Framework Code First中循环加载相关实体

Question

我是 Entity Framework 的新手，正在尝试学习如何使用 Code First 从数据库中加载实体。

我的模型包含一个用户：

public class User
{
    public int UserID { get; set; }

    [Required]
    public string Name { get; set; }

    // Navigation Properties
    public virtual ICollection<AuditEntry> AuditEntries { get; set; }
}

每个用户都可以有一组审计条目，每个条目都包含一条简单的消息：

public class AuditEntry
{
    public int AuditEntryID { get; set; }

    [Required]
    public string Message { get; set; }

    // Navigation Properties
    public int UserID { get; set; }
    public virtual User User { get; set; }
}

我有一个只公开两个表的 DBContext：

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

我要做的是加载包含消息的 AuditEntry 对象列表以及包含 UserID 和 Name 属性的相关 User 对象。

List<AuditEntry> auditEntries = db.AuditEntries.ToList();

因为我将导航属性标记为虚拟并且我没有禁用延迟加载，所以我得到了一个无限深的对象图（每个 AuditEntry 都有一个 User 对象，其中包含 AuditEntries 的列表，每个都包含一个 User对象，其中包含 AuditEntries 列表等）

如果我想序列化对象（例如在 Web API 中作为结果发送），那就不好了。

我尝试关闭延迟加载（通过从模型中的导航属性中删除虚拟关键字，或者将 this.Configuration.LazyLoadingEnabled = false; 添加到我的 DBContext）。正如预期的那样，这会生成一个包含 User 设置为 null 的 AuditEntry 对象的平面列表。

关闭延迟加载后，我尝试像这样急切加载用户：

var auditentries = db.AuditEntries.Include(a => a.User);

但这会导致与以前相同的深度/循环结果。

如何在不将反向引用/跟随导航属性加载回原始对象并创建循环的情况下加载一层深度（例如，包括用户的 ID 和名称）？

Answer 1

经过多次修改，我在我的 Linq 查询中使用动态返回类型和投影提出了以下潜在解决方案：

public dynamic GetAuditEntries()
{
    var result = from a in db.AuditEntries
                 select new
                 {
                     a.AuditEntryID,
                     a.Message,
                     User = new
                     {
                         a.User.UserID,
                         a.User.Username
                     }
                 };

    return result;
}

这会（在内部）产生以下看似合理的 SQL：

SELECT 
[Extent1].[AuditEntryID] AS [AuditEntryID], 
[Extent1].[Message] AS [Message], 
[Extent1].[UserID] AS [UserID], 
[Extent2].[Username] AS [Username]
FROM  [dbo].[AuditEntries] AS [Extent1]
INNER JOIN [dbo].[Users] AS [Extent2] ON [Extent1].[UserID] = [Extent2].[UserID]

这会产生我所追求的结果，但似乎有点啰嗦（尤其是对于比我的示例复杂得多的真实模型），我质疑这会对性能产生影响。

优势

• 这给了我很大的灵活性来处理我返回的对象的确切内容。由于我通常在客户端进行大部分 UI 交互/模板，因此我经常发现自己必须创建模型对象的多个版本。我通常需要一定的粒度，用户可以查看哪些属性（例如，我可能不想在 AJAX 请求中将每个用户的电子邮件地址发送到低权限用户的浏览器）

• 它允许实体框架智能地构建查询，并且只选择我选择投影的字段。例如，在每个顶级 AuditEntry 对象中，我想查看 User.UserID 和 User.Username 而不是 User.AuditEntries。

缺点

• 从我的 Web API 返回的类型不再是强类型的，因此我无法基于此 API 创建强类型的 MVC 视图。碰巧这对我的特殊情况来说不是问题。

• 以这种方式从大型/复杂模型手动投影可能会产生大量代码，看起来工作量很大，并且有可能在 API 中引入错误。这必须经过仔细测试。

• API 方法与模型的结构紧密耦合，并且由于这不再基于我的 POCO 类完全自动化，因此对模型所做的任何更改都必须反映在加载它们的代码中。

包含方法？

我对 .Include() 方法的使用仍然有些困惑。我了解此方法将指定相关实体应与指定实体一起“急切加载”。但是，由于指导似乎是导航属性应放置在关系的两侧并标记为虚拟，因此 Include 方法似乎会导致创建一个循环，这对其有用性有很大的负面影响（尤其是在序列化时） .

在我的例子中，“树”看起来有点像：

AuditEntry
    User
        AuditEntries * n
            User * n
                etc

我很想听听有关这种方法的任何 cmets、以这种方式使用动态的影响或任何其他见解。