Model绑定

Model绑定

在前面的几篇文章中我们都是采用在URI中元数据类型进行传参,实际上ASP.NET Web API也提供了对URI进行复杂参数的绑定方式--Model绑定。这里的Model可以简单的理解为目标Anction方法的某个参数。

eg:

public Figure GetFigureFromQueryString([ModelBinder]Figure figure)

{

return figure;

}

请求url: http://localhost:4044/api/Figure/GetFigureFromQueryString?FirstName=Bran&LastName=Stack

结果:

{

"FirstName": "Bran",

"LastName": "Stack"

}

(本篇为了更好的体现绑定结果,所有Anction的返回结果都是请求参数或整合的后的请求参数)

ModelBinder

在之前的文章中多次提到URI的数据主要来源于两种方式:Route,QueryString。但是URI只提供简单的基础数据类型,在上面的例中,我们会发现参数变成了类。ModelBinderAttribute提供了基础数据类型向复杂类型数据转换的功能。

[AttributeUsage(AttributeTargets.Class | AttributeTargets.Parameter, Inherited = true, AllowMultiple = false)]

public class ModelBinderAttribute : ParameterBindingAttribute

{

}

从定义中我们可以看出ModelBinder的AttributeUsage可以看出来ModelBinder可以用于类型与参数。下面我就列举一些Model绑定的形式。

  1. 简单类

这里所说的简单类是指数据是指类的公开属性是基础数据类型。比如我们之前一直使用的Figure类。

public class Figure

{

public string FirstName { get; set; }

public string LastName { get; set; }

}

还是以本文开始的GetFigureFromQueryString([ModelBinder]Figure figure) 为例。因为该Action中只采用了一个参数。所以在传参的过程中只需要将FirstName,LastName作为QueryString传递,ModelBinder将转换出Figure对象。

http://localhost:4044/api/Figure/GetFigureFromQueryString?FirstName=Bran&LastName=Stack

同时我们也可以采用route形式进行传参:

[Route("GetFigureFromRoute/{FirstName}/{LastName}")]

public Figure GetFigureFromRoute(Figure figure)

url:

http://localhost:4044/api/Figure/GetFigureFromRoute/Bran/Stack

当然以此类推也也可以进行混合的传参:

还是基于 GetFigureFromRoute Action

我们用以下url进行访问:

http://localhost:4044/api/Figure/GetFigureFromRoute/Bran/Stack?FirstName=Robb

那我们得到的结果将是:

{

"FirstName": "Robb",

"LastName": "Stack"

}

由此可以看出

QueryString参数的优先级是高于Route参数的

2.多参数(简单类)

第一种情况我们是考虑了一个参数,现在我们把参数变成两个,如下:

List<Figure> 方法名 (Figure a, Figure b)

因为这个时候出现了两个类型相同的参数,仅靠属性名已经不能对参数进行区别。这个时候WebAPI为我们提供了前缀形式对参数进行区分。下面就以Route的方式做一demo:、

[Route("GetTwoFigureFromRoute/{a.FirstName}/{a.LastName}/{b.FirstName}/{b.LastName}")]

public List<Figure> GetTwoFigureFromRoute(Figure a, Figure b)

我们对路由进行一个简单分析:即{参数名}.{属性名} 作为路由的key

{a.FirstName}:参数a的FirstName属性

{a.LastName}:参数a的LastName属性

{b.FirstName}:参数b的FirstName属性

{b.LastName}:参数b的LastName属性

用以下url访问

http://localhost:4044/api/Figure/GetTwoFigureFromRoute/Bran/Stack/Robb/Stack

得到的结果就是:

[

{

"FirstName": "Bran",

"LastName": "Stack"

},

{

"FirstName": "Robb",

"LastName": "Stack"

}

]

对于QueryString形式传参也非常简单,直接将{参数名}.{属性名} 作为QueryString的key.比如:

public List<Figure> GetTwoFigureFromQueryString(Figure a, Figure b)

url:

http://localhost:4044/api/Figure/GetTwoFigureFromQueryString?a.FirstName=Bran&a.LastName=Stack&b.FirstName=Robb&b.LastName=Stack

