如何为自定义Entity Framework IncludeAll()方法添加[MemberNotNull]特性？

[MemberNotNull]之所以无效，是因为它作用于方法返回的实例成员，但你的IncludeAll返回的是IQueryable<Event>，编译器无法从这个查询对象的调用推断出最终返回的Event实例的属性会被填充为非空。以下是几种可行的解决办法：

方案一：封装带断言的查询方法（推荐） #

创建一个直接返回Event实例的异步扩展方法，在方法内部获取实例后，通过断言或异常确保目标属性非空，再用[MemberNotNullWhen]特性告诉编译器：当返回值不为null时，这些属性一定非空。

using System.Diagnostics;
using System.Diagnostics.CodeAnalysis;
using Microsoft.EntityFrameworkCore;

[MemberNotNullWhen(true, nameof(Event.Description), nameof(Event.Tags), nameof(Event.Thumbnail))]
public static async Task<Event?> GetEventWithAllIncludesAsync(this IQueryable<Event> source, int eventId)
{
    var ev = await source
        .Include(e => e.Description)
        .Include(e => e.Tags)
        .Include(e => e.Thumbnail)
        .FirstOrDefaultAsync(e => e.Id == eventId);

    if (ev != null)
    {
        // Debug模式下断言，Release模式下抛出异常确保运行时非空
        Debug.Assert(ev.Description != null, "Description未被正确加载");
        Debug.Assert(ev.Tags != null, "Tags未被正确加载");
        Debug.Assert(ev.Thumbnail != null, "Thumbnail未被正确加载");

        ev.Description ?? throw new InvalidOperationException("查询时未正确包含Description属性");
        ev.Tags ?? throw new InvalidOperationException("查询时未正确包含Tags属性");
        ev.Thumbnail ?? throw new InvalidOperationException("查询时未正确包含Thumbnail属性");
    }

    return ev;
}

使用方式：

_event = await dbContext.Events.GetEventWithAllIncludesAsync(pkEvent);
if (_event != null)
{
    // 此处编译器会自动识别_event.Description、Tags、Thumbnail为非空，无警告
    var descText = _event.Description.Text;
}

方案二：配置实体模型为非可空属性 #

如果你的数据库中Description、Tags、Thumbnail字段本身就是必填的，可以直接将实体类的这些属性声明为非可空类型，并在EF Core模型配置中标记为必填。

实体类修改： #

public class Event
{
    public int Id { get; set; }
    // 去掉?，声明为非可空
    public Description Description { get; set; }
    public List<Tag> Tags { get; set; }
    public Thumbnail Thumbnail { get; set; }
}

EF Core模型配置： #

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity<Event>()
        .Property(e => e.Description)
        .IsRequired();
        
    modelBuilder.Entity<Event>()
        .Property(e => e.Tags)
        .IsRequired();
        
    modelBuilder.Entity<Event>()
        .Property(e => e.Thumbnail)
        .IsRequired();
}

这种方式的风险是：如果忘记调用IncludeAll，EF Core在未开启延迟加载的情况下会返回null属性，导致运行时异常。适合能严格保证每次查询都包含关联属性的场景。

方案三：投影到非空DTO #

创建一个包含所有必填关联属性的DTO类，通过EF Core的投影查询直接返回该DTO，避免空值警告。

定义DTO： #

public class EventWithAllIncludesDto
{
    public int Id { get; set; }
    public Description Description { get; set; }
    public List<Tag> Tags { get; set; }
    public Thumbnail Thumbnail { get; set; }
}

扩展方法： #

public static IQueryable<EventWithAllIncludesDto> ProjectToEventWithAllIncludes(this IQueryable<Event> source)
{
    return source.Select(e => new EventWithAllIncludesDto
    {
        Id = e.Id,
        Description = e.Description,
        Tags = e.Tags,
        Thumbnail = e.Thumbnail
    });
}

使用方式： #

_eventDto = await dbContext.Events
    .ProjectToEventWithAllIncludes()
    .FirstOrDefaultAsync(e => e.Id == pkEvent);

if (_eventDto != null)
{
    // DTO属性均为非可空，无警告
}

这种方式需要维护DTO类，但能彻底分离数据模型和业务模型，适合复杂场景。

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