c后台怎么接受json字符串

C#后台如何高效接收与解析JSON字符串：从基础到实践**

在现代Web开发中，JSON（JavaScript Object Notation）因其轻量级、易读和易于解析的特性，已成为前后端数据交换的主流格式，作为.NET开发者，如何在C#后台接收并处理JSON字符串是一项必备技能，本文将详细介绍几种在C#后台接收和解析JSON字符串的常用方法，从基础的System.Web.HttpUtility到强大的第三方库如Newtonsoft.Json（Json.NET）和System.Text.Json,并提供实际代码示例。

准备工作：定义对应的C#模型类

无论使用哪种方法，当JSON字符串结构较为复杂时，最推荐的方式是先在C#中定义一个与JSON结构对应的模型类（也称为DTO或Poco类），这样，解析后的数据可以自动映射到这些对象中,方便后续处理。

如果前端发送的JSON字符串如下：

{
  "name": "张三",
  "age": 30,
  "email": "zhangsan@example.com",
  "isStudent": false
}

我们可以在C#中定义如下模型类：

public class UserInfo
{
    public string Name { get; set; }
    public int Age { get; set; }
    public string Email { get; set; }
    public bool IsStudent { get; set; }
}

注意：JSON属性名与C#属性名默认不区分大小写，如果希望严格区分，可以在模型类属性上使用特性（如[JsonPropertyName("name")]，具体取决于使用的库）。

接收JSON字符串的方式

在C#后台，JSON字符串通常通过HTTP请求的正文（Body）发送过来，不同的应用框架（如ASP.NET Web API, ASP.NET Core MVC, Razor Pages等）获取请求正文的方式略有不同，但核心都是读取Request.Body或Request.Form等。

以ASP.NET Core Controller为例,接收JSON字符串通常有以下几种场景：

1. 直接作为字符串接收：如果只是需要获取原始的JSON字符串,而不立即解析。
2. 通过模型绑定直接接收为对象：框架会自动将请求体中的JSON字符串解析为指定的模型对象。

解析JSON字符串的常用方法

使用 System.Text.Json (推荐，.NET Core 3.0+ 及 .NET 5/6/7+ 内置)

System.Text.Json 是.NET官方推出的高性能JSON库，无需额外安装（在较新.NET版本中）。

直接解析字符串到对象

using System.Text.Json;
using Microsoft.AspNetCore.Mvc;
[ApiController]
[Route("api/[controller]")]
public class UsersController : ControllerBase
{
    [HttpPost("userinfo")]
    public IActionResult ReceiveUserInfo([FromBody] JsonElement jsonElement)
    {
        // 如果先接收为JsonElement，可以灵活处理
        string name = jsonElement.GetProperty("name").GetString();
        int age = jsonElement.GetProperty("age").GetInt32();
        // 或者直接接收为模型对象（更推荐）
        // [FromBody] UserInfo userInfo
        // 这种方式框架会自动解析
        return Ok($"Received: {name}, {age}");
    }
    [HttpPost("userinfo-direct")]
    public IActionResult ReceiveUserInfoDirect([FromBody] UserInfo userInfo)
    {
        // 框架自动将请求体的JSON字符串解析为UserInfo对象
        if (userInfo != null)
        {
            return Ok($"Received User: {userInfo.Name}, Age: {userInfo.Age}, Email: {userInfo.Email}");
        }
        return BadRequest("Invalid user data.");
    }
}

手动解析示例（如果已经获取到JSON字符串）：

string jsonString = "{\"name\":\"李四\",\"age\":25,\"email\":\"lisi@example.com\",\"isStudent\":true}";
UserInfo userInfo = JsonSerializer.Deserialize<UserInfo>(jsonString);
if (userInfo != null)
{
    Console.WriteLine($"Name: {userInfo.Name}");
}

配置选项（如大小写不敏感、忽略Null值等）：

var options = new JsonSerializerOptions
{
    PropertyNameCaseInsensitive = true, // 属性名不区分大小写
    IgnoreNullValues = true           // 忽略JSON中的null值
};
UserInfo userInfo = JsonSerializer.Deserialize<UserInfo>(jsonString, options);

使用 Newtonsoft.Json (经典，功能强大)

Newtonsoft.Json（又称Json.NET）是.NET生态中使用最广泛的JSON库，功能非常丰富，虽然不再是内置，但通过NuGet安装Newtonsoft.Json即可使用。

