API控制器调用出现循环引用，如何通过DTO解决？

问题根源 #

你的Piece和Publisher实体互相包含对方的引用，序列化接口返回结果时会触发无限递归，导致循环引用错误。用DTO（数据传输对象）可以精准控制返回字段，切断循环链。

实现步骤 #

1. 创建DTO类 #

定义仅包含接口所需字段的DTO，避免双向引用：

namespace MusicManager.Shared.DTOs
{
    // 用于GetAllPieces接口的DTO
    public class PieceDto
    {
        public int Id { get; set; }
        public string Title { get; set; } = string.Empty;
        // 只返回Publisher的基础信息，不包含Pieces列表
        public PublisherBasicDto? Publisher { get; set; }
    }

    // Publisher基础信息DTO
    public class PublisherBasicDto
    {
        public int Id { get; set; }
        public string Name { get; set; } = string.Empty;
    }

    // 用于GetAllPublishers接口的DTO（可选）
    public class PublisherDto
    {
        public int Id { get; set; }
        public string Name { get; set; } = string.Empty;
        // 只返回Piece的基础信息，不包含Publisher引用
        public List<PieceBasicDto>? Pieces { get; set; }
    }

    // Piece基础信息DTO
    public class PieceBasicDto
    {
        public int Id { get; set; }
        public string Title { get; set; } = string.Empty;
    }
}

2. 修改控制器方法：手动转换实体到DTO #

如果不想用第三方库，直接在控制器里手动映射字段：

public async Task<ServiceResponse<List<PieceDto>>> GetAllPieces(bool order)
{
    var query = _dataContext.Pieces.Include(x => x.Publisher);
    
    if (order)
    {
        query = query.OrderBy(x => x.Title);
    }
    
    var pieces = await query.ToListAsync();
    
    var response = new ServiceResponse<List<PieceDto>>
    {
        Data = pieces.Select(p => new PieceDto
        {
            Id = p.Id,
            Title = p.Title,
            Publisher = p.Publisher != null ? new PublisherBasicDto
            {
                Id = p.Publisher.Id,
                Name = p.Publisher.Name
            } : null
        }).ToList()
    };

    return response;
}

// 同理修改GetAllPublishers方法
public async Task<ServiceResponse<List<PublisherDto>>> GetAllPublishers(bool order)
{
    var query = _dataContext.Publishers.Include(x => x.Pieces);
    
    if (order)
    {
        query = query.OrderBy(x => x.Name);
    }
    
    var publishers = await query.ToListAsync();
    
    var response = new ServiceResponse<List<PublisherDto>>
    {
        Data = publishers.Select(pub => new PublisherDto
        {
            Id = pub.Id,
            Name = pub.Name,
            Pieces = pub.Pieces?.Select(p => new PieceBasicDto
            {
                Id = p.Id,
                Title = p.Title
            }).ToList()
        }).ToList()
    };

    return response;
}

3. 可选：用AutoMapper简化映射 #

如果项目中有大量实体需要转换，用AutoMapper可以减少重复代码：

配置AutoMapper映射

namespace MusicManager.Shared.Mapping
{
    public class MappingProfile : Profile
    {
        public MappingProfile()
        {
            CreateMap<Piece, PieceDto>();
            CreateMap<Publisher, PublisherBasicDto>();
            
            CreateMap<Publisher, PublisherDto>();
            CreateMap<Piece, PieceBasicDto>();
        }
    }
}

在控制器中使用AutoMapper

private readonly IMapper _mapper;

// 构造函数注入IMapper
public YourController(DataContext dataContext, IMapper mapper)
{
    _dataContext = dataContext;
    _mapper = mapper;
}

public async Task<ServiceResponse<List<PieceDto>>> GetAllPieces(bool order)
{
    var query = _dataContext.Pieces.Include(x => x.Publisher);
    
    if (order)
    {
        query = query.OrderBy(x => x.Title);
    }
    
    var pieces = await query.ToListAsync();
    
    var response = new ServiceResponse<List<PieceDto>>
    {
        Data = _mapper.Map<List<PieceDto>>(pieces)
    };

    return response;
}

关键注意点 #

• DTO只保留前端需要的字段，避免冗余数据
• 实体查询时仅IncludeDTO需要的关联数据，减少数据库查询开销
• 确保DTO之间没有双向引用，彻底切断循环链

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