如何在EF Core的JSON响应中排除冗余外键？

一、移除重复的PlayerModeId #

有两种常用方案可以实现：

1. 通过序列化特性忽略外键
   直接在Game类的PlayerModeId属性上标记[JsonIgnore]，序列化时会自动跳过该属性：

public class Game
{
    [Key]
    public string Id { get; set; } = Guid.NewGuid().ToString();

    public required string Name { get; set; }

    [JsonIgnore] // 添加该特性
    public int PlayerModeId { get; set; }
    public Mode? PlayerMode { get; set; }
}

注意：此方式全局生效，若仅需在特定查询场景忽略外键，建议使用下面的投影方案。

2. EF Core投影查询过滤字段
   查询时通过匿名类或DTO只返回需要的字段，主动排除PlayerModeId：

var games = context.Game
    .Include(x => x.PlayerMode)
    .Select(g => new 
    {
        g.Id,
        g.Name,
        PlayerMode = g.PlayerMode
    })
    .ToList();

序列化该查询结果，将不会出现PlayerModeId字段。

二、直接返回PlayerMode: "Single"格式 #

如果希望把嵌套的PlayerMode属性值直接提取为顶级字段，用投影查询即可实现：

var games = context.Game
    .Include(x => x.PlayerMode)
    .Select(g => new 
    {
        g.Id,
        g.Name,
        PlayerMode = g.PlayerMode.PlayerMode
    })
    .ToList();

此时生成的JSON结构为：

{
    "Id": "xxx",
    "Name": "游戏名称",
    "PlayerMode": "Single"
}

若需要在实体类层面固定这个格式，可以添加计算属性并忽略原有的外键和导航属性：

public class Game
{
    [Key]
    public string Id { get; set; } = Guid.NewGuid().ToString();

    public required string Name { get; set; }

    [JsonIgnore]
    public int PlayerModeId { get; set; }
    
    [JsonIgnore]
    public Mode? PlayerMode { get; set; }

    [JsonPropertyName("PlayerMode")]
    public string PlayerModeName => PlayerMode?.PlayerMode ?? string.Empty;
}

查询后序列化，会直接输出PlayerMode字段对应字符串值。

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