如何在ASP.NET Web API中根据条件动态返回模型可选属性

当然可以在控制器或业务逻辑层实现动态返回不同属性的需求，不需要依赖模型类上的JsonIgnore属性，以下是几种可行的方案：

方案一：控制器层直接返回匿名类型 #

这是最直接的方式，根据条件创建包含指定属性的匿名对象返回，无需额外定义类：

[HttpGet]
public IActionResult GetEmployee(string condition)
{
    // 假设从数据库或业务层获取模型实例
    var employee = GetEmployeeFromDataSource();

    if (condition == "Condition1")
    {
        return Ok(new 
        { 
            employee.EmpID, 
            employee.Email 
        });
    }
    else if (condition == "Condition2")
    {
        return Ok(new 
        { 
            employee.EmpID, 
            employee.Mobile, 
            employee.Email 
        });
    }
    else
    {
        // 其他情况返回完整模型
        return Ok(employee);
    }
}

方案二：业务层使用DTO（数据传输对象）映射 #

通过定义不同的DTO类对应不同的返回结构，在业务层完成模型到DTO的映射，控制器返回对应的DTO：

1. 定义DTO类 #

// 对应条件1的返回结构
public class EmployeeBasicDto
{
    public string EmpID { get; set; }
    public string Email { get; set; }
}

// 对应条件2的返回结构（继承基础DTO减少重复）
public class EmployeeContactDto : EmployeeBasicDto
{
    public string Mobile { get; set; }
}

// 对应完整属性的返回结构
public class EmployeeFullDto : EmployeeContactDto
{
    public string OfficeAddress { get; set; }
    public string City { get; set; }
    public string State { get; set; }
}

2. 业务层映射逻辑 #

public class EmployeeService
{
    public object GetEmployeeResponse(string condition, Employee model)
    {
        if (condition == "Condition1")
        {
            return new EmployeeBasicDto
            {
                EmpID = model.EmpID,
                Email = model.Email
            };
        }
        else if (condition == "Condition2")
        {
            return new EmployeeContactDto
            {
                EmpID = model.EmpID,
                Mobile = model.Mobile,
                Email = model.Email
            };
        }
        else
        {
            return new EmployeeFullDto
            {
                EmpID = model.EmpID,
                Mobile = model.Mobile,
                Email = model.Email,
                OfficeAddress = model.OfficeAddress,
                City = model.City,
                State = model.State
            };
        }
    }
}

3. 控制器调用 #

[HttpGet]
public IActionResult GetEmployee(string condition)
{
    var employee = GetEmployeeFromDataSource();
    var response = _employeeService.GetEmployeeResponse(condition, employee);
    return Ok(response);
}

方案三：使用JsonSerializerOptions动态忽略属性（.NET Core/.NET 5+） #

通过配置JSON序列化选项，动态指定需要忽略的属性，适合不想创建额外类的场景：

[HttpGet]
public IActionResult GetEmployee(string condition)
{
    var employee = GetEmployeeFromDataSource();
    var serializerOptions = new JsonSerializerOptions();

    if (condition == "Condition1")
    {
        // 忽略不需要的属性
        serializerOptions.IgnoreProperties.Add(nameof(Employee.Mobile));
        serializerOptions.IgnoreProperties.Add(nameof(Employee.OfficeAddress));
        serializerOptions.IgnoreProperties.Add(nameof(Employee.City));
        serializerOptions.IgnoreProperties.Add(nameof(Employee.State));
    }
    else if (condition == "Condition2")
    {
        serializerOptions.IgnoreProperties.Add(nameof(Employee.OfficeAddress));
        serializerOptions.IgnoreProperties.Add(nameof(Employee.City));
        serializerOptions.IgnoreProperties.Add(nameof(Employee.State));
    }
    // 其他情况不配置忽略，返回完整属性

    return Json(employee, serializerOptions);
}

方案对比 #

• 匿名类型：实现简单快速，无需额外代码，但缺乏强类型支持，后续维护或扩展不便。
• DTO方式：强类型，结构清晰，适合复杂业务场景和长期维护，缺点是需要定义多个DTO类。
• JsonSerializerOptions：无需额外类，通过配置实现动态忽略，适合属性数量不多的场景，属性较多时忽略列表会冗长。

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