ASP.NET Web API中的参数绑定总结

ASP.NET Web API中的action参数类型可以分为简单类型和复杂类型。

HttpResponseMessage Put(int id, Product item)

id是int类型,是简单类型,item是Product类型,是复杂类型。

简单类型实参值从哪里读取呢?
--一般从URI中读取

所谓的简单类型包括哪些呢?
--int, bool, double, TimeSpan, DateTime, Guid, decimal, string,以及能从字符串转换而来的类型

复杂类型实参值从哪里读取呢?
--一般从请求的body中读取

复杂类型实参值是否可以从URI中获取呢?
--可以,按如下

→ 有这样的一个类

public class Shape
{
    public double Width{get;set;}
    public double Length{get;set;}
}

→ 想从URI中获取,那就加上[FromUri]

public HttpResponseMessage Get([FromUri] Shape shape)

→ 客户端就可以放在查询字符串中传

...api/products/?Width=88&Length=199

简单类型可以从请求的body中获取吗?
--可以。按如下:

→ action方法

public HttpResponseMessage Post([FromBody] string name){...}

→ 前端请求中

Content-Type:applicaiton/json

"hello world"

API服务端会根据Content-Type的值选择合适的媒体类型。

复杂类型是否可以从uri中的字符串获取呢?
--可以

api/products/?shape=188,80

如何把uri中查询字符串中shape的字段值,即以逗号分割的字符串转换成Shape类实例呢?
--使用TypeConverter类

[TypeConverter(typeof(ShapeConverter))]
public class Shape
{
    public double Width{get;set;}
    public double Length{get;set;}

    public static bool TryParse(string s, out Shampe result)
    {
        result = null;
        var parts = s.Split(‘,‘);
        if(parts.lenth != 2)
        {
            return false;
        }

        double width, length;

        if(double.TryParse(parts[0], out width) && double.TryParse(parts[1], out length))
        {
            result = new Shape(){Width = width; Length = length};
            return true;
        }
        return false;
    }
}

public class ShapeConverter: TypeConverter
{
    public override bool CanConvertFrom(ITypeDescriptorContext context, Type sourcType)
    {
        if(sourceType == typeof(string))
        {
            return true;
        }

        return base.CanConvertFrom(context, sourceType);
    }

    public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo, object value)
    {
        if(value is string)
        {
            Shape shape;
            if(Shape.TryParse((string)value, out shape))
            {
                return shape;
            }
        }
        return base.ConvertFrom(context, culture, value);
    }
}

→ 在action不需要[FromUri]

public HttpResponseMessage Get(Shape shape)

→ 客户端

api/products/?shape=188,80

是否可以通过Model Binder来实现自定义参数绑定过程呢?
--可以,有IModelBinder接口,提供了BindModel方法

→ 自定义一个Model Binder

public class ShapeModelBinder : IModelBinder
{
    private static ConcurrentDictionary<string, Shape> _shapes = new ConcurrentDictionary<string, Shape>(StringComparer.OrdinalIgnoreCase);

    static ShapeModelBinder()
    {
        _shapes["shape1"] = new Shape(){Width= 10, Length = 20};
        _shapes["shape2"] = new Shape(){Width=12, Length = 22 };
    }

    public bool BindModel(HttpActionContext actionContext, ModelBindingContect biningContext)
    {
        if(bindingContext.ModelType != typeof(Shape))
        {
            return false;
        }

        ValueProviderResult val = bindingContext.ValueProvider.GetValue(bidingContext.ModelName);
        if(val == null)
        {
            return false;
        }

        string key = val.RawValue as string;
        if(key == null){
            bdingContext.ModelState.AddModelError(bindingContext.ModelName, "值类型错误");
            return false;
        }

        Shape shape;
        if(_shapes.TryGetValue(key, out shape) || Shape.TryParse(key, shape))
        {
            bindingContext.Model = result;
            return true;
        }

        bindingContext.ModelState.AddModelError(bindingContext.ModelName, "无法把字符串转换成Shape");
        return false;
    }
}

● 从BindingContext中的ValueProvider属性获取到ValueProviderResult
● 从前端查询字符串中传来的字符串,被放在ValueProviderResult的RawValue属性中
● 把字符串转换成Shape实例,最终放在了BindingContext的Model属性中

→ 使用自定义的Model Binder

可以运用在action中:

public HttpResposneMessage Get([ModelBinder(typeof(ShapeModelBinder))] Shape shape);

可以放在模型上:

[ModelBinder(typeof(Shape))]
public class Shape
{

}

也可以放在全局注册中:

public static class WebApiConfig
{
    public static void Register(HttpConfiguraiton config)
    {
        var provider = new SimpleModelBinderProvider(typeof(Shape), new ShapeModelBinder());
        config.Services.Insert(typeof(ModelBinderProvider), 0, provider);
    }
}

