webapi [FromBody]string获取入参为null, asp.net webapi [FromBody]string 获取不到POST数据的解决方法

最近做一个项目，需要给对方提供一个WebApi服务接收消息，服务已经写好了，对方调用多次，但我的webapi接收到的内容始终为空，于是就安装了Postman-win64测试工具进行调试，我的Postman-win64测试工具资源分享地址如下（不要积分，免费下载）：https://download.csdn.net/download/martian665/89909226

经过调试，发现以body中Content-Type: application/json类型POST string数据时参数在使用 [FromBody] 特性时必须被双引号包裹。加上双引号后果然POST string数据正常了，如下：

这是为什么呢？本篇文章将进行详细讲解。

在ASP.NET Web API中，参数绑定是一个非常重要的机制，尤其是当你从HTTP请求中提取并处理数据时。以下是对ASP.NET Web API中接收和处理参数的机制进行深入讲解，并结合示例说明为什么字符串类型的参数在使用 [FromBody] 特性时必须被双引号包裹。

参数绑定机制

ASP.NET Web API的参数绑定机制可以分为以下几个部分：

简单类型与复杂类型：简单类型包括 int、string、bool 等，复杂类型包括自定义对象、数组、集合等。
绑定源：参数可以从不同的地方绑定，如查询字符串、路由数据、表单数据和请求体等。
特性标注：ASP.NET Web API使用特性（Attributes）来明确指定参数绑定的源，例如 [FromUri]、[FromBody]。
内容类型：请求的内容类型（Content-Type）也会影响参数的绑定和解析。

`[FromBody]` 特性和 JSON 格式

当你使用 [FromBody] 特性时，ASP.NET Web API会从请求体中读取数据并绑定到该参数。此时，有几个关键点需要注意：

内容类型（Content-Type）：通常，客户端会发送 Content-Type: application/json 来告诉服务器请求体的格式是 JSON。
JSON 格式：按照 JSON 标准，字符串类型的值必须使用双引号包裹。

例如，以下是一个有效的 JSON 请求体：

"yourStringValue"

而未被双引号包裹的字符串不是有效的 JSON 格式，解析器无法理解它。

示例说明

假设你有以下控制器方法：

[HttpPost]
[Route("api/YourController/MessageProcess")]
public IHttpActionResult MessageProcess([FromBody] string message)
{
    if (message == null)
    {
        return BadRequest("Message is required.");
    }

    // 处理 message
    return Ok("Message received: " + message);
}

正确的请求

为了使 message 参数正确绑定，客户端应该发送如下的请求：

POST /api/YourController/MessageProcess HTTP/1.1
Host: your-api-url
Content-Type: application/json
Content-Length: 17

"yourStringValue"

在这种情况下，message 的值将是 "yourStringValue"。

错误的请求

如果客户端发送未被双引号包裹的字符串：

POST /api/YourController/MessageProcess HTTP/1.1
Host: your-api-url
Content-Type: application/json
Content-Length: 14

yourStringValue

由于 yourStringValue 不是有效的 JSON 格式字符串，ASP.NET Web API 解析器无法正确解析它，导致 message 参数的值为 null。

解决方案

为了处理未被双引号包裹的字符串，可以使用自定义模型绑定器，这样你可以控制如何解析请求体中的数据。

自定义模型绑定器

创建自定义模型绑定器类：

public class RawStringModelBinder : IModelBinder
{
    public bool BindModel(HttpActionContext actionContext, ModelBindingContext bindingContext)
    {
        if (bindingContext.ModelType != typeof(string))
        {
            return false;
        }

        var task = actionContext.Request.Content.ReadAsStringAsync();
        task.Wait();
        bindingContext.Model = task.Result;
        return true;
    }
}

创建自定义属性：

public class FromRawStringAttribute : ModelBinderAttribute
{
    public FromRawStringAttribute() : base(typeof(RawStringModelBinder)) { }
}

3. 应用自定义属性：

