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]的參數是簡單參數,該標記可以去掉。

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM