日韩无码专区无码一级三级片|91人人爱网站中日韩无码电影|厨房大战丰满熟妇|AV高清无码在线免费观看|另类AV日韩少妇熟女|中文日本大黄一级黄色片|色情在线视频免费|亚洲成人特黄a片|黄片wwwav色图欧美|欧亚乱色一区二区三区

RELATEED CONSULTING
相關咨詢
選擇下列產品馬上在線溝通
服務時間：8:30-17:00
你可能遇到了下面的問題
關閉右側工具欄

新聞中心

這里有您想知道的互聯(lián)網營銷解決方案
WebAPI接口設計經驗總結

 

在Web API接口的開發(fā)過程中，我們可能會碰到各種各樣的問題，我在前面兩篇隨筆《Web API應用架構在Winform混合框架中的應用（1）》、《Web API應用架構在Winform混合框架中的應用（2）--自定義異常結果的處理》也進行了總的介紹，在經過我的大量模塊實踐并成功運行后，總結了這篇隨筆，希望對大家有所幫助。

1、在接口定義中確定MVC的GET或者POST方式

由于我們整個Web API平臺是基于MVC的基礎上進行的API開發(fā)，因此整個Web API的接口，在定義的時候，一般需要顯示來聲明接口是[HttpGet]或者[HttpPost]，雖然有些接口也可以不用聲明，但是避免出現(xiàn)類似下面 的錯誤信息，顯式聲明還是有好處的。

例如在基類定義的查找對象接口如下所示。

  
 
    
   
  
  1. ///  
    2. 
   
  
  2.         /// 查詢數(shù)據(jù)庫,檢查是否存在指定ID的對象 
    3. 
   
  
  3.         ///  
    4. 
   
  
  4.         /// 對象的ID值 
    5. 
   
  
  5.         /// 存在則返回指定的對象,否則返回Null 
    6. 
   
  
  6.         [HttpGet] 
    7. 
   
  
  7.         public virtual T FindByID(string id, string token) 
    8.

如果是增刪改的接口，一般需要聲明為POST方式提交數(shù)據(jù)，而且基于安全性的考慮，需要攜帶更多的參數(shù)。

     
   
    
      
    
  1. ///  
    2. 
      
    
  2.         /// 插入指定對象到數(shù)據(jù)庫中 
    3. 
      
    
  3.         ///  
    4. 
      
    
  4.         /// 指定的對象 
    5. 
      
    
  5.         /// 執(zhí)行操作是否成功。 
    6. 
      
    
  6.         [HttpPost] 
    7. 
      
    
  7.         public virtual CommonResult Insert(T info, string token, string signature, string timestamp, string nonce, string appid)  
    8.

2、動態(tài)對象的接口定義

在一般的Web API接口里面，我們可能都會碰到很多簡單類型的參數(shù)，但是又想讓它們以POST方式提交數(shù)據(jù)，那么我們就可以有兩種方法來處理，一種是定義一個類來放置 這些參數(shù)，一種是采用動態(tài)的JObject參數(shù)，前者有很多不方便的地方，因為我們不可能為每個接口參數(shù)定義多一個實體類，這樣可能會有很多難以管理的類 定義。如下面是微信API的調用接口案例，我們也需要設置這樣的處理規(guī)則。

 
 
    
  
  
  1. 接口調用請求說明 
    2. 
  
  
  2. http請求方式: POST（請使用https協(xié)議） 
    3. 
  
  
  3. https://api.weixin.qq.com/cgi-bin/groups/update?access_token=ACCESS_TOKEN 
    4. 
  
  
  4. POST數(shù)據(jù)格式：json 
    5. 
  
  
  5. POST數(shù)據(jù)例子：{"group":{"id":108,"name":"test2_modify2"}} 
    6.

那么我們采用JObject是這么樣的呢，我們來看接口的定義和處理代碼。JObject是Newtonsoft.Json.Linq命名空間下的一個對象。

  

  
 
    
   
  
  1. ///  
    2. 
   
  
  2.         /// 修改用戶密碼 
    3. 
   
  
  3.         ///  
    4. 
   
  
  4.         /// 包含userName和userPassword的復合對象 
    5. 
   
  
  5.         /// 用戶訪問令牌 
    6. 
   
  
  6.         ///  
    7. 
   
  
  7.         [HttpPost] 
    8. 
   
  
  8.         public CommonResult ModifyPassword(JObject param,  string token) 
    9. 
   
  
  9.         { 
    10. 
   
  
  10.             //令牌檢查,不通過則拋出異常 
    11. 
   
  
  11.             CheckResult checkResult = CheckToken(token); 
    12. 
   
  
  12.             dynamic obj = param; 
    13. 
   
  
  13.             if (obj != null) 
    14. 
   
  
  14.             { 
    15. 
   
  
  15.                 string userName = obj.userName; 
    16. 
   
  
  16.                 string userPassword = obj.userPassword; 
    17. 
   
  
  17.  
    18. 
   
  
  18.                 bool success = BLLFactory.Instance.ModifyPassword(userName, userPassword); 
    19. 
   
  
  19.                 return new CommonResult(success); 
    20. 
   
  
  20.             } 
    21. 
   
  
  21.             else 
    22. 
   
  
  22.             { 
    23. 
   
  
  23.                 throw new MyApiException("傳遞參數(shù)出現(xiàn)錯誤"); 
    24. 
   
  
  24.             } 
    25. 
   
  
  25.         } 
    26.

 