[HttpPost]
[Route("api/YourController/MessageProcess")]
public IHttpActionResult MessageProcess([FromRawString] string message)
{
    if (message == null)
    {
        return BadRequest("Message is required.");
    }

    // 处理 message
    return Ok("Message received: " + message);
}

测试自定义模型绑定器

客户端可以发送以下请求：

POST /api/YourController/MessageProcess HTTP/1.1
Host: your-api-url
Content-Type: text/plain
Content-Length: 14

yourStringValue

在这种情况下，message 参数值将是 yourStringValue，即使它未被双引号包裹。

总结

在ASP.NET Web API中，使用 [FromBody] 特性绑定字符串参数时，必须确保传入的字符串是有效的 JSON 格式，即被双引号包裹。这是因为ASP.NET Web API依赖于 JSON 解析器来处理请求体数据。为了处理未被双引号包裹的字符串数据，可以使用自定义模型绑定器，从而更灵活地解析和绑定请求体数据。

问题扩展

如果Content-Type: text/plain和Content-Type: application/json都需要支持，怎么解决？

下面将进行讲解：

在ASP.NET Web API中，Content-Type 标头用于指示请求体的媒体类型。默认情况下，ASP.NET Web API对不同的 Content-Type 会有不同的解析方式。

`Content-Type: application/json`

当 Content-Type 设置为 application/json 时，ASP.NET Web API会使用JSON解析器来解析请求体。如果请求体不是有效的JSON格式（例如一个未被双引号包裹的字符串），解析将会失败，导致参数值为 null。

例如：

POST /api/YourController/MessageProcess HTTP/1.1
Host: your-api-url
Content-Type: application/json
Content-Length: 14

yourStringValue

在这种情况下，由于 yourStringValue 不是有效的JSON格式，ASP.NET Web API将无法正确解析和绑定该数据。

`Content-Type: text/plain`

当 Content-Type 设置为 text/plain 时，请求体将被视为纯文本数据。ASP.NET Web API将直接读取请求体的内容，而不会进行JSON解析，这样可以避免格式检查问题。

例如：

POST /api/YourController/MessageProcess HTTP/1.1
Host: your-api-url
Content-Type: text/plain
Content-Length: 14

yourStringValue

在这种情况下，ASP.NET Web API将成功解析并绑定 yourStringValue。

自定义模型绑定器（继续）

为了支持未被双引号包裹的字符串并且仍然使用 application/json 作为 Content-Type，你可以继续使用自定义模型绑定器，但需要稍微调整逻辑以便处理不同的 Content-Type。

更新自定义模型绑定器

public class RawStringModelBinder : IModelBinder
{
    public bool BindModel(HttpActionContext actionContext, ModelBindingContext bindingContext)
    {
        if (bindingContext.ModelType != typeof(string))
        {
            return false;
        }

        if (actionContext.Request.Content.Headers.ContentType.MediaType == "application/json")
        {
            var task = actionContext.Request.Content.ReadAsStringAsync();
            task.Wait();
            // 解析 JSON 内容并去除多余的引号
            var jsonString = task.Result.Trim('"');
            bindingContext.Model = jsonString;
        }
        else
        {
            var task = actionContext.Request.Content.ReadAsStringAsync();
            task.Wait();
            bindingContext.Model = task.Result;
        }
        
        return true;
    }
}

更新自定义属性

属性定义保持不变：

public class FromRawStringAttribute : ModelBinderAttribute
{
    public FromRawStringAttribute() : base(typeof(RawStringModelBinder)) { }
}

应用自定义属性

在你的控制器中使用自定义属性：

[HttpPost]
[Route("api/YourController/MessageProcess")]
public IHttpActionResult MessageProcess([FromRawString] string message)
{
    if (message == null)
    {
        return BadRequest("Message is required.");
    }

    // 处理 message
    return Ok("Message received: " + message);
}

测试新的绑定器

现在你可以发送以下请求：

