自拍偷在线精品自拍偷,亚洲欧美中文日韩v在线观看不卡

Web API接口設(shè)計經(jīng)驗總結(jié)

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

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

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

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

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

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

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

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

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

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

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

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

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

dynamic obj = param;

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

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

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

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

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

3、集合和分頁的處理

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

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

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

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

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

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

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

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

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

***客戶端調(diào)用分頁的Web API代碼如下所示。

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

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

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

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

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

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

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

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

<

 
責(zé)任編輯：王雪燕 來源： 博客園
WebAPI接口設(shè)計
相關(guān)推薦

2009-08-21 17:42:36

C#調(diào)用API

2009-09-02 14:14:44

C# COM接口轉(zhuǎn)換

2009-10-15 09:27:00

2015-10-16 14:35:05

SaaSCRM架構(gòu)設(shè)計

2009-10-16 18:01:06

VB.NET調(diào)用Win

2009-09-16 17:13:54

學(xué)習(xí)Linq

2009-08-19 09:24:43

AJAX引擎經(jīng)驗總結(jié)

2009-09-29 16:32:11

OJB Hiberna

2010-01-14 16:14:15

VB.NET界面設(shè)計

2009-09-16 17:44:54

LINQ to SQL

2009-09-08 10:57:55

LINQ查詢操作

2011-07-08 13:15:52

JSP

2009-09-11 13:29:31

LINQ查詢操作

2009-10-22 15:07:12

綜合布線工程

2009-11-17 11:24:00

PHP應(yīng)用技巧

2010-06-12 17:37:18

UML實踐指南

2009-09-08 16:02:47

Linq使用Group

2009-08-20 17:35:47

Servlet和JSP

2011-07-21 13:40:17

java

2009-08-13 18:13:27

C#學(xué)習(xí)經(jīng)驗
點贊
收藏

51CTO技術(shù)棧公眾號