其中我們把JObject對象轉換為我們所需要的對象的時候，因為我們沒有定義具體的實體類，因此采用了dynamic語法，聲明這是一個動態(tài)對象，由運行時獲取對應的屬性。

dynamic obj = param;

這樣我們就可以在調用的時候，動態(tài)POST對應的JSON對象給Web API接口，而不需要預先定義各種接口參數(shù)的類了。

  

  
 
    
   
  
  1. ///  
    2. 
   
  
  2.         /// 調用Web API接口，修改用戶密碼 
    3. 
   
  
  3.         ///  
    4. 
   
  
  4.         /// 用戶名稱 
    5. 
   
  
  5.         /// 修改的密碼 
    6. 
   
  
  6.         /// 如果修改成功返回true，否則返回false 
    7. 
   
  
  7.         public bool ModifyPassword(string userName, string userPassword) 
    8. 
   
  
  8.         { 
    9. 
   
  
  9.             var action = "ModifyPassword"; 
    10. 
   
  
  10.             var postData = new 
    11. 
   
  
  11.             { 
    12. 
   
  
  12.                 userName = userName, 
    13. 
   
  
  13.                 userPassword = userPassword 
    14. 
   
  
  14.             }.ToJson(); 
    15. 
   
  
  15.  
    16. 
   
  
  16.             string url = GetTokenUrl(action); 
    17. 
   
  
  17.  
    18. 
   
  
  18.             CommonResult result = JsonHelper.ConvertJson(url, postData); 
    19. 
   
  
  19.             return (result != null) ? result.Success : false; 
    20. 
   
  
  20.         } 
    21.

 

其中GetTokenUrl是根據(jù)token和API的地址等參數(shù)，構建一個完整的提交地址。我們在上面代碼通過

            var postData = new             {                 userName = userName,                 userPassword = userPassword             }.ToJson();

就可以動態(tài)創(chuàng)建一個對象，并生成它的JSON字符串，把數(shù)據(jù)POST提交到對應的API接口里面即可，然后對結果進行對象的轉換就算完成了。

3、集合和分頁的處理

在很多接口里面，我們都需要用到分頁的處理，Web API也不例外，這樣可以提交數(shù)據(jù)檢索效率，減少服務器數(shù)據(jù)處理的壓力，同時也提交客戶端的數(shù)據(jù)顯示速度。

一般的集合接口定義如下所示（通用性基類接口）。

 
 
    
  
  
  1. ///  
    2. 
  
  
  2.         /// 返回數(shù)據(jù)庫所有的對象集合 
    3. 
  
  
  3.         ///  
    4. 
  
  
  4.         /// 指定對象的集合 
    5. 
  
  
  5.         [HttpGet] 
    6. 
  
  
  6.         public virtual List GetAll(string token) 
    7. 
  
  
  7.         { 
    8. 
  
  
  8.             //檢查用戶是否有權限，否則拋出MyDenyAccessException異常 
    9. 
  
  
  9.             base.CheckAuthorized(AuthorizeKey.ListKey, token); 
    10. 
  
  
  10.  
    11. 
  
  
  11.             List list = baseBLL.GetAll(); 
    12. 
  
  
  12.             return list; 
    13. 
  
  
  13.         } 
    14.

但是這樣的返回記錄會比較多，一般情況下需要分頁，那么分頁的處理接口定義如下所示。

  

  
 
    
   
  
  1. ///  
    2. 
   
  
  2.         /// 根據(jù)條件查詢數(shù)據(jù)庫,并返回對象集合(用于分頁數(shù)據(jù)顯示) 
    3. 
   
  
  3.         ///  
    4. 
   
  
  4.         /// 指定對象的集合 
    5. 
   
  
  5.         [HttpPost] 
    6. 
   
  
  6.         public virtual PagedList FindWithPager(string condition, PagerInfo pagerInfo, string token) 
    7.

 

