ASP.NET Core Web API中读取指定JSON结构值的最佳实现方案是什么

推荐按优先级选择以下方案：

1. 首选：强类型模型绑定（官方最佳实践） #

该方案类型安全、性能最高、编译期即可排查字段匹配问题，是ASP.NET Core的原生推荐实现。

步骤1：定义匹配JSON结构的实体类 #

// 外层请求模型
public class ProfileRequest
{
    // 字段名与JSON键名对应，默认不区分大小写
    public ProfileObj ProfileObj { get; set; }
}

// profileObj 对应的属性模型
public class ProfileObj
{
    public string Name { get; set; }
    public string FirstName { get; set; }
    // 此处与JSON里的FastName对应，若为拼写错误可自行修改
    public string FastName { get; set; }
    public string Email { get; set; }
}

如果JSON键有特殊命名规则，可通过[JsonPropertyName]显式指定映射：

using System.Text.Json.Serialization;

public class ProfileObj
{
    [JsonPropertyName("Name")]
    public string UserName { get; set; }
    // 其余属性同理
}

步骤2：Controller 接口直接绑定模型 #

ASP.NET Core会自动将请求体的JSON反序列化到模型对象，直接读取属性即可：

[ApiController]
[Route("api/[controller]")]
public class ProfileController : ControllerBase
{
    [HttpPost]
    public IActionResult ProcessProfile([FromBody] ProfileRequest request)
    {
        // 直接读取属性值
        var name = request.ProfileObj.Name;
        var email = request.ProfileObj.Email;
        
        // 你的业务逻辑
        return Ok(new { name, email });
    }
}

2. 临时场景：动态解析（无需定义实体类） #

如果只是临时读取少量字段、不想定义模型，可使用.NET 6+ 自带的JsonNode动态解析，无需引入第三方依赖：

[HttpPost]
public IActionResult ProcessProfile([FromBody] JsonNode jsonData)
{
    var profileNode = jsonData["profileObj"];
    // 读取属性时建议做空值判断避免空引用异常
    var name = profileNode?["Name"]?.GetValue<string>();
    var email = profileNode?["Email"]?.GetValue<string>();
    
    return Ok(new { name, email });
}

如果项目用的是Newtonsoft.Json，也可以用JObject解析：

[HttpPost]
public IActionResult ProcessProfile([FromBody] JObject jsonData)
{
    var name = jsonData["profileObj"]?["Name"]?.Value<string>();
    var email = jsonData["profileObj"]?["Email"]?.Value<string>();
    
    return Ok(new { name, email });
}

注意：动态解析只适合非高频、字段不固定的临时场景，生产环境优先用强类型绑定。

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