将得到如Route形式一样的结果

3.复杂类

现在我们对Figure添加一个Direwolf类的属性Direwolf,让其变为一个复杂类

public class Figure

{

public Direwolf Direwolf { get; set; }

}

public class Direwolf

{

public string Name { get; set; }

public string Color { get; set; }

}

在传参数的过程中显然我们不能对直接对Direwolf属性赋值,所以我们要对Direwolf属性进行拆分,这个时候我也要用到前缀的方式进行传参。如下:

public Figure GetComplexFigureFromQueryString(Figure figure)

url:

http://localhost:4044/api/Figure/GetComplexFigureFromQueryString?FirstName=Jon&LastName=Snow&Direwolf.Color=White&Direwolf.Name=Summer

结果:

{

"FirstName": "Bran",

"LastName": "Stack",

"Direwolf": {

"Name": "Summer",

"Color": "White"

}

}

对于Route形式也是一样:

[Route("GetComplexFigureFromRoute/{FirstName}/{LastName}/{Direwolf.Name}/{Direwolf.Color}")]

public Figure GetComplexFigureFromRoute(Figure figure)

url:

http://localhost:4044/api/Figure/GetComplexFigureFromRoute/Bran/Stack/Grey/Summer

对于多参数的形式也照样可以处理:

public List<Figure> GetTwoComplexFigureFromQueryString(Figure a, Figure b)

url:

http://localhost:4044/api/Figure/GetTwoComplexFigureFromQueryString?a.FirstName=Bran&a.LastName=Stack&a.Direwolf.Color=Grey&a.Direwolf.Name=Summer&b.FirstName=Jon&b.LastName=Snow&b.Direwolf.Color=White&b.Direwolf.Name=Ghost

4.集合类型

集合类型因为存在长度的确定性,所以还是需要通过前缀的方式去指定序列号,如下:

public List<int> GetList([ModelBinder] List<int> list)

{

return list;

}

url:

http://localhost:4044/api/Figure/GetList?[0]=0&[1]=1&[2]=2&[3]=3

结果:

[

0,

1,

2,

3

]

注意

序列号必须是从0开始连续的整数,不然就只能得到序列号断裂之前的数据,如:

url:

http://localhost:4044/api/Figure/GetList?[0]=0&[2]=1&[2]=2&[3]=3

结果:

[

0

]

另外,如果要采用Route形式的传参方式,就必须考虑数据的长度问题。

5字典类型

WebAPI在数据字典类型的先将数据转化成KeyValuePair的集合类型,再转化成字典类型。所以再传参的时候我们可以采用与集合类型一致的方式。如:

public Dictionary<string, int> GetDictionary([ModelBinder]Dictionary<string, int> dic)

url:

http://localhost:4044/api/Figure/GetDictionary?[0].Key=a&[0].Value=1&[1].Key=b&[1].Value=2

结果

{

"a": 1,

"b": 2

}

源码

Github: https://github.com/BarlowDu/WebAPI (API_4)

时间: 2024-11-11 03:14:19

Model绑定的相关文章

ASP.NET MVC Model绑定(二)

ASP.NET MVC Model绑定(二) 前言 上篇对于Model绑定的简单演示想必大家对Model绑定的使用方式有一点的了解,那大家有没有想过Model绑定器是在什么时候执行的?又或是执行的过程是什么样的?将在本篇为大家解除这些疑惑,在其中涉及到的一些描述类型和上下文参数会在后续的篇幅中讲到. Model绑定 IModelBinder.自定义Model绑定器简单实现 Model绑定器在MVC框架中的位置 MVC中的默认Model绑定器生成过程 IModelBinderProvider的简单

ASP.NET MVC Model绑定小结

Model绑定是指从URL提取数据,生成对应Action方法的参数这个过程.前面介绍的一系列Descriptor负责提供了控制器,行为方法和参数的元数据,ValueProvieder负责获取数据,剩下的Moder绑定则是利用上述两者的结果来最终达到Model的生成.ParameterDescriptor里面的BindingInfo(类型是ParameterBindingInfo)的Binder是一个实现了IModelBinder接口的对象,ModelBinder组件用于真正的Model绑定. M

