配置 EF 在访问导航属性未急切加载（且延迟加载已禁用）时抛出异常

Question

我们有一些应用程序当前正在使用启用了延迟加载的 EF 模型。当我关闭延迟加载（以避免隐式加载和我们的大多数 N+1 选择）时，我宁愿访问应该已经热切加载（或在引用上手动 Load() ）抛出异常而不是返回 null（因为特定的异常比 null 引用更好、更容易调试）。

我目前倾向于仅修改 t4 模板来执行此操作（因此，如果 reference.IsLoaded == false，则抛出），但想知道这是否已经是一个已解决的问题，无论是在框中还是通过另一个项目。

任何对可以进行源分析并检测此类问题的插件/扩展/等的引用的奖励积分。 :)

Answer 1

出于几个与性能相关的原因，我想做同样的事情（引发延迟加载） - 我想避免同步查询，因为它们会阻塞线程，并且在某些地方我想避免加载完整的实体，而只是加载属性代码需要的。

仅禁用延迟加载还不够好，因为某些实体具有可以合法为 null 的属性，并且我不想将“null 因为它是 null”与“null 因为我们决定不加载它”混淆。

我还只想选择性地在某些特定的代码路径中启用延迟加载，我知道延迟加载是有问题的。

以下是我的解决方案。

在我的 DbContext 类中，添加此属性：

class AnimalContext : DbContext
{
   public bool ThrowOnSyncQuery { get; set; }
}

在代码启动的某个位置，运行以下命令：

// Optionally don't let EF execute sync queries
DbInterception.Add(new ThrowOnSyncQueryInterceptor());

ThrowOnSyncQueryInterceptor 的代码如下：

public class ThrowOnSyncQueryInterceptor : IDbCommandInterceptor
{
    public void NonQueryExecuting(DbCommand command, DbCommandInterceptionContext<int> interceptionContext)
    {
        OptionallyThrowOnSyncQuery(interceptionContext);
    }

    public void NonQueryExecuted(DbCommand command, DbCommandInterceptionContext<int> interceptionContext)
    {
    }

    public void ReaderExecuting(DbCommand command, DbCommandInterceptionContext<DbDataReader> interceptionContext)
    {
        OptionallyThrowOnSyncQuery(interceptionContext);
    }

    public void ReaderExecuted(DbCommand command, DbCommandInterceptionContext<DbDataReader> interceptionContext)
    {
    }

    public void ScalarExecuting(DbCommand command, DbCommandInterceptionContext<object> interceptionContext)
    {
        OptionallyThrowOnSyncQuery(interceptionContext);
    }

    public void ScalarExecuted(DbCommand command, DbCommandInterceptionContext<object> interceptionContext)
    {
    }

    private void OptionallyThrowOnSyncQuery<T>(DbCommandInterceptionContext<T> interceptionContext)
    {
        // Short-cut return on async queries.
        if (interceptionContext.IsAsync)
        {
            return;
        }

        // Throw if ThrowOnSyncQuery is enabled
        AnimalContext context = interceptionContext.DbContexts.OfType<AnimalContext>().SingleOrDefault();
        if (context != null && context.ThrowOnSyncQuery)
        {
            throw new InvalidOperationException("Sync query is disallowed in this context.");
        }
    }
}

然后在使用 AnimalContext 的代码中

using (AnimalContext context = new AnimalContext(_connectionString))
{
    // Disable lazy loading and sync queries in this code path
    context.ThrowOnSyncQuery = true;

    // Async queries still work fine
    var dogs = await context.Dogs.Where(d => d.Breed == "Corgi").ToListAsync();

    // ... blah blah business logic ...
}

Answer 2

jamesmanning，该项目的创建者 https://github.com/jamesmanning/EntityFramework.LazyLoadLoggingInterceptor ，通过读取堆栈跟踪设法拦截延迟加载的调用。

因此，您可以创建执行以下操作的 DbCommandInterceptor：

    public override void ReaderExecuting(DbCommand command, DbCommandInterceptionContext<DbDataReader> interceptionContext)
    {
        // unfortunately not a better way to detect whether the load is lazy or explicit via interceptor
        var stackFrames = new StackTrace(true).GetFrames();
        var stackMethods = stackFrames?.Select(x => x.GetMethod()).ToList();

        var dynamicProxyPropertyGetterMethod = stackMethods?
            .FirstOrDefault(x =>
                x.DeclaringType?.FullName.StartsWith("System.Data.Entity.DynamicProxies") == true &&
                x.Name.StartsWith("get_"));

        if (dynamicProxyPropertyGetterMethod != null)
        {
              throw new LazyLoadingDisallowedException();
        }

我知道读取堆栈跟踪帧可能会很昂贵，尽管我猜测在发生数据访问的正常情况下，与数据访问本身相比，成本可以忽略不计。但是，您需要亲自评估此方法的性能。

（顺便说一句，您所追求的是 NHibernate 多年来拥有的众多出色功能之一）。

Answer 3

您不必修改 T4。根据提及“T4”，我猜测您正在使用 EDMX。容器的属性窗口具有lazyloadingenabled属性。当您创建新模型时，它被设置为 true。您可以将其更改为 false。 T4 模板将看到这一点并将代码添加到 ctor 中。

此外，如果您使用 Microsoft 的 POCO 模板，他们会将 virtual 关键字添加到您的导航属性中。 virtual+lazyloadingenabled是实现延迟加载的必要组合。如果删除 virtual 关键字，则即使启用了延迟加载，该属性也永远不会延迟加载。

哈
朱莉