EF中多层级类Include触发NullReferenceException的技术问询

为什么调换Include顺序能解决问题？ #

这是Entity Framework 6（从堆栈调用信息可判断为EF6）的已知内部bug，和实体化（Materialization）过程中关联关系的处理顺序有关：

• 当你先加载xList这类非嵌套的同级集合，再加载bList.cList和bList.dList这类同一父集合下的多个嵌套子集合时，EF的对象状态管理器在更新关联关系、重置集合的过程中，会出现内部对象未初始化的情况，触发NullReferenceException。
• 调换顺序后，先处理bList的两个子集合，状态管理器能正确初始化bList对应的关联端点和实体包装器，后续加载xList时不会再出现冲突，因此可以正常运行。

同时加载多层级关联集合的正确方式 #

针对EF6场景，推荐以下几种可靠的实现方式：

1. 调整Include顺序，优先处理同一父级的嵌套关联 #

保持先加载同一父集合的所有子关联，再加载其他同级集合，比如：

List<A> localA = _databaseContext.aList
    .Include("bList")
    .Include("bList.cList")
    .Include("bList.dList")
    .Include("xList")
    .ToList();

2. 初始化实体类中的集合属性 #

在实体构造函数中提前初始化所有集合属性，避免EF实体化时因集合为null引发异常，这是预防这类问题的基础操作：

public class A {
    public A() {
        bList = new List<B>();
        xList = new List<X>();
    }
    public List<B> bList { get; set; }
    public List<X> xList { get; set; }
}

public class B {
    public B() {
        cList = new List<C>();
        dList = new List<D>();
    }
    public List<C> cList { get; set; }
    public List<D> dList { get; set; }
}

3. 使用强类型的Include+ThenInclude（EF6.1及以上版本支持） #

相比字符串路径，强类型写法更安全，能避免拼写错误，同时更清晰地表达关联层级：

var localA = _databaseContext.aList
    // 加载bList及其cList
    .Include(a => a.bList)
        .ThenInclude(b => b.cList)
    // 加载bList及其dList
    .Include(a => a.bList)
        .ThenInclude(b => b.dList)
    // 加载xList
    .Include(a => a.xList)
    .ToList();

4. 升级到EF Core（可选） #

如果项目允许，升级到Entity Framework Core可以彻底避免这类旧版本的bug，EF Core的关联加载逻辑经过重构，稳定性和性能都有显著提升。

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