ASP.NET MVC Model绑定(六)

ASP.NET MVC Model绑定(六) 前言 前面的篇幅对于IValueProvider的使用做个基础的示例讲解,但是没并没有对 IValueProvider类型的实现做详细的介绍,然而MVC框架中给我们提供了几种默认的实现类型,在本篇中将会对NameValueCollectionValueProvider类型做一个示例讲解,了解一下MVC框架给我们提供的值提供程序是怎么处理Model值的. Model绑定 IModelBinder.自定义Model绑定器简单实现 Model绑定器在MVC

ASP.NET MVC Model绑定(五)

ASP.NET MVC Model绑定(五) 前言 前面的篇幅对于IValueProvider的获取位置和所处的生成过程做了讲解,本篇将会对IValueProvider的使用做个基础的示例讲解,读完本篇你将会对IValueProvider有个更清晰的印象. Model绑定 IModelBinder.自定义Model绑定器简单实现 Model绑定器在MVC框架中的位置 MVC中的默认Model绑定器生成过程 IModelBinderProvider的简单应用 IValueProvider在MVC框

ASP.NET MVC Model绑定(一)

ASP.NET MVC Model绑定(一) 前言 ModelMetadata系列的结束了,从本篇开始就进入Model绑定部分了,这个系列阅读过后你会对Model绑定有个比较清楚的了解, 本篇对于Model绑定器的最基础的应用作个简单的示例展示,目的在于让大家事先了解一下Model绑定器是什么样的便于后续篇幅的理解. Model绑定 IModelBinder.自定义Model绑定器简单实现 Model绑定器在MVC框架中的位置 MVC中的默认Model绑定器生成过程 IModelBinderPr

ASP.NET MVC Model绑定的简单应用

Model绑定是 MVC 框架根据 HTTP 请求数据创建 .NET 对象的一个过程. 一.简单类型 1.单一值 获取值 二.多个值 获取值 三.数组 获取值 二.复杂类型 一.简单类型与数组组合 获取值 二.简单类型与集合 localhost:1234/ModelBinder?name=emrys&age=25&friends[0].name=lilei&friends[0].age=22&friends[1].name=hanmeimei&friends[1].

ASP.NET WebAPI 04 Model绑定

在前面的几篇文章中我们都是采用在URI中元数据类型进行传参,实际上ASP.NET Web API也提供了对URI进行复杂参数的绑定方式--Model绑定.这里的Model可以简单的理解为目标Anction方法的某个参数. eg: public Figure GetFigureFromQueryString([ModelBinder]Figure figure) { return figure; } 请求url: http://localhost:4044/api/Figure/GetFigure

ASP.NET MVC Model绑定(四)

ASP.NET MVC Model绑定(四) 前言 前面的篇幅对于Model绑定器IModelBinder以及实现类型.Model绑定器提供程序都作了粗略的讲解,可以把Model绑定器想象成一个大的容器,为什么这么说呢?留个疑问在这里. 首先控制器的方法参数可能是很多种类型的.可能是多个同一种类型的,应对这种情况MVC框架使用的绑定实现都是IValueProvider来做的,而针对参数类型的不同等等一些情况,IValueProvider的实现类型也是有很大的差异的,这些具体实现的讲解会在后续的篇

ASP.NET MVC Model绑定(三)

ASP.NET MVC Model绑定(三) 前言 看过前两篇的朋友想必对Model绑定有个大概的了解,然而MVC框架给我们提供了更高的可扩展性的提供程序编程模式,也就是本篇的主题了,会讲解一下Model绑定器提供程序的实现以及解决一下上篇遗留的问题. 第一个问题是ModelBinderProviderCollection类型的执行过程? 还有个本篇的问题就是同样的向系统上下文中注册Model绑定器和Model绑定器提供程序,哪一个优先级更高? Model绑定 IModelBinder.自定义M