<C#>.NET WebAPI 的 FromBody ,FromForm ,FromServices等详细解释

在 .NET 8 Web API 中,[FromBody]、[FromForm]、[FromHeader]、[FromKeyedServices]、[FromQuery]、[FromRoute] 和 [FromServices] 这些都是用于绑定控制器动作方法参数的特性,下面为你详细解释这些特性。

1. [FromBody]

  • 作用:从 HTTP 请求的消息体中绑定参数。一般用于处理 JSON 或 XML 格式的数据,常用于 POST、PUT 等请求。
  • 示例:
csharp 复制代码
[ApiController]
[Route("[controller]")]
public class UserController : ControllerBase
{
    [HttpPost]
    public IActionResult CreateUser([FromBody] User user)
    {
        // 处理接收到的用户对象
        return Ok(user);
    }
}

public class User
{
    public string Name { get; set; }
    public int Age { get; set; }
}
  • 请求示例:
json 复制代码
{
    "Name": "John Doe",
    "Age": 30
}

2. [FromForm]

  • 作用 :从 HTTP 请求的表单数据中绑定参数。通常用于处理 application/x-www-form-urlencoded 或 multipart/form-data 格式的表单数据。
  • 示例:
csharp 复制代码
[ApiController]
[Route("[controller]")]
public class FormController : ControllerBase
{
    [HttpPost]
    public IActionResult SubmitForm([FromForm] string name, [FromForm] int age)
    {
        return Ok($"Name: {name}, Age: {age}");
    }
}
  • 请求示例(使用 HTML 表单):
html 复制代码
<form action="/Form" method="post">
    <input type="text" name="name" />
    <input type="number" name="age" />
    <input type="submit" value="Submit" />
</form>

3. [FromHeader]

  • 作用 :从 HTTP 请求的头部中绑定参数。当需要从请求头中获取特定信息时使用,比如 Authorization 头。
  • 示例:
csharp 复制代码
[ApiController]
[Route("[controller]")]
public class HeaderController : ControllerBase
{
    [HttpGet]
    public IActionResult GetData([FromHeader(Name = "X-Custom-Header")] string customHeader)
    {
        return Ok($"Custom Header Value: {customHeader}");
    }
}
  • 请求示例(使用 Postman 或类似工具设置请求头):

    X-Custom-Header: SomeValue

4. [FromKeyedServices]

  • 作用:从依赖注入容器中获取具有特定键的服务实例并绑定到参数。在使用键控服务时,可通过此特性按键获取服务。
  • 示例:
csharp 复制代码
// 注册键控服务
services.AddKeyedSingleton<IMyService, MyService>("key1");

[ApiController]
[Route("[controller]")]
public class KeyedServiceController : ControllerBase
{
    [HttpGet]
    public IActionResult GetData([FromKeyedServices("key1")] IMyService service)
    {
        return Ok(service.GetData());
    }
}

public interface IMyService
{
    string GetData();
}

public class MyService : IMyService
{
    public string GetData()
    {
        return "Some data";
    }
}

5. [FromQuery]

  • 作用:从 HTTP 请求的查询字符串中绑定参数。常用于 GET 请求,参数会附加在 URL 后面。
  • 示例:
csharp 复制代码
[ApiController]
[Route("[controller]")]
public class QueryController : ControllerBase
{
    [HttpGet]
    public IActionResult GetData([FromQuery] string name, [FromQuery] int age)
    {
        return Ok($"Name: {name}, Age: {age}");
    }
}
  • 请求示例:

    /Query?name=John&age=30

6. [FromRoute]

  • 作用:从路由模板中绑定参数。路由模板定义了 URL 的结构,参数会嵌入到 URL 路径中。
  • 示例:
csharp 复制代码
[ApiController]
[Route("api/[controller]/{id}")]
public class RouteController : ControllerBase
{
    [HttpGet]
    public IActionResult GetData([FromRoute] int id)
    {
        return Ok($"ID: {id}");
    }
}
  • 请求示例:

    /api/Route/123

7. [FromServices]

  • 作用:从依赖注入容器中获取服务实例并绑定到参数。当控制器动作方法需要使用某个服务时,可通过此特性注入该服务。
  • 示例:
csharp 复制代码
// 注册服务
services.AddScoped<IMyService, MyService>();

[ApiController]
[Route("[controller]")]
public class ServiceController : ControllerBase
{
    [HttpGet]
    public IActionResult GetData([FromServices] IMyService service)
    {
        return Ok(service.GetData());
    }
}

public interface IMyService
{
    string GetData();
}

public class MyService : IMyService
{
    public string GetData()
    {
        return "Some data";
    }
}

这些特性可以帮助开发者更灵活地处理不同来源的数据,提高代码的可读性和可维护性。

相关推荐
谙弆悕博士1 小时前
多智能体架构详解:市场拍卖式架构(Market-based / 竞价协商)
开发语言·架构·去中心化·多智能体·智能体·拍卖架构
ShineWinsu1 小时前
对于Qt:QMessageBox的解析
开发语言·c++·qt·面试·客户端·qmessagebox·消息对话框
承渊政道1 小时前
【Python编程快速上手—让繁琐工作自动化】(列表:把数据排成队,从下标取值到深拷贝)
开发语言·python·pycharm·自动化·列表
tryCbest2 小时前
Python 爬虫从入门到实战(一):基础篇——从零写出第一个爬虫
开发语言·爬虫·python
多加点辣也没关系3 小时前
JavaScript|第40章:JavaScript 工程化实践
开发语言·javascript·ecmascript
吃我一窝jio5 小时前
Java Bug复盘与性能优化实战
java·开发语言·笔记
sleveen6 小时前
新增办理动词只写 Core:SailFlow 动作骨架、同事务信封与 Sync 钩子自锁治理
开源·.net·工作流·oa引擎
Evand J6 小时前
【MATLAB例程】基于APF的多无人机动态路径规划与避障仿真。避碰及安全性能分析。附完整代码的下载链接
开发语言·matlab·无人机
鲸渔7 小时前
【AI Agent系列课程13-Python 基础13】JSON 读写:结构化数据交换基础
开发语言·python·json·ai编程
Highcharts.js12 小时前
Highcharts漏斗图表使用配置指南
java·开发语言·javascript·信息可视化·highcharts·漏斗图