在 .NET 8 Web API 中，[FromBody]、[FromForm]、[FromHeader]、[FromKeyedServices]、[FromQuery]、[FromRoute] 和 [FromServices] 这些都是用于绑定控制器动作方法参数的特性，下面为你详细解释这些特性。
1. [FromBody]
- 作用：从 HTTP 请求的消息体中绑定参数。一般用于处理 JSON 或 XML 格式的数据，常用于 POST、PUT 等请求。
- 示例：
[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; }
}
- 请求示例：
{"Name": "John Doe","Age": 30
}
2. [FromForm]
- 作用：从 HTTP 请求的表单数据中绑定参数。通常用于处理
application/x-www-form-urlencoded或multipart/form-data格式的表单数据。 - 示例：
[ApiController]
[Route("[controller]")]
public class FormController : ControllerBase
{[HttpPost]public IActionResult SubmitForm([FromForm] string name, [FromForm] int age){return Ok($"Name: {name}, Age: {age}");}
}
- 请求示例（使用 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头。 - 示例：
[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]
- 作用：从依赖注入容器中获取具有特定键的服务实例并绑定到参数。在使用键控服务时，可通过此特性按键获取服务。
- 示例：
// 注册键控服务
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 后面。
- 示例：
[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 路径中。
- 示例：
[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]
- 作用：从依赖注入容器中获取服务实例并绑定到参数。当控制器动作方法需要使用某个服务时，可通过此特性注入该服务。
- 示例：
// 注册服务
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";}
}
这些特性可以帮助开发者更灵活地处理不同来源的数据，提高代码的可读性和可维护性。