C# .NET Web API中GET方法关联数据返回问题求助

模型代码 #

User模型 #

namespace Sims.Models
{
    public partial class User
    {
        public User()
        {
            DataUsages = new HashSet<DataUsage>();
        }

        public long IdUser { get; set; }
        public int UserProfessionId { get; set; }
        public int UserProfessionFieldId { get; set; }
        public string? UserName { get; set; }
        public string? UserMail { get; set; }
        public string? UserCompany { get; set; }
        public byte[]? UserPicture { get; set; }

        public virtual Profession UserProfession { get; set; } = null!;
        public virtual ProfessionField UserProfessionField { get; set; } = null!;
        public virtual ICollection<DataUsage> DataUsages { get; set; }
    }
}

Profession模型 #

namespace Sims.Models
{
    public partial class Profession
    {
        public Profession()
        {
            ProfessionFields = new HashSet<ProfessionField>();
            Users = new HashSet<User>();
        }

        public int IdProfession { get; set; }
        public string ProfessionName { get; set; } = null!;

        public virtual ICollection<ProfessionField> ProfessionFields { get; set; }
        public virtual ICollection<User> Users { get; set; }
    }
}

遇到的问题 #

1. 自动生成的GET方法仅返回用户基础信息，UserProfession字段为null（数据库中外键字段非空）：

   {
       "idUser": 1,
       "userProfessionId": 1,
       "userProfessionFieldId": 1,
       "userName": "user_test",
       "userMail": "mail@test.com",
       "userCompany": "TestCompany",
       "userPicture": null,
       "userProfession": null,
       "userProfessionField": null,
       "dataUsages": []
     }
   

   对应代码：

   [HttpGet]
   public async Task<ActionResult<IEnumerable<User>>> GetUsers()
   {
       return await _context.Users.ToListAsync();
   }
   

2. 使用Include加载UserProfession时，出现对象循环引用问题：

   [HttpGet]
   public async Task<ActionResult<IEnumerable<User>>> GetUsers()
   {
       return await _context.Users.Include(u => u.UserProfession)
           .ToListAsync();
   }
   

3. 尝试用Select筛选数据时出现编译错误：

   • 匿名类型写法：提示“无法将匿名类型转换为User模型”

     [HttpGet]
     public async Task<ActionResult<IEnumerable<User>>> GetUsers()
     {
         return await _context.Users
             .Select(u => new {
                 u.IdUser,
                 u.UserName,
                 u.UserMail,
                 u.UserCompany,
                 u.UserProfessionId,
                 u.UserProfession
             })
             .ToListAsync();
     }
     

   • 直接初始化User写法：提示“无法使用集合初始化器初始化类型User，因为它未实现System.Collections.IEnumerable”

     [HttpGet]
     public async Task<ActionResult<IEnumerable<User>>> GetUsers()
     {
         return await _context.Users
             .Select(u => new User {
                 u.IdUser,
                 u.UserName,
                 u.UserMail,
                 u.UserCompany,
                 u.UserProfessionId,
                 u.UserProfession
             })
             .ToListAsync();
     }
     

解决思路与方案 #

1. 解决关联数据加载问题 #

EF Core默认采用懒加载（需额外配置），若未显式指定加载关联数据，UserProfession等导航属性会是null。必须用Include进行急加载才能获取关联数据，这是正确的做法，但需要处理循环引用。

2. 处理对象循环引用 #

循环引用是因为User包含Profession，而Profession又包含ICollection<User>，序列化时会无限递归，有两种解决方式：

方式一：配置Json序列化忽略循环

在Program.cs（或Startup.cs）中添加Json序列化配置，忽略循环引用：

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

此方法简单，但直接返回实体模型可能暴露不必要的字段，也不利于API版本控制。

方式二：使用DTO（数据传输对象）【推荐】

创建与实体模型分离的DTO，只包含API需要返回的字段，避免循环引用和数据泄露：

// UserDto.cs
public class UserDto
{
    public long IdUser { get; set; }
    public string? UserName { get; set; }
    public string? UserMail { get; set; }
    public string? UserCompany { get; set; }
    public int UserProfessionId { get; set; }
    public ProfessionDto? UserProfession { get; set; }
}

// ProfessionDto.cs
public class ProfessionDto
{
    public int IdProfession { get; set; }
    public string ProfessionName { get; set; } = null!;
    // 不包含Users集合，避免循环引用
}

修改GET方法，映射实体到DTO：

[HttpGet]
public async Task<ActionResult<IEnumerable<UserDto>>> GetUsers()
{
    return await _context.Users
        .Include(u => u.UserProfession)
        .Select(u => new UserDto
        {
            IdUser = u.IdUser,
            UserName = u.UserName,
            UserMail = u.UserMail,
            UserCompany = u.UserCompany,
            UserProfessionId = u.UserProfessionId,
            UserProfession = new ProfessionDto
            {
                IdProfession = u.UserProfession.IdProfession,
                ProfessionName = u.UserProfession.ProfessionName
            }
        })
        .ToListAsync();
}

若项目中映射逻辑复杂，可使用AutoMapper库简化实体与DTO的映射。

3. 修复Select的编译错误 #

• 匿名类型问题：方法返回类型声明为IEnumerable<User>，但匿名类型与User类型不匹配，需改为返回IEnumerable<object>或DTO类型。
• 对象初始化器错误：初始化User时不能用集合初始化器语法，需显式为属性赋值：

  new User {
      IdUser = u.IdUser,
      UserName = u.UserName,
      UserMail = u.UserMail,
      UserCompany = u.UserCompany,
      UserProfessionId = u.UserProfessionId,
      UserProfession = u.UserProfession
  }
  

  但此写法仍会存在循环引用问题，建议优先使用DTO。

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