如何正确在ASP.NET Core中获取查询字符串参数?
- 内容介绍
- 文章标签
- 相关推荐
本文共计782个文字,预计阅读时间需要4分钟。
目录+前言+表单域+解决方案+空类型+[BindRequired]+属性+前言+有网友在交流群中询问,如何获取查询字符串参数:
默认情况下,ASP.NET Core 的模型绑定以键值对的形式从 HTTP 请求中获取参数。以下是如何从请求中获取查询字符串参数的步骤:
1. 创建一个模型类,其中包含与查询字符串参数对应的属性。
2.在控制器中,使用 `[BindRequired]` 属性标记需要绑定的查询字符串参数。
3.在控制器方法中,通过参数名接收查询字符串参数的值。
示例代码:
csharp
public class QueryStringModel{ [BindRequired] public string ParameterName { get; set; }}[ApiController][Route([controller])]public class QueryStringController : ControllerBase{ [HttpGet] public IActionResult GetQueryString([FromQuery] QueryStringModel model) { if (model.ParameterName==null) { return BadRequest(Parameter is required.); }
// 处理查询字符串参数 return Ok(model.ParameterName); }}
目录
- 前言
- 表单域
- 解决方案
- 可空类型
- [BindRequired] 属性
前言
有网友在交流群中询问,如何获取查询字符串参数:
默认情况下,ASP.NET Core 的模型绑定以键值对的形式从 HTTP 请求中的以下列表中指示的顺序扫描源并获取数据:
表单域
- 请求正文
- 路由数据
- 查询字符串参数
- 上传的文件
因此,不需要任何配置,即可在 Action 中获取到查询字符串参数:
[HttpGet] public string Demo(int id, int price) { return $"id = {id}, price = {price}"; }
但是,使用查询字符串参数存在一个隐患,不传任何参数时,Demo方法也可以运行,因为模型绑定会为缺失的参数赋类型默认值:
由于 0 也是正确的int值,我们无法区分这到底是不是传递过来的参数值。
而price = 0可能会造成很严重的业务问题。
那要如何处理呢?
解决方案
可空类型
对于可空类型,默认值为null。因此只需检查它们是否为null,就可判断是否传递了查询字符串参数:
[HttpGet] public string Demo(int id, int? price) { if(price==null) throw new ArgumentNullException(nameof(price)); return $"id = {id}, price = {price}"; }
[BindRequired] 属性
上述方案虽然可以实现要求,但是代码改动较多。
另一种更简单的方案是使用绑定验证属性:
[HttpGet] public string Demo(int id, [BindRequired] int price) { return $"id = {id}, price = {price}"; }
与原始方法相比,执行增加一个属性即可。而且 Swagger 也可以正确识别这一属性:
以上就是ASP.NET Core获取正确查询字符串参数示例的详细内容,更多关于获取查询字符串参数的资料请关注自由互联其它相关文章!
本文共计782个文字,预计阅读时间需要4分钟。
目录+前言+表单域+解决方案+空类型+[BindRequired]+属性+前言+有网友在交流群中询问,如何获取查询字符串参数:
默认情况下,ASP.NET Core 的模型绑定以键值对的形式从 HTTP 请求中获取参数。以下是如何从请求中获取查询字符串参数的步骤:
1. 创建一个模型类,其中包含与查询字符串参数对应的属性。
2.在控制器中,使用 `[BindRequired]` 属性标记需要绑定的查询字符串参数。
3.在控制器方法中,通过参数名接收查询字符串参数的值。
示例代码:
csharp
public class QueryStringModel{ [BindRequired] public string ParameterName { get; set; }}[ApiController][Route([controller])]public class QueryStringController : ControllerBase{ [HttpGet] public IActionResult GetQueryString([FromQuery] QueryStringModel model) { if (model.ParameterName==null) { return BadRequest(Parameter is required.); }
// 处理查询字符串参数 return Ok(model.ParameterName); }}
目录
- 前言
- 表单域
- 解决方案
- 可空类型
- [BindRequired] 属性
前言
有网友在交流群中询问,如何获取查询字符串参数:
默认情况下,ASP.NET Core 的模型绑定以键值对的形式从 HTTP 请求中的以下列表中指示的顺序扫描源并获取数据:
表单域
- 请求正文
- 路由数据
- 查询字符串参数
- 上传的文件
因此,不需要任何配置,即可在 Action 中获取到查询字符串参数:
[HttpGet] public string Demo(int id, int price) { return $"id = {id}, price = {price}"; }
但是,使用查询字符串参数存在一个隐患,不传任何参数时,Demo方法也可以运行,因为模型绑定会为缺失的参数赋类型默认值:
由于 0 也是正确的int值,我们无法区分这到底是不是传递过来的参数值。
而price = 0可能会造成很严重的业务问题。
那要如何处理呢?
解决方案
可空类型
对于可空类型,默认值为null。因此只需检查它们是否为null,就可判断是否传递了查询字符串参数:
[HttpGet] public string Demo(int id, int? price) { if(price==null) throw new ArgumentNullException(nameof(price)); return $"id = {id}, price = {price}"; }
[BindRequired] 属性
上述方案虽然可以实现要求,但是代码改动较多。
另一种更简单的方案是使用绑定验证属性:
[HttpGet] public string Demo(int id, [BindRequired] int price) { return $"id = {id}, price = {price}"; }
与原始方法相比,执行增加一个属性即可。而且 Swagger 也可以正确识别这一属性:
以上就是ASP.NET Core获取正确查询字符串参数示例的详细内容,更多关于获取查询字符串参数的资料请关注自由互联其它相关文章!

