JSON序列化时遇到的EF延迟加载错误及解决方案

在开发过程中，你是否遇到过这样的问题：“ObjectDisposedException”异常提示数据库上下文已释放，导致JSON序列化失败？本文将通过一个真实案例详细解释这一问题，并提供三种有效的解决方法。

一、引入背景和问题重现

假设我们有一个包含三层数据关系的应用场景：

• 主表：fin_voucher_rule_master
• 明细表：fin_voucher_rule_detail
• 条件表：fin_voucher_rule_condition

这些表的关系如下：

• 主表与明细表是一对多关系。
• 明细表与条件表也是一对多关系。

数据访问层代码示例

public static List
<MasterEntity> GetMasters(string name)
{
    using (var db = new ContextEntities())
    {
        var query = db.Masters.AsNoTracking();
        if (!string.IsNullOrEmpty(name))
            query = query.Where(x => x.BusinessType.Contains(name));
        return query.ToList();
    }
}

服务层代码示例

public static string GetMastersJson(string name)
{
    var masters = DAL.GetMasters(name);
    var json = SerializationHelper.Serialize(masters, typeof(MasterEntity));
    var resultJson = $"{{\"total\": \"{masters.Count}\", \"rows\": {json}}}";
    return resultJson;
}

当你尝试将查询结果序列化为JSON时，会遇到如下错误：

System.ObjectDisposedException: 此 ObjectContext 实例已释放，不可再用于需要连接的操作。

二、问题原因分析

延迟加载的概念

实体框架（Entity Framework, EF）默认开启延迟加载特性。这意味着当你查询主表时，EF只会返回主表自身的字段数据，而不会立即加载其关联的明细和其他导航属性。

数据上下文释放的问题

当你调用 ToList() 方法后，虽然主表的数据已经被加载到内存中，但是由于using语句的作用范围，数据库连接已经关闭。当序列化器访问导航属性时（如 fin_voucher_rule_detail），EF会尝试去数据库加载这些未加载的属性，但由于上下文已释放，导致异常。

三、解决方案

解决方案一：禁用延迟加载

实现方法：

在创建数据上下文实例后立即关闭延迟加载功能：

using (var db = new ContextEntities())
{
    db.Configuration.LazyLoadingEnabled = false;

    var query = db.Masters.AsNoTracking();
    return query.ToList();
}

优点：简单快捷，避免了不必要的数据库查询。
缺点：如果业务逻辑需要加载导航属性，则需要手动启用 Include 方法。

解决方案二：预加载关联数据（Eager Loading）

实现方法：

使用 Include 和 ThenInclude 预先加载所有相关的导航属性：

public static List
<MasterEntity> GetMasters(string name)
{
    using (var db = new ContextEntities())
    {
        var query = db.Masters.Include(m => m.Details).ThenInclude(d => d.Conditions);
        if (!string.IsNullOrEmpty(name))
            query = query.Where(x => x.BusinessType.Contains(name));
        return query.ToList();
    }
}

优点：确保所有需要的导航属性都已加载，避免序列化时再次访问数据库。
缺点：可能导致不必要的数据量增加。

解决方案三：手动处理导航属性

实现方法：

在查询结果返回后，通过手动设置导航属性为 null 或空集合来避免延迟加载：

public static List
<MasterEntity> GetMasters(string name)
{
    using (var db = new ContextEntities())
    {
        var query = db.Masters.AsNoTracking();
        if (!string.IsNullOrEmpty(name))
            query = query.Where(x => x.BusinessType.Contains(name));

        return query.Select(m =>
        {
            m.Details = null;
            return m;
        }).ToList();
    }
}

优点：灵活性高，可根据具体需求定制。
缺点：代码复杂度增加。

总结

本文详细介绍了JSON序列化时遇到的EF延迟加载错误及其原因，并提供了三种解决方法：

1. 禁用延迟加载
2. 预先加载关联数据（Eager Loading）
3. 手动处理导航属性

根据实际情况选择最合适的方案，可以有效避免该类问题的发生。

方案三：用 DTO 投影（最专业）

不直接返回实体，而是创建一个数据传输对象（DTO），只包含你需要返回的字段。查询时直接投影到 DTO 上，从而完全绕过导航属性。

