WebApi參數傳遞總結

在WebAPI中，請求主體(HttpContent)只能被讀取一次，不被緩存，只能向前讀取的流。

舉例子說明：

1. 請求地址：/?id=123&name=bob 

    服務端方法： void Action(int id, string name) // 全部參數都是簡單類型，於是都未來自url

2. 請求地址：/?id=123&name=bob 

    服務端方法： void Action([FromUri] int id, [FromUri] string name) // 同上

                      void Action([FromBody] string name); //[FormBody]特性顯示標明讀取整個body爲一個字符串做爲參數

3. 請求地址： /?id=123 

    類定義：

public class Customer {   // 定義的一個複雜對象類型 
  public string Name { get; set; } 
  public int Age { get; set; } 
}

    服務端方法： void Action(int id, Customer c) // 參數id從query string中讀取，參數c是一個複雜Customer對象類戲，經過formatter從body中讀取

    服務端方法： void Action(Customer c1, Customer c2) // 出錯！多個參數都是複雜類型，都試圖從body中讀取，而body只能被讀取一次

    服務端方法： void Action([FromUri] Customer c1, Customer c2) // 能夠！不一樣於上面的action，複雜類型c1將從url中讀取，c2將從body中讀取

4.ModelBinder方式：

void Action([ModelBinder(MyCustomBinder)] SomeType c) // 標示使用特定的model binder來解析參數

[ModelBinder(MyCustomBinder)] public class SomeType { } // 經過給特定類型SomeType聲明標註[ModelBidner(MyCustomBinder)]特性使得全部SomeType類型參數應用此規則 

void Action(SomeType c) // 因爲c的類型爲SomeType，於是應用SomeType上的特性決定其採用model binding

 

總結：

1. 默認簡單參數都經過URL參數方式傳遞，例外：

1.1 若是路由中包含了Id參數，則id參數經過路由方式傳遞；

1.2 若是參數被標記爲[FromBody]，則能夠該參數能夠爲簡單參數，客戶端經過POST方式傳遞：$.ajax(url, '=value')，或者$.ajax({url: url, data: {'': 'value'}});

2. 默認複雜參數(自定義實體類)都經過POST方式傳遞，例外：

2.1 若是參數值被標記爲[FromUri]， 則該參數能夠爲複雜參數；

3. 被標記爲[FromBody]的參數只容許出現一次， 被標記爲[FromUri]的參數能夠出現屢次，若是被標記爲[FromUri]的參數是簡單參數，該標記能夠去掉。