ASP.NET MVC API如何移除返回模型中的不必要字段？

嘿，这个需求很合理，服务器端处理字段过滤不仅更高效，还能避免客户端额外的代码开销。给你三个实用的方案，你可以根据自己的场景选择：

1. 使用DTO（数据传输对象）【最推荐】 #

这是最规范的做法，通过创建一个只包含需要字段的DTO类，和你的实体类解耦，后续需求变更也更灵活。

步骤： #

• 首先创建一个UserDefaultsDTO类，只保留你想返回的字段：

public class UserDefaultsDTO
{
    // 这里只放你需要返回的字段，比如去掉Id，保留其他业务需要的字段
    public int cId { get; set; }
    public string DefaultTheme { get; set; }
    public bool AutoSaveEnabled { get; set; }
    // 其他你需要的业务字段...
}

• 修改你的API方法，把查询到的实体映射到DTO后返回：

[HttpGet]
public async Task<ActionResult<UserDefaultsDTO>> GetDefaultsAPI()
{
    int ProfileId = GetSelectedProfileIdfromCookie();
    var UserDefaultsModel = await _context.UserDefaults.FirstOrDefaultAsync(m => m.cId == ProfileId);
    
    if (UserDefaultsModel == null)
    {
        return NotFound();
    }
    
    // 手动映射字段到DTO（如果字段多可以用AutoMapper简化）
    var dto = new UserDefaultsDTO
    {
        cId = UserDefaultsModel.cId,
        DefaultTheme = UserDefaultsModel.DefaultTheme,
        AutoSaveEnabled = UserDefaultsModel.AutoSaveEnabled
        // 映射其他需要的字段
    };
    
    return dto;
}

2. 使用匿名类型快速实现 #

如果只是临时需求，不想额外创建DTO类，可以直接在返回时用匿名类型只选择需要的字段：

[HttpGet]
public async Task<ActionResult> GetDefaultsAPI()
{
    int ProfileId = GetSelectedProfileIdfromCookie();
    var UserDefaultsModel = await _context.UserDefaults.FirstOrDefaultAsync(m => m.cId == ProfileId);
    
    if (UserDefaultsModel == null)
    {
        return NotFound();
    }
    
    // 只返回需要的字段
    return Ok(new 
    {
        cId = UserDefaultsModel.cId,
        DefaultTheme = UserDefaultsModel.DefaultTheme,
        AutoSaveEnabled = UserDefaultsModel.AutoSaveEnabled
        // 其他需要的字段
    });
}

3. 使用[JsonIgnore]特性标记不需要的字段 #

如果你的UserDefaults实体类只有这个API在使用，或者全局都不需要返回某些字段，可以直接在实体类的对应字段上添加[JsonIgnore]特性：

public class UserDefaults
{
    // 标记这个字段不被序列化到JSON
    [JsonIgnore]
    public int Id { get; set; }
    
    public int cId { get; set; }
    public string DefaultTheme { get; set; }
    public bool AutoSaveEnabled { get; set; }
    // 其他字段...
}

然后你的API方法可以保持原样，返回实体时会自动忽略标记了[JsonIgnore]的字段。

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