安装NuGet包 在项目中通过NuGet包管理器安装Newtonsoft.Json。

解析示例

using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
using Microsoft.AspNetCore.Mvc;
[ApiController]
[Route("api/[controller]")]
public class NewtonsoftUsersController : ControllerBase
{
    [HttpPost("userinfo")]
    public IActionResult ReceiveUserInfoWithNewtonsoft([FromBody] JToken jToken)
    {
        // 接收为JToken，可以灵活操作JSON
        string name = jToken["name"]?.ToString();
        int age = jToken["age"]?.Value<int>() ?? 0;
        return Ok($"Received with Newtonsoft: {name}, {age}");
    }
    [HttpPost("userinfo-direct")]
    public IActionResult ReceiveUserInfoDirect([FromBody] UserInfo userInfo)
    {
        // 同样，框架可以自动解析（如果配置了相应的输入Formatter）
        // 这里假设手动解析
        string jsonString = "{\"name\":\"王五\",\"age\":28,\"email\":\"wangwu@example.com\",\"isStudent\":false}";
        userInfo = JsonConvert.DeserializeObject<UserInfo>(jsonString);
        if (userInfo != null)
        {
            return Ok($"Received User with Newtonsoft: {userInfo.Name}");
        }
        return BadRequest("Invalid user data.");
    }
}

JObject/JArray的使用（处理动态或未知结构的JSON）：

string jsonString = "{\"name\":\"赵六\",\"hobbies\":[\"reading\",\"swimming\"]}";
JObject jObject = JObject.Parse(jsonString);
string name = jObject["name"]?.ToString();
JArray hobbies = (JArray)jObject["hobbies"];
foreach (var hobby in hobbies)
{
    Console.WriteLine($"Hobby: {hobby}");
}

使用 System.Web.HttpUtility.UrlDecode (特定场景，如GET请求参数)

注意：这种方法不适用于直接解析JSON字符串本身，而是用于当JSON字符串被URL编码后作为GET请求参数传递的情况，对于POST请求的JSON Body,不适用。

如果前端通过GET请求发送参数，/api/user?data=%7B%22name%22%3A%22%E9%92%89%E4%B8%89%22%7D 这里的data参数是URL编码后的JSON字符串。

using System.Web;
// 需要添加 System.Web.Extensions 引用（在较新的.NET Core中可能需要通过NuGet获取）
public string Get([FromQuery] string data)
{
    if (!string.IsNullOrEmpty(data))
    {
        // URL解码
        string decodedJsonString = HttpUtility.UrlDecode(data);
        // 然后使用 System.Text.Json 或 Newtonsoft.Json 解析 decodedJsonString
        Console.WriteLine("Decoded JSON: " + decodedJsonString);
        return "Received and decoded JSON.";
    }
    return "No data received.";
}

最佳实践与注意事项

1. 优先选择模型绑定：在ASP.NET Core等现代框架中，尽量使用[FromBody] T model的方式让框架自动解析JSON,这能简化代码并利用框架的验证机制。
2. 选择合适的JSON库：
   • 对于新项目，优先使用System.Text.Json，性能更好，是.NET官方推荐。
   • 如果项目已大量使用Newtonsoft.Json，或者需要其特定的高级功能（如更灵活的序列化控制、与某些旧系统的兼容性），继续使用Newtonsoft.Json。
3. 处理异常：JSON字符串格式不正确时，解析会抛出异常（如JsonException），务必使用try-catch块进行异常处理，确保应用程序的健壮性。

   try
   {
       UserInfo userInfo = JsonSerializer.Deserialize<UserInfo>(invalidJsonString);
   }
   catch (JsonException ex)
   {
       Console.WriteLine($"JSON解析失败: {ex.Message}");
       // 返回错误给用户或进行其他处理
   }

4. 大小写敏感：默认情况下，System.Text.Json和Newtonsoft.Json在属性名匹配时不区分大小写，但最佳实践是保持JSON和C#模型中属性命名风格一致（通常使用PascalCase）。
5. 安全性：不要直接信任来自客户端的JSON数据，解析后，对数据进行验证和清理,防止注入攻击等安全风险。
6. 性能考虑：对于高频调用的API，System.Text.Json通常有更好的性能表现，如果性能是关键因素,可以进行基准测试。

在C#后台接收和解析JSON字符串是日常开发中的常见任务，通过定义清晰的模型类，并结合System.Text.Json或Newtonsoft.Json