ASP.NET Web API中的參數綁定總結

来源:http://www.cnblogs.com/darrenji/archive/2016/02/28/5223938.html
-Advertisement-
Play Games

ASP.NET Web API中的action參數類型可以分為簡單類型和複雜類型。HttpResponseMessage Put(int id, Product item)id是int類型，是簡單類型，item是Product類型，是複雜類型。簡單類型實參值從哪裡讀取呢？--一般從URI中讀取所謂的


 

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來實現對參數綁定過程的控制。

 


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 最新深度ghost win7系統下載
    深度技術ghost win7系統 64位快速安裝版 V2016年2月，深度技術ghost win7 64位快速安裝版在不影響大多數軟體和硬體運行的前提下，已經儘可能關閉非必要服務，自動安裝AMD/Intel 雙核 CPU 驅動和優化程式，發揮新平臺的最大性能。首次登陸桌面，後臺自動判斷和執行清理目標
  • 字元串處理的的相關用法
    首先定義一個字元串： string str = "abc"; 1.字元大小寫轉化 大寫：str.ToUpper(); 小寫： str.ToLower(); 2.字元和Ascii碼互相轉換 Ascii碼：byte[] b = Encoding.GetEncoding("unicode").GetByt
  • 開始C#之旅
    註釋 /// <summary> /// 3.文檔註釋 /// </summary> private static void Test() { Console.WriteLine("Hello world!");// 1.單行註釋 Console.ReadKey(); /* 2.塊註釋 Consol
  • 《C#微信開發系列（3）-獲取介面調用憑據》
    3.0獲取介面調用憑據 ①介面說明 access_token是公眾號的全局唯一票據，公眾號調用各介面時都需使用access_token。開發者需要進行妥善保存。access_token的存儲至少要保留512個字元空間。access_token的有效期目前為2h(7200s)，需定時刷新，重覆獲取將導
  • 字典集合Dictionary<K,V>和構造的應用==>>體檢套餐項目
    效果 首先，我們先來準備我們需要的類 1.檢查項目類 using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; namespa
  • 細說 Web API參數綁定和模型綁定
    今天跟大家分享下在Asp.NET Web API中Controller是如何解析從客戶端傳遞過來的數據，然後賦值給Controller的參數的，也就是參數綁定和模型綁定。 Web API參數綁定就是簡單類型的綁定，比如：string,char,bool,int,uint,byte,sbyte,sho
  • c#如何採集需要登錄的頁面
    首先說明：代碼片段是從網路獲取，然後自己修改。我想好的東西應該拿來分享。 先說下原理：當我們採集頁面的時候，如果被採集的網站需要登錄才能採集。不管是基於Cookie還是基於Session，我們都會首先發送一個Http請求頭，這個Http請求頭裡面就包含了網站需要的Cookie信息。當網站接收到發送過
  • 在Visual Studio Code中配置GO開發環境
    一、GO語言安裝 詳情查看：GO語言下載、安裝、配置 二、GoLang插件介紹 對於Visual Studio Code開發工具，有一款優秀的GoLang插件，它的主頁為：https://github.com/microsoft/vscode-go 這款插件的特性包括： Colorization 代
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類