访问EF导航属性时，请避免NullReferenceException

Question

在访问使用实体框架加载的对象的导航属性时，我最近修复的许多错误都是空引用的结果。 我相信我如何设计我的方法一定存在缺陷。 这是一个例子......

任务包含许多角色，每个角色引用一个用户。

public class Role
{
    public int Id;
    public int User_Id;
    public string Type;
}

public class User
{
    public int Id
    public string Name;
}    

public class Task
{
    public int Id;
    public string Name;
    public string Status;
    public List<Role> Roles;
}

考虑到我会错误地查询我的上下文而没有加载用户 ...

var task = context.Tasks.Include(x=>x.Roles).FirstOrDefault;

然后我称这种方法......

public void PrintTask(Task task)
{
    Console.WriteLine(task.Name);
    Console.WriteLine(task.Status);

    foreach(var r in task.Roles)
    {
        Console.WriteLine(r.User.Name); //This will throw NRE because User wasn't loaded
    }
}

我可能已经构建了这个方法，每个意图加载角色和用户，但下次我使用它时，我可能会忘记我需要两者。 理想情况下，方法定义应该告诉我哪些数据是必要的，但即使我传入任务和角色，我仍然缺少角色 - >用户。

引用这些关系的正确方法是什么，并确保它们被加载到类似这种打印方法的东西中？ 我对更好的设计感兴趣，所以“使用延迟加载”不是我正在寻找的答案。

谢谢！

编辑：

我知道我可以像这样加载任务......

var task = context.Tasks.Include(x=>x.Roles.Select(z=>z.User)).FirstOrDefault();

我想知道的是我如何设计我的方法，以便当我回来并在6个月后使用它时，我知道需要在我的实体中加载哪些数据？ 方法定义未指出使用它的必要条件。 或者我如何阻止这些NullReferences。 必须有一个更好的设计。

Answer 1

您可以使用Select扩展方法来急切加载Users 。

var task = context.Tasks.Include(x => x.Roles)
             .Include(x => x.Roles.Select(r => r.User))
             .FirstOrDefault();

编辑：

我无法想到避免NRE的方法

• 使用SQL Server CE / Express数据库进行集成测试。 使用伪上下文进行单元测试将无法正常工作。
• 将实体加载到消耗它们的位置附近。 因此Include s接近使用实体的位置。
• 将DTO / ViewModel传递到上层而不传递实体。

Answer 2

User应该在你的循环中懒得加载 - 只是注意这是一个经典的选择N + 1问题，你应该用另一个Include修复。

我认为问题的根源是，要么这个特殊的Role 没有一个User ，或者这个特定Role的User有其空集Name 。 您需要在循环中检查两者是否为null

foreach(var r in task.Roles)
{
    if (r.User != null)
        Console.WriteLine(r.User.Name ?? "Name is null"); 
}

Answer 3

非常好的问题。 以下是一些可能的解决方案，虽然它们不强制避免使用NRE，但它们会向调用者提供他们需要Include内容的线索：

第一种选择是不让您的方法访问实体的非保证属性; 相反，强制调用者传递两个实体：

public void PrintTask(Task task, User taskUser)
{
    // ...
}

另一种选择是命名方法的参数，以便它可以使调用者了解所需的内容：

public void PrintTask(Task taskWithUser)
{
    // ...
}