注意:即使在全局注册,也需要在action中按如下写:

public HttpResponseMessage Get([ModelBinder] Shape shape);

是否可以通过Value Provider来自定义参数绑定过程呢?
--可以。

比如,从前端cookie中获取值,自定义一个Value Provider.

public class MyCookieValueProvider : IValueProvider
{
    private Dictionary<string, string> _values;

    public MyCookieValueProvider(HttpActionContext actionContext)
    {
        if(actionContext == null)
        {
            throw new ArgumentNullException("actionContext");
        }

        _values = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
        foreach(var cookie in actionContext.Request.Headers.GetCookies())
        {
            foreach(CookieState state in cookie.Cookies)
            {
                _values[state.Name] = state.Value;
            }
        }
    }

    public bool COntainsPrefix(string prefix)
    {
        return _values.keys.Contains(prefix);
    }

    public ValueProviderResult GetValue(string key)
    {
        string value;
        if(_values.TryGetValue(key, out value))
        {
            return new ValueProviderResult(value, value, CultureInfo.InvariantCulture);
        }
        return null;
    }
}

同时还需要一个ValueProviderFactory.

public class MyCookieValueProviderFactory : ValueProviderFactory
{
    public override IValueProvider GetValueProvider(HttpActionContext actionContext)
    {
        return new MyCookeValueProvider(actionContext);
    }
}

最后注册到全局中。

public static void Register(HttpConfiguration config)
{
    config.Services.Add(typeof(ValueProviderFactory), new MyCookieValueProviderFactory());
}

还可以把自定义的ValueProvider放在action中。

public HttpResponseMessage Get([ValueProvider(typeof(MyCookieValueProviderFactory))] Shape shape);

是否可以通过HttpParameterBinding实现参数绑定自定义呢?
--可以。

ModelBinderAttribute继承于ParameterBindingAttribute.

public abstract class ParameterBindingAttribute : Attribute
{
    public abstract HttpParameterBinding GetBinding(HttpParameterDescriptor parameter);
}

HttpParameterBinding用来把值绑定到参数上。

假设,需要从前端请求的if-match和if-none-match字段获取ETag值。

public class ETag
{
    public string Tag{get;set;}
}

可能从if-match获取,也可能从if-none-match获取,来个枚举。

public enum ETagMatch
{
    IfMatch,
    IfNoneMatch
}

自定义HttpParameterBinding。

public class ETagParameterBinding : HttpParameterBinding
{
    ETagMatch _match;

    public ETagParameterBinding(HttpParameterDescriptor parameter, ETagMatch match) : base(parameter)
    {
        _match = match;
    }

    public override Task ExecuteBindingAsync(ModelMetadataProvider metadataProvider, HttpActionContext actionContext, CancellationToken candellationToken)
    {
        EntityTagHeaderValue etagHeader = null;
        switch(_match)
        {
            case ETagMatch.IfNoneMatch:
                etagHeader = actionContext.Request.Headers.IfNoneMatch.FirstOrDefault();
                break;
            case ETagMatch.IfMatch:
                etagHeader = actionContext.Request.Headers.IfMatch.FirstOrDefault();
                break;
        }

        ETag etag = null;
        if(etagHeader != null)
        {
            etag = new ETag{Tag = etagHeader.Tag};
        }

        actionContext.ActionArguemnts[Descriptor.ParameterName] = etag;

        var tsc = new TaskCompletionSource<object>();
        tsc.SetResult(null);
        return tsc.Task;
    }
}

可见,所有的action参数放在了ActionContext的ActionArguments中的。

如何使用自定义的HttpParameterBinding呢?
--通过自定义一个ParameterBindingAttribute特性。

public abstract class ETagMatchAttribute : ParameterBindingAttribute
{
    private ETagMatch _match;

    public ETagMatchAttribute(ETagMatch match)
    {
        _match = match;
    }

    public override HttpParameterBinding GetBinding(HttpParameterDescriptor parameter)
    {
        if(parameter.ParameterType == typeof(ETag))
        {
            return new ETagParameterBinding(parameter, _match);
        }
        return parameter.BindAsError("参数类型不匹配");
    }
}

public class IfMatchAttribute : ETageMatchAttribute
{
    public IfMatchAttribute(): base(ETagMatch.IfMatch)
    {}
}

public class IfNoneMatchAttribute: ETagMatchAttribute
{
    public IfNoneMatchAttribute() : base(ETagMatch.IfNoneMatch)
    {}
}

再把定义的有关HttpParameterBinding的特性运用到方法上。

public HttpResponseMessage Get([IfNoneMatch] ETag etag)

还需要在全局注册:

