前言

上一篇《.net core實踐系列之短信服務-Sikiro.SMS.Api服務的實現》講解了API的設計與實現，本篇主要講解編寫接口的SDK編寫還有API的測試。

或許有些人會認為，SDK的編寫可以不需要，既然已經用了RESTful web服務與Swagger提供的接口描述，只要選擇合適的接口調用框架，找到對應Swagger文檔按需調用即可。

這個我贊同，特別在微服務架構下使用了API網關與服務發現。因此本篇也是借用編寫SDK來模擬在客戶端使用接口框架調用，並增加負載測試的講解，供需要的朋友們分享。

項目源碼地址：https://github.com/SkyChenSky/Sikiro.SMS.git

SDK

Software Development Kit的縮寫，翻譯中文為軟件開發工具包，百度定義為軟件工程師用於為特定的軟件包、軟件框架、硬件平台、操作系統等創建應用軟件的開發工具的集合。而我們這里的SDK主要是以工具庫的形式提供給部門內部使用API。

設計要點

盡量少的依賴
多形式方法重載
高可讀性

從上三點得出，高可讀的方法注釋，方便使用的多重載(單條、多條、異步、同步)，如涉及到枚舉，不要依賴原有項目的其他庫，應拷貝過來完整提供。

組件選擇

RestSharp
.Net Standard

RestSharp

為了良好的調用RESTful API，我選擇RestSharp這個RESTful接口調用框架。

源碼地址：https://github.com/restsharp/RestSharp

優點

請求調用與響應結果的直觀化：

步驟:

傳入資源
定義動作
設置表述類型
傳入實體參數

注意點

1.默認序列化類型為XML，應手動設置為JSON

RequestFormat = DataFormat.Json

2.反序列化有缺陷，對於實體內的類類型屬性（List<T>、自定義類等），應再構造函數初始化賦默認值

 public class SearchResponse
    {
        public SearchResponse()
        {
            Mobiles = new List<string>();
        }

        public string Content { get; set; }
        public int Type { get; set; }
        public int Status { get; set; }
        public List<string> Mobiles { get; set; }

        [SerializeAs(Name = "_id", Attribute = true)]
        public string Id { get; set; }
    }

示例

public static class Sms
    {
        private static RestClient _client;

        private static string Host { get; set; }

        public static void Init(string host)
        {
            Host = host;
            _client = new RestClient(Host);
        }

        public static async Task<Response> SendAsync(List<SendEntity> sendList)
        {
            var request = new RestRequest("sms", Method.POST) { RequestFormat = DataFormat.Json };

            request.AddBody(sendList);

            var response = await _client.ExecuteTaskAsync(request);

            return ToResponse(response);
        }

        public static async Task<Response> SendAsync(SendEntity sendEntity)
        {
            return await SendAsync(new List<SendEntity> { sendEntity });
        }

        public static Response Send(List<SendEntity> sendList)
        {
            var request = new RestRequest("sms", Method.POST) { RequestFormat = DataFormat.Json };

            request.AddBody(sendList);

            var response = _client.Execute(request);

            return ToResponse(response);
        }

        public static Response Send(SendEntity sendEntity)
        {
            return Send(new List<SendEntity> { sendEntity });
        }

        public static Response<SearchResponse> Get(string id)
        {
            var request = new RestRequest("sms/{id}", Method.GET);

            request.AddUrlSegment("id", id);

            var response = _client.Execute<SearchResponse>(request);

            return ToResponse(response);
        }

        public static Response<List<SearchResponse>> Search(SearchEntity searchModel)
        {
            var request = new RestRequest("sms/_search", Method.POST) { RequestFormat = DataFormat.Json };
            request.AddBody(searchModel);

            var response = _client.Execute<List<SearchResponse>>(request);

            return ToResponse(response);
        }

        private static Response<T> ToResponse<T>(IRestResponse<T> t)
        {
            var msg = t.IsSuccessful ? t.StatusCode.ToString() : t.Content;
            return new Response<T> { Body = t.Data, StateCode = t.StatusCode, Message = t.ErrorMessage ?? msg, IsSuccess = t.IsSuccessful };
        }

        private static Response ToResponse(IRestResponse t)
        {
            var msg = t.IsSuccessful ? t.StatusCode.ToString() : t.Content;
            return new Response { StateCode = t.StatusCode, Message = t.ErrorMessage ?? msg, IsSuccess = t.IsSuccessful };
        }
    }

.Net Standard

公司里除了有新用的.NET Core項目還有大量的存量.NET Framework舊項目。

.NET Standard是一種規范，無法以此建立應用，但他能以庫的形式作為支撐。.NET Standard的出現為了解決以編寫一次的庫來同時支持多個平台（.NET Framework、.NET Core、Xamarin）的使用。

為了實現多平台的API標准映射，不同版本的映射與數量也隨着不一樣

.NET Standard	1.0	1.1	1.2	1.3	1.4	1.5	1.6	2.0
.NET Core	1.0	1.0	1.0	1.0	1.0	1.0	1.0	2.0
.NET Framework	4.5	4.5	4.5.1	4.6	4.6.1	4.6.1	4.6.1	4.6.1
Mono	4.6	4.6	4.6	4.6	4.6	4.6	4.6	vNext
Xamarin.iOS	10.0	10.0	10.0	10.0	10.0	10.0	10.0	vNext
Xamarin.Android	7.0	7.0	7.0	7.0	7.0	7.0	7.0	vNext
Universal Windows Platform	10.0	10.0	10.0	10.0	10.0	vNext	vNext	vNext
Windows	8.0	8.0	8.1
Windows Phone	8.1	8.1	8.1
Windows Phone Silverlight	8.0