分頁接口，在這里返回的結果里面，用了一個PageList的泛型類，這個方便我們獲取當前的記錄及總數(shù)，它的定義如下所示。 

 
 
    
  
  
  1. ///  
    2. 
  
  
  2.     /// 分頁集合 
    3. 
  
  
  3.     ///  
    4. 
  
  
  4.     /// 對象 
    5. 
  
  
  5.     public class PagedList 
    6. 
  
  
  6.     { 
    7. 
  
  
  7.         ///  
    8. 
  
  
  8.         /// 返回記錄的總數(shù) 
    9. 
  
  
  9.         ///  
    10. 
  
  
  10.         public int total_count { get; set; } 
    11. 
  
  
  11.  
    12. 
  
  
  12.         ///  
    13. 
  
  
  13.         /// 列表集合 
    14. 
  
  
  14.         ///  
    15. 
  
  
  15.         public List list { get; set; } 
    16. 
  
  
  16.     } 
    17.

***整個分頁的處理Web API接口實現(xiàn)如下所示。

  

  
 
    
   
  
  1. ///  
    2. 
   
  
  2.         /// 根據(jù)條件查詢數(shù)據(jù)庫,并返回對象集合(用于分頁數(shù)據(jù)顯示) 
    3. 
   
  
  3.         ///  
    4. 
   
  
  4.         /// 指定對象的集合 
    5. 
   
  
  5.         [HttpPost] 
    6. 
   
  
  6.         public virtual PagedList FindWithPager(string condition, PagerInfo pagerInfo, string token) 
    7. 
   
  
  7.         { 
    8. 
   
  
  8.             //檢查用戶是否有權限，否則拋出MyDenyAccessException異常 
    9. 
   
  
  9.             base.CheckAuthorized(AuthorizeKey.ListKey, token); 
    10. 
   
  
  10.  
    11. 
   
  
  11.             List list = baseBLL.FindWithPager(condition, pagerInfo); 
    12. 
   
  
  12.  
    13. 
   
  
  13.             //構造成Json的格式傳遞 
    14. 
   
  
  14.             var result = new PagedList() { total_count = pagerInfo.RecordCount, list = list }; 
    15. 
   
  
  15.             return result; 
    16. 
   
  
  16.         } 
    17.

 

***客戶端調用分頁的Web API代碼如下所示。

  

  
 
    
   
  
  1. ///  
    2. 
   
  
  2.         /// 根據(jù)條件查詢數(shù)據(jù)庫,并返回對象集合(用于分頁數(shù)據(jù)顯示) 
    3. 
   
  
  3.         ///  
    4. 
   
  
  4.         /// 查詢的條件 
    5. 
   
  
  5.         /// 分頁實體 
    6. 
   
  
  6.         /// 指定對象的集合 
    7. 
   
  
  7.         public virtual List FindWithPager(string condition, ref PagerInfo pagerInfo) 
    8. 
   
  
  8.         { 
    9. 
   
  
  9.             var action = "FindWithPager"; 
    10. 
   
  
  10.             string url = GetTokenUrl(action) + string.Format("&condition={0}", condition); 
    11. 
   
  
  11.             var postData = pagerInfo.ToJson(); 
    12. 
   
  
  12.  
    13. 
   
  
  13.             List result = new List(); 
    14. 
   
  
  14.             PagedList list = JsonHelper>.ConvertJson(url, postData); 
    15. 
   
  
  15.             if (list != null) 
    16. 
   
  
  16.             { 
    17. 
   
  
  17.                 pagerInfo.RecordCount = list.total_count;//修改總記錄數(shù) 
    18. 
   
  
  18.                 result = list.list; 
    19. 
   
  
  19.             } 
    20. 
   
  
  20.             return result; 
    21. 
   
  
  21.         } 
    22.

4、混合框架界面整合Web API接口

在整個Web API的平臺構建以及在混合框架的整合過程中，我把各個模塊還是遵循相對獨立的方式進行開發(fā)和整合，它們實現(xiàn)了從直接訪問數(shù)據(jù)庫、以WCF服務獲取數(shù)據(jù)，以及通過WebAPI調用方式獲取數(shù)據(jù)幾種方式的統(tǒng)一，從而實現(xiàn)了整個混合框架的高度整合。

整個混合框架的核心是以相對獨立的方式，整合各個可重用的模塊，我們可以遵循一定的基礎上，快速構建統(tǒng)一的應用平臺。

搭建完畢的整個WebAPI平臺，其中包括了服務端內容，以API控制器的方式，發(fā)布了對應的Web API接口。

在每個混合框架的獨立模塊里面，我們封裝了對應的Web API客戶端調用處理，從而實現(xiàn)了Web API的調用方式。

在Win10下，使用Web API模式運行混合框架，獲得的主體界面效果如下所示。

獨立模塊權限管理系統(tǒng)界面如下所示。

<


本文標題：WebAPI接口設計經驗總結
網站鏈接：http://m.5511xx.com/article/ccdshej.html