ASP.NET中EntityFramework实现GET请求返回外键关联数据及指定字段

问题原因 #

关联对象返回null是EF Core的默认加载逻辑导致的：FindAsync方法仅会查询Employees主表数据，不会自动加载关联的导航属性EmployeeDepartment，因此该字段返回null。

解决方案1：返回完整关联对象 #

实现方式：贪婪加载（API场景推荐） #

使用Include方法显式指定要加载的关联属性，首先引入所需命名空间：

using Microsoft.EntityFrameworkCore;

修改GET接口代码如下：

[HttpGet("{id}")]
public async Task<ActionResult<Employee>> GetEmployee(int id)
{
    var employee = await _context.Employees
        .Include(e => e.EmployeeDepartment) // 显式加载关联的部门对象
        .FirstOrDefaultAsync(e => e.EmployeeId == id);
    if (employee == null)
    {
        return NotFound();
    }
    return employee;
}

如果更倾向于自动加载关联属性，可安装Microsoft.EntityFrameworkCore.Proxies包，在DbContext配置时开启UseLazyLoadingProxies()即可实现延迟加载，但需要注意避免N+1查询的性能问题。

解决方案2：仅返回指定字段 #

通过投影查询即可实现字段筛选，常用两种实现方式：

方式1：匿名类投影（适合临时简单场景） #

直接用Select方法指定返回字段：

[HttpGet("{id}")]
public async Task<IActionResult> GetEmployeeSimple(int id)
{
    var employee = await _context.Employees
        .Where(e => e.EmployeeId == id)
        .Select(e => new 
        {
            e.EmployeeId,
            e.EmployeeFullName
        })
        .FirstOrDefaultAsync();
    if (employee == null)
    {
        return NotFound();
    }
    return Ok(employee);
}

方式2：DTO类投影（适合正式项目场景） #

先定义专属的传输对象DTO：

public class EmployeeSimpleDto
{
    public int EmployeeId { get; set; }
    public string EmployeeFullName { get; set; }
}

查询时直接映射到DTO：

[HttpGet("{id}")]
public async Task<ActionResult<EmployeeSimpleDto>> GetEmployeeSimple(int id)
{
    var employee = await _context.Employees
        .Where(e => e.EmployeeId == id)
        .Select(e => new EmployeeSimpleDto
        {
            EmployeeId = e.EmployeeId,
            EmployeeFullName = e.EmployeeFullName
        })
        .FirstOrDefaultAsync();
    if (employee == null)
    {
        return NotFound();
    }
    return employee;
}

补充配置（避免循环引用报错） #

如果返回完整关联对象时出现循环引用序列化错误，在.NET 6+的Program.cs中添加如下配置即可：

builder.Services.AddControllers()
    .AddJsonOptions(options =>
    {
        options.JsonSerializerOptions.ReferenceHandler = System.Text.Json.Serialization.ReferenceHandler.IgnoreCycles;
    });

内容的提问来源于stack exchange，提问作者Đạt Nguyễn