POST /api/YourController/MessageProcess HTTP/1.1
Host: your-api-url
Content-Type: application/json
Content-Length: 14

yourStringValue

或者：

POST /api/YourController/MessageProcess HTTP/1.1
Host: your-api-url
Content-Type: text/plain
Content-Length: 14

yourStringValue

两种情况下，自定义模型绑定器都将正确解析和绑定 message 参数。

总结

默认情况下，Content-Type: application/json 期望请求体是有效的JSON格式。如果请求体不是有效的JSON格式，解析将失败。为了支持未被双引号包裹的字符串，可以使用 Content-Type: text/plain 或者使用自定义模型绑定器来处理不同的 Content-Type。通过自定义模型绑定器，你可以灵活地解析和绑定请求体数据，无论其 Content-Type 为何。

原文地址：https://blog.csdn.net/martian665/article/details/143154908

免责声明：本站文章内容转载自网络资源，如本站内容侵犯了原著者的合法权益，可联系本站删除。更多内容请关注自学内容网（zxcms.com）！

上一篇：聊一聊Elasticsearch的索引分片的恢复机制
下一篇：dataV下的轮播表使用(保姆级)

Java项目实战II基于Java+Spring Boot+MySQL的共享汽车管理系统(源码+数据库+文档)
在共享经济蓬勃发展的背景下，共享汽车作为一种新型的出行方式，正逐渐改变着人们的出行习惯。然而，随着共享汽车市场规模的不断扩大，车辆管理、用户服务、数据安全等问题日益凸显，传统的管理方式已难以满足当前的
阅读更多2024-11-19
【青牛科技】汽车收音机调频中频放大器——D1145
无线麦克风对讲机。
阅读更多2024-11-19
鸿蒙中位置权限和相机权限
State permissionsMessage: string | Resource = "\"获取当前位置\"需获取定位权限才能正常使用"this.perm
阅读更多2024-11-19
UE5 第一人称射击项目学习（二）
然后，把子弹的向前向量提升（在ue5的标准向量是以1cm为单位，所以虽然子弹跟随视角发射，但是速度太慢），从生成Actor的return Value处拉一根线，获取向前向量乘1000.运行程序，按
阅读更多2024-11-19
【软考】系统架构设计师-数据库设计基础
数据库设计基础知识
阅读更多2024-11-19
MongoDB 监控：确保数据库性能和可靠性
MongoDB 是一个流行的开源 NoSQL 数据库，以其灵活的文档模型和强大的查询语言而闻名。然而，为了确保 MongoDB 的性能和可靠性，监控是至关重要的。本文将讨论 MongoDB 监控的重要
阅读更多2024-11-19
电脑插入U盘，电脑显示新增了，但是双击却显示请将磁盘插入
`CHKDSK 无法供 RAW 驱动器使用` 表明内存卡的文件系统已损坏或丢失，当前处于 **RAW 文件系统** 状态。RAW 表示文件系统无法识别，可能由以下原因导致：
阅读更多2024-11-19
【论文阅读】InstructIR: High-Quality Image Restoration Following Human Instructions
图像恢复是一个基本问题，旨在从退化的图像中恢复出高质量的清晰图像。All-In-One 图像恢复模型能够利用退化特定的信息作为提示，引导恢复模型有效地恢复多种类型和不同程度的退化图像。本研究提出了首个
阅读更多2024-11-19
【Next】字体修改
next/font 包括任何字体文件的内置自动自托管。首先从 next/font/google 导入您想要使用的字体作为函数。（可以按住 ctrl 点进去 google 查看所有字体）然后导入该字体函
阅读更多2024-11-19
Springboot基于GIS的旅游信息管理系统
项目编号：springbootA100基于GIS的旅游信息管理系统是在旅游业迅速发展、旅游需求日益多样化的背景下应运而生的一套综合性信息管理平台，它通过整合旅游资源、提供实时信息、优化服务流程，旨在为
阅读更多2024-11-19