public class VoucherRuleMasterDto
{
    public int Id { get; set; }
    public string BusinessType { get; set; }
    public List
<VoucherRuleDetailDto> Details { get; set; }
}

public static List
<VoucherRuleMasterDto> GetVoucherRuleMasters(string name)
{
    using (var db = new PcbEntities())
    {
        var query = db.fin_voucher_rule_master.AsNoTracking();
        if (!string.IsNullOrEmpty(name))
            query = query.Where(x => x.business_type.Contains(name));

        return query.Select(m => new VoucherRuleMasterDto
        {
            Id = m.Id,
            BusinessType = m.business_type,
            Details = m.fin_voucher_rule_detail.Select(d => new VoucherRuleDetailDto
            {
                Id = d.Id,
                Condition = d.fin_voucher_rule_condition.Description
            }).ToList()
        }).ToList();
    }
}

优点：

• 减少数据传输量：只返回前端真正需要的数据，降低网络传输负担。
• 解耦数据库模型与API接口：DTO使得后端和前端的交互更加灵活。
• 避免序列化问题：通过投影直接获取所需字段，完全规避了延迟加载带来的麻烦。

缺点：

• 增加代码量：需要额外编写多个 DTO 类来映射实体类的数据结构。
• 维护成本较高：当数据库表结构调整时，DTO类也需要相应调整以保持一致性。

划重点 ：使用 DTO 是最“正统”的做法，在正式项目中推荐采用。实体模型用于持久化存储，而 DTO 则是为前端提供数据接口，两者应当分离以提高应用的模块化和可维护性。

四、EF6 和 EF Core 的 Include/ThenInclude 区别（一张表看懂）

从 EF6 迁移到 EF Core 时，许多人会感到困惑于 ThenInclude。这里总结了一些关键点：

常见问题：

• 编译错误 'Include' does not contain a definition for 'ThenInclude' ：这表示你在使用 EF6，应避免使用 ThenInclude。
• 运行时异常 InvalidOperationException: A second operation started on this context before a previous operation completed ：通常是因为在遍历查询结果过程中触发了延迟加载。确保你已经禁用了延迟加载或者提前使用 Include 进行预加载。

五、最佳实践总结（照着做，不踩坑）

全局关闭延迟加载

在 DbContext 构造函数中添加以下代码：

public PcbEntities()
{
    this.Configuration.LazyLoadingEnabled = false; // EF6
    // 或者使用EF Core的语法规则：
    //this.ChangeTracker.LazyLoadingEnabled = false;
}

使用 AsNoTracking 进行只读查询

对于只读操作，应始终使用 AsNoTracking() 方法来提高性能和减少内存占用。

避免在 using 块外部访问导航属性

为了防止潜在的延迟加载问题，请确保在 using 块内部完成所有序列化或遍历操作。或者，在查询时预先通过 Include 加载关联数据。

优先采用 DTO + 投影模式

这是最推荐的做法，可以保证前后端分离，并减少不必要的数据传输量。

确认 EF 版本

查看项目文件中的配置信息以确定你正在使用的EF版本：

• EntityFramework 包：表示使用的是 EF6。
• Microsoft.EntityFrameworkCore 包：则说明是 EF Core 项目。

六、完整示例（拿来即用）

下面提供了一个兼容 EF6 和 EF Core 的查询实现样例，并通过条件编译来处理两者差异：

public static List<fin_voucher_rule_master> GetFin_Voucher_Rule_Masters(string name)
{
    using (var db = new PcbEntities())
    {
        // 关闭延迟加载功能
        db.Configuration.LazyLoadingEnabled = false;

        var q = db.fin_voucher_rule_master.AsNoTracking();

        // 预加载三层关联数据
#if EF6
        q = q.Include("fin_voucher_rule_detail.fin_voucher_rule_condition");
#else
        q = q.Include(m => m.fin_voucher_rule_detail)
             .ThenInclude(d => d.fin_voucher_rule_condition);
#endif

        if (!string.IsNullOrEmpty(name))
            q = q.Where(x => x.business_type.Contains(name));

        return q.ToList();
    }
}