微信小程序給我們提供了一個(gè)很好的開發(fā)平臺(tái)僧鲁，可以用于展現(xiàn)各種數(shù)據(jù)和實(shí)現(xiàn)豐富的功能坏挠，通過小程序的請求Web API 平臺(tái)獲取JSON數(shù)據(jù)后站故，可以在小程序界面上進(jìn)行數(shù)據(jù)的動(dòng)態(tài)展示蚕键。在數(shù)據(jù)的關(guān)鍵 一環(huán)中泌豆，我們設(shè)計(jì)和編寫Web API平臺(tái)是非常重要的定庵，通過這個(gè)我們可以實(shí)現(xiàn)數(shù)據(jù)的集中控制和管理，本篇隨筆介紹基于Asp.NET MVC的Web API接口層的設(shè)計(jì)和常見接口代碼的展示踪危，以便展示我們常規(guī)Web API接口層的接口代碼設(shè)計(jì)蔬浙、參數(shù)的處理等內(nèi)容。
1贞远、Web API整體性的架構(gòu)設(shè)計(jì)
我們整體性的架構(gòu)設(shè)計(jì)畴博，包含一個(gè)Web管理后臺(tái)、一個(gè)Web API統(tǒng)一接口層兴革、當(dāng)然還有數(shù)據(jù)庫什么绎晃，另外還有一個(gè)小程序客戶端。整個(gè)架構(gòu)體系還是以我之前隨筆介紹的《整合微信小程序的Web API接口層的架構(gòu)設(shè)計(jì)》內(nèi)容為藍(lán)本
整個(gè)體系以Web API為主提供服務(wù)杂曲，同時(shí)后臺(tái)管理系統(tǒng)通過各種界面維護(hù)著數(shù)據(jù)的增刪改等基礎(chǔ)管理工作庶艾。
Web API的分層，我們可以通過下圖來了解具體的分層結(jié)構(gòu)擎勘。
隨著基于JSON格式的Web API的廣泛應(yīng)用咱揍，越來越多的企業(yè)采用Web API接口服務(wù)層，作為統(tǒng)一接口的核心所在棚饵，也成為Web API核心層煤裙。基于JSON格式的接口噪漾，可以廣泛地硼砰、跨平臺(tái)的應(yīng)用于IOS、安卓等移動(dòng)端欣硼，也可以應(yīng)用在常規(guī)的Web業(yè)務(wù)系統(tǒng)题翰，Winform業(yè)務(wù)系統(tǒng)、微信應(yīng)用、微信小程序等方方面面豹障，因此企業(yè)內(nèi)部形成自己是的一套Web API標(biāo)準(zhǔn)和詳細(xì)的文檔非常重要冯事。
我們可以細(xì)化為下面的架構(gòu)設(shè)計(jì)圖，所有模塊均圍繞著Web API 接口層進(jìn)行擴(kuò)展血公，底層的數(shù)據(jù)存儲(chǔ)對上層的應(yīng)用是完全透明昵仅，我們可以根據(jù)需要拆分各種業(yè)務(wù)數(shù)據(jù)庫，以及使用我們認(rèn)為合適的數(shù)據(jù)庫累魔。
其中我們在Web API接口層上還看到一個(gè)微信消息交互的模塊摔笤，這個(gè)模塊我們?yōu)榱朔奖阌蛎丝诘奶幚恚蚖eb API 是統(tǒng)一放在一起的，它負(fù)責(zé)和騰訊微信服務(wù)器進(jìn)行消息的交互處理，從而實(shí)現(xiàn)各種消息推送處理逾一。
2、基于Asp.NET MVC的Web API接口的實(shí)現(xiàn)
1）GET方式
GET方式寞冯，接口參數(shù)包括有零或一個(gè)參數(shù)，以及多個(gè)參數(shù)的方式晚伙，返回的值可以是簡單的字符串等基礎(chǔ)類型吮龄，也可以是復(fù)雜的自定義對象類型等，如下面幾種接口代碼所示咆疗。
/// <summary>
/// 簡單的GET方式獲取數(shù)據(jù)
/// </summary>
/// <param name="id">字符串ID</param>
/// <param name="token">接口訪問令牌</param>
/// <returns>返回字符串值</returns>
[HttpGet]
public string Test(string id, string token)
{
return string.Format("返回結(jié)果, id:{0}", id);
}
/// <summary>
/// 多個(gè)參數(shù)的GET方式獲取數(shù)據(jù)
/// </summary>
/// <param name="id">字符串ID</param>
/// <param name="name">名稱</param>
/// <param name="token">接口訪問令牌</param>
/// <returns>返回字符串值</returns>
[HttpGet]
public string TestMulti(string id, string name, string token)
{
return string.Format("返回結(jié)果, id:{0} name:{1}", id, name);
}
/// <summary>
/// 參數(shù)測試GET返回自定義實(shí)體類對象
/// </summary>
/// <param name="id">字符串ID</param>
/// <param name="token">接口訪問令牌</param>
/// <returns>返回自定義實(shí)體類對象</returns>
[HttpGet]
public virtual CommonResult TestObject(string id, string token)
{
return new CommonResult() { Data1 = id, Success = true };
}
/// <summary>
/// 測試GET返回列表對象
/// </summary>
/// <param name="token">接口訪問令牌</param>
/// <returns>返回列表對象</returns>
[HttpGet]
public List<string> TestAction(string token)
{
List<string> list = new List<string>() { "123", "234", "345" };
return list;
}
2）POST方式
POST方式漓帚，同樣也和GET方式的一樣，接口參數(shù)包括有零或一個(gè)參數(shù)午磁，以及多個(gè)參數(shù)的方式尝抖，返回的值可以是簡單的字符串等基礎(chǔ)類型，也可以是復(fù)雜的自定義對象類型等迅皇，這就是幾種常規(guī)的接口處理昧辽。但是，對于多個(gè)參數(shù)的接口定義登颓，我們需要對它們進(jìn)行轉(zhuǎn)換處理搅荞，需要使用JObject param的方式進(jìn)行定義，這樣可以很好對多個(gè)參數(shù)或者自定義的實(shí)體類參數(shù)進(jìn)行解析框咙。
下面是幾種常規(guī)的POST接口定義方式咕痛。
/// <summary>
/// 測試使用POST方式提交數(shù)據(jù)，參數(shù)輸入為多個(gè)喇嘱，使用JObject處理
/// </summary>
/// <returns>返回字符串</returns>
[HttpPost]
public string TestPost(JObject param, string token)
{
dynamic obj = param;
string id = obj.id;
if (obj != null)
{
return string.Format("返回結(jié)果, id:{0}", id);
}
else
{
throw new MyApiException("傳遞參數(shù)出現(xiàn)錯(cuò)誤");
}
}
/// <summary>
/// 測試使用POST方式提交數(shù)據(jù)茉贡，參數(shù)輸入為多個(gè)，使用JObject處理
/// </summary>
/// <returns>返回參數(shù)計(jì)算數(shù)值</returns>
[HttpPost]
public int TestPostSimple(JObject param)
{
dynamic obj = param;
if (obj != null)
{
return obj.x * obj.y * 10;
}
else
{
throw new MyApiException("傳遞參數(shù)出現(xiàn)錯(cuò)誤");
}
}
/// <summary>
/// 測試POST的方法者铜，方法統(tǒng)一采用JObject param 方式定義腔丧，包含一個(gè)msg字符串對象构蹬，以及一個(gè)CListItem對象
/// </summary>
/// <returns>返回一個(gè)通用的CommonResult對象，包括Data1,Data2,Data3的信息</returns>
[HttpPost]
public CommonResult TestPostObject(JObject param)
{
dynamic obj = param;
if (obj != null)
{
string msg = obj.msg; //消息對象
//如果obj.item為類對象悔据，那么需要轉(zhuǎn)換為JObject然后使用ToObject轉(zhuǎn)換為對應(yīng)類型
CListItem item = ((JObject)obj.item).ToObject<CListItem>();
var result = new CommonResult(true, msg);
result.Data1 = msg;
result.Data2 = item.Text;
result.Data3 = item.Value;
return result;
}
else
{
throw new MyApiException("傳遞參數(shù)出現(xiàn)錯(cuò)誤");
}
}
/// <summary>
/// 修改分組，方法統(tǒng)一采用JObject param 方式定義俗壹，包括一個(gè)字符串對象contactId科汗，一個(gè)字符串列表對象groupIdList
/// </summary>
/// <returns>返回一個(gè)通用的對象</returns>
[HttpPost]
public CommonResult TestPostList(JObject param)
{
dynamic obj = param;
if (obj != null)
{
string contactId = obj.contactId; //聯(lián)系人ID
//如果是List<string>的類似列表，不能直接轉(zhuǎn)換绷雏，先轉(zhuǎn)換為JArray后使用ToObject轉(zhuǎn)換為對應(yīng)列表
List<string> groupIdList = ((JArray)obj.groupIdList).ToObject<List<string>>();
var result = true; //BLLFactory<Address>.Instance.ModifyAddressGroup(contactId, groupIdList);
return new CommonResult(result);
}
else
{
throw new MyApiException("傳遞參數(shù)出現(xiàn)錯(cuò)誤头滔，請檢查是否包含了contactId和groupIdList");
}
}
接口類，我們一般把類繼承自自己的API接口基類涎显，并對它的異常處理進(jìn)行處理坤检，以便對錯(cuò)誤統(tǒng)一格式回應(yīng)，如下接口類的代碼定義所示期吓。
/// <summary>
/// 此控制器用來詳細(xì)介紹各種GET/POST的接口設(shè)計(jì)
/// 對于GET方式早歇，方法可以接受多個(gè)參數(shù)
/// 對于POST方式，方法如果有參數(shù)使用POST方式讨勤，統(tǒng)一采用JObject param對象參數(shù)箭跳。
/// 如果POST方式有多個(gè)參數(shù)，如Web API接口加token潭千，則需要客戶端把該參數(shù)追加在URL上谱姓，如url?token=123，然后在使用POST操作
/// </summary>
[ExceptionHandling]
public class TestController : BaseApiController
其中ExceptionHandling是我們的統(tǒng)一異常過濾處理定義刨晴，代碼如下所示屉来。
/// <summary>
/// API自定義錯(cuò)誤過濾器屬性
/// </summary>
public class ExceptionHandlingAttribute : ExceptionFilterAttribute
{
/// <summary>
/// 統(tǒng)一對調(diào)用異常信息進(jìn)行處理，返回自定義的異常信息
/// </summary>
/// <param name="context">HTTP上下文對象</param>
public override void OnException(HttpActionExecutedContext context)
{
//自定義異常的處理
MyApiException ex = context.Exception as MyApiException;
if (ex != null)
{
//記錄關(guān)鍵的異常信息
LogHelper.Error(context.Exception);
throw new HttpResponseException(new HttpResponseMessage(HttpStatusCode.InternalServerError)
{
//封裝處理異常信息狈癞，返回指定JSON對象
Content = new StringContent(new BaseResultJson(ex.Message, false, ex.errcode).ToJson()),
ReasonPhrase = "Exception"
});
}
//常規(guī)異常的處理
string msg = string.IsNullOrEmpty(context.Exception.Message) ? "接口出現(xiàn)了錯(cuò)誤茄靠，請重試或者聯(lián)系管理員" : context.Exception.Message;
throw new HttpResponseException(new HttpResponseMessage(HttpStatusCode.InternalServerError)
{
Content = new StringContent(msg),
ReasonPhrase = "Critical Exception"
});
}
}
3）小程序端代碼處理
小程序端主要是通過JS代碼進(jìn)行處理，實(shí)現(xiàn)數(shù)據(jù)的獲取及提交處理等亿驾。
如我們列舉一個(gè)代表性的POST處理代碼嘹黔，如下所示。
//測試POst方法
wx.request({
url: 'http://localhost:27206/api/SmallApp/Test/TestPostObject',
data: {
msg : '測試內(nèi)容',
item: {Text :'Text', Value:'testValue'}
},
header: {'Content-Type': 'application/json' },
method: 'POST',
success: function (res) {
console.log(res.data);
}
});
而對于GET方式莫瞬，我們的小程序調(diào)用方式如下所示儡蔓。
getFilms: function(start) {
console.log('start:' + start);
var that = this
wx.request({
url: 'http://www.iqidi.com/api/h5/test/movies',
data: {
offset: start,
type: 'hot',
limit: that.data.limit
},
header: {
'Content-Type': 'application/json'
},
success: function (res) {
console.log(res.data)
var data = res.data.data;
console.log(data);
if (data.movies.length === 0) {
that.setData({
hasMore: false,
hideLoading :true,
})
}
else {
that.setData({
films: that.data.films.concat(data.movies),
start: that.data.start + data.movies.length,
hasMore: true,
hideLoading :true,
});
}
}
})
以上就是我們常規(guī)接口（單個(gè)參數(shù)或者多個(gè)參數(shù)，簡單對象和復(fù)雜對象的處理）的定義代碼疼邀，希望讀者在開發(fā)Web API接口的時(shí)候喂江，可以有所幫助。