config.ParameterBindingRules.Add(p => {
    if(p.ParameterType == typeof(ETag) && p.ActionDescriptor.SupportedHttpMethods.Contains(HttpMethod.Get))
    {
        return new ETagParameterBinding(p, ETagMatch.IfNoneMatch);
    }
    else
    {
        return null;
    }
})

总结,本篇体验了简单类型和复杂类型获取前端数据的方式。并通过自定义ValueProvider, ModelBinder, HttpParameterBinding来实现对参数绑定过程的控制。

时间: 02-25

ASP.NET Web API中的参数绑定总结的相关文章

【ASP.NET Web API教程】4.3 ASP.NET Web API中的异常处理

参考页面: http://www.yuanjiaocheng.net/webapi/create-crud-api-1-delete.html http://www.yuanjiaocheng.net/webapi/Consume-web-api.html http://www.yuanjiaocheng.net/webapi/mvc-consume-webapi-get.html http://www.yuanjiaocheng.net/webapi/mvc-consume-webapi-po

【Web API系列教程】2.1 — ASP.NET Web API中的路由机制

这篇文章描述了ASP.NET Web API如何将HTTP请求发送(路由)到控制器. 备注:如果你对ASP.NET MVC很熟悉,你会发现Web API路由和MVC路由非常相似.主要区别是Web API使用HTTP方法来选择动作(action),而不是URI路径.你也可以在Web API中使用MVC风格的路由.这篇文章不需要ASP.NET MVC的任何知识. 路由表 在ASP.NET Web API中,控制器是一个用于处理HTTP请求的类.控制器中的公共方法被称为动作方法或简单动作.当Web A

Asp.Net Web API 2第十三课——ASP.NET Web API中的JSON和XML序列化

前言 阅读本文之前,您也可以到Asp.Net Web API 2 系列导航进行查看 http://www.cnblogs.com/aehyok/p/3446289.html 本文描述ASP.NET Web API中的JSON和XML格式化器. 在ASP.NET Web API中,媒体类型格式化器(Media-type Formatter)是一种能够做以下工作的对象: 从HTTP消息体读取CLR(公共语言运行时)对象 将CLR对象写入HTTP消息体 Web API提供了用于JSON和XML的媒体类

[转]让ASP.NET Web API支持$format参数的方法

本文转自:http://www.cnblogs.com/liuzhendong/p/4228592.html 在不使用OData的情况下,也可以让ASP.NET Web API支持$format参数,只要在WebApiConfig里添加如下三行红色粗体代码即可: using System; using System.Collections.Generic; using System.Linq; using System.Web.Http; using System.Net.Http.Format

让ASP.NET Web API支持$format参数的方法

在不使用OData的情况下,也可以让ASP.NET Web API支持$format参数,只要在WebApiConfig里添加如下三行红色粗体代码即可: using System; using System.Collections.Generic; using System.Linq; using System.Web.Http; using System.Net.Http.Formatting; namespace ProjectManagementWebAppV4 { public stat

ASP.NET Web API中使用OData

在ASP.NET Web API中使用OData 一.什么是ODataOData是一个开放的数据协议(Open Data Protocol)在ASP.NET Web API中,对于CRUD(create, read, update, and delete)应用比传统WebAPI增加了很大的灵活性只要正确使用相关的协议,可以在同等情况下对一个CRUD应用可以节约很多开发时间,从而提高开发效率 二.怎么搭建 做一个简单的订单查询示例我们使用Code First模式创建两个实体对象Product(产品

在ASP.NET Web API中使用OData

http://www.alixixi.com/program/a/2015063094986.shtml 一.什么是ODataOData是一个开放的数据协议(Open Data Protocol)在ASP.NET Web API中,对于CRUD(create, read, update, and delete)应用比传统WebAPI增加了很大的灵活性只要正确使用相关的协议,可以在同等情况下对一个CRUD应用可以节约很多开发时间,从而提高开发效率 二.怎么搭建 做一个简单的订单查询示例我们使用Co

能省则省:在ASP.NET Web API中通过HTTP Headers返回数据

对于一些返回数据非常简单的 Web API,比如我们今天遇到的“返回指定用户的未读站内短消息数”,返回数据就是一个数字,如果通过 http response body 返回数据,显得有些奢侈.何不直接通过 http headers 返回呢?节能又环保.于是今天在 ASP.NET Web API 中实际试了一下,证明是可行的. 在 Web API 服务端借助 HttpResponseMessage ,可以很轻松地实现,代码如下: public class MessagesController :

ASP.NET Web API中实现版本的几种方式

在ASP.NET Web API中,当我们的API发生改变,就涉及到版本问题了.如何实现API的版本呢? 1.通过路由设置版本 最简单的一种方式是通过路由设置,不同的路由,不同的版本,不同的controller. config.Routes.MapHttpRoute( name: "Food", routeTemplate: "api/v1/nutrition/foods/{foodid}", defaults:... ) config.Routes.MapHttp