EF Core下如何强类型标记服务所需预加载的导航属性？

问题背景 #

在启用显式空值检查的ASP.NET Core应用，且使用配置了预加载的EF Core环境中，业务层服务要求传入的实体参数必须已预加载指定的非空导航属性，但当前存在以下痛点：

• 实体的导航属性被声明为非可空（如BlogEntry的Author author），编译器不会检测未预加载的情况，但EF Core会将未预加载的属性设为null!，运行时访问会抛出异常。
• 直接传入ID让服务自行查询的方案，无法复用已查询的数据集，导致重复查询。
• 创建子类（如BlogEntryWithPreloadedAuthor）的方式，面对嵌套预加载时扩展性极差。
• 仅靠文档说明无法通过编译器强制执行约束，重构时容易出错。

服务接口示例：

interface IBlogInterface
{
  int GetInfoAboutBlogEntry(BlogEntry entry);
}

要求传入的BlogEntry必须已通过.Include(x=>x.Author)预加载Author属性。

方案1：使用“已加载标记”结构体封装实体 #

通过泛型标记结构体明确表示实体的指定导航属性已预加载，让编译器强制约束调用方必须传入正确标记的实例。

实现步骤 #

1. 定义泛型标记结构体与辅助方法：

public readonly struct EntityWithLoaded<TEntity, TLoadedProps>
    where TEntity : class
{
    public TEntity Entity { get; }

    // 私有构造，仅允许通过静态方法创建，确保加载逻辑被执行
    private EntityWithLoaded(TEntity entity)
    {
        Entity = entity ?? throw new ArgumentNullException(nameof(entity));
    }

    // 标记单个导航属性已加载的方法
    public static EntityWithLoaded<TEntity, TLoadedProps> Create<TProp>(
        TEntity entity,
        Expression<Func<TEntity, TProp>> navigationProperty)
        where TProp : class
    {
        // 运行时验证属性是否已加载（可选，增强安全性）
        if (!EF.Property<bool>(entity, navigationProperty.GetMemberAccess().Name))
        {
            throw new InvalidOperationException($"导航属性 {navigationProperty.GetMemberAccess().Name} 未预加载");
        }
        return new EntityWithLoaded<TEntity, TLoadedProps>(entity);
    }

    // 标记多个导航属性已加载的重载
    public static EntityWithLoaded<TEntity, TLoadedProps> Create<TProp1, TProp2>(
        TEntity entity,
        Expression<Func<TEntity, TProp1>> nav1,
        Expression<Func<TEntity, TProp2>> nav2)
        where TProp1 : class
        where TProp2 : class
    {
        if (!EF.Property<bool>(entity, nav1.GetMemberAccess().Name))
            throw new InvalidOperationException($"导航属性 {nav1.GetMemberAccess().Name} 未预加载");
        if (!EF.Property<bool>(entity, nav2.GetMemberAccess().Name))
            throw new InvalidOperationException($"导航属性 {nav2.GetMemberAccess().Name} 未预加载");
        return new EntityWithLoaded<TEntity, TLoadedProps>(entity);
    }
}

// 辅助扩展方法：获取表达式的成员名称
public static class ExpressionExtensions
{
    public static MemberInfo GetMemberAccess(this Expression expression)
    {
        if (expression is LambdaExpression lambda)
            expression = lambda.Body;
        if (expression is MemberExpression memberExpr)
            return memberExpr.Member;
        throw new ArgumentException("表达式不是成员访问表达式");
    }
}

2. 修改服务接口，要求传入标记结构体：

// 定义空标记类，标识已加载Author属性
public class BlogEntryLoadedAuthor { }

interface IBlogInterface
{
    int GetInfoAboutBlogEntry(EntityWithLoaded<BlogEntry, BlogEntryLoadedAuthor> entry);
}

3. 调用方使用方式：

// 查询时预加载Author
var blogEntry = await dbContext.BlogEntries
    .Include(x => x.Author)
    .FirstAsync(x => x.Id == blogId);

// 创建标记实例，编译器会强制要求必须经过此步骤
var loadedEntry = EntityWithLoaded<BlogEntry, BlogEntryLoadedAuthor>.Create(blogEntry, x => x.Author);

// 调用服务，此时编译器会检查传入的是否为正确标记的实例
blogService.GetInfoAboutBlogEntry(loadedEntry);

优势 #

• 编译时强制约束：未使用正确标记结构体的调用会直接编译报错。
• 扩展性好：嵌套预加载可通过组合标记类实现（如BlogEntryLoadedAuthorAndComments）。
• 可选运行时验证：即使绕过编译约束（如反射），也能在运行时检查属性是否已加载。

方案2：使用接口分离实体的加载状态 #

为不同的加载状态定义接口，让实体实现这些接口，通过接口约束服务的参数类型。

实现步骤 #

1. 定义表示已加载导航属性的接口：

// 表示已加载Author属性的接口
public interface IBlogEntryWithAuthorLoaded
{
    Author Author { get; }
}

// 原始实体类实现该接口
public class BlogEntry : IBlogEntryWithAuthorLoaded
{
    public int Id { get; set; }
    public Author Author { get; set; } = null!; // 保持非可空声明
    // 其他属性...
}

2. 修改服务接口，要求传入实现对应接口的实体：

interface IBlogInterface
{
    int GetInfoAboutBlogEntry(IBlogEntryWithAuthorLoaded entry);
}

3. 服务内部添加运行时验证：

public class BlogService : IBlogInterface
{
    public int GetInfoAboutBlogEntry(IBlogEntryWithAuthorLoaded entry)
    {
        // 验证Author是否已被EF Core加载
        if (!EF.IsLoaded(((BlogEntry)entry).Author))
        {
            throw new InvalidOperationException("BlogEntry的Author属性未预加载");
        }
        // 业务逻辑...
        return entry.Author.Id;
    }
}

优势 #

• 实现简单，无需额外结构体。
• 接口可组合（如IBlogEntryWithAuthorAndCommentsLoaded）。
• 配合运行时验证，避免空引用异常。

方案3：使用记录类型传递投影数据 #

如果不需要完整实体，直接投影成业务所需的记录类型，从根源避免导航属性未加载的问题。

实现步骤 #

1. 定义业务所需的记录类型：

public record BlogEntryInfo(int BlogId, int AuthorId, string AuthorName);

2. 修改服务接口，接收投影后的记录：

interface IBlogInterface
{
    int GetInfoAboutBlogEntry(BlogEntryInfo entryInfo);
}

3. 调用方查询时直接投影：

var blogEntryInfo = await dbContext.BlogEntries
    .Where(x => x.Id == blogId)
    .Select(x => new BlogEntryInfo(x.Id, x.Author.Id, x.Author.Name))
    .FirstAsync();

blogService.GetInfoAboutBlogEntry(blogEntryInfo);

优势 #

• 完全避免导航属性加载问题，直接获取所需数据。
• 数据传输更轻量，只传递业务需要的字段。
• 编译器完全约束，不存在空引用风险。

总结 #

• 若需复用完整实体，优先选择方案1，通过标记结构体实现编译时强制约束，兼顾运行时验证。
• 若追求实现简单，可选择方案2，配合运行时检查确保属性已加载。
• 若不需要完整实体，推荐方案3，使用投影记录类型彻底解决问题。

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