C# 客戶端篇之實現Restful Client開發(RestSharp幫助類)

　　上篇文章《C# 服務端篇之實現RestFul Service開發(簡單實用)》講解到，如果開發一個簡單的Restful風格的Service，也提到了簡單創建一個Restful Client去如何調用Service的API，本文只要再次詳細講解一個高效便捷易擴展的Restful Client幫助類，就是RestSharp，如果只是想自己簡單實現一個Restful Client的方法，可以參考筆者上篇文章講解的Restful Service提到的測試Client的Demo，好了，下面主要講解一下今天的主(豬)角(腳)—RestSharp。

一、RestSharp簡紹

　　RestSharp是一個輕量的，不依賴任何第三方的組件或者類庫的Http的組件。RestSharp具體以下特性；

　　1、支持.NET 3.5+,Silverlight 4, Windows Phone 7, Mono, MonoTouch, Mono for Android, Compact Framework 3.5等
　　2、通過NuGet方便引入到任何項目 ( Install-Package restsharp )
　　3、可以自動反序列化XML和JSON
　　4、支持自定義的序列化與反序列化
　　5、自動檢測返回的內容類型
　　6、支持HTTP的GET, POST, PUT, HEAD, OPTIONS, DELETE等操作
　　7、可以上傳多文件
　　8、支持oAuth 1, oAuth 2, Basic, NTLM and Parameter-based Authenticators等授權驗證等
　　9、支持異步操作
　　10、極易上手並應用到任何項目中

　　以上是RestSharp的主要特點，通用它你可以很容易地用程序來處理一系列的網絡請求（GET, POST, PUT, HEAD, OPTIONS, DELETE），並得到返回結果

　　GitHub地址--->傳送門，下載源碼，根據不同的平台架構，編譯出對應的dll文件。如圖所示：

    

　　下面是官方的應用示例，使用起來簡單快捷：

var client = new RestClient("http://example.com");
// client.Authenticator = new HttpBasicAuthenticator(username, password);

var request = new RestRequest("resource/{id}", Method.POST);
request.AddParameter("name", "value"); // adds to POST or URL querystring based on Method
request.AddUrlSegment("id", "123"); // replaces matching token in request.Resource

// add parameters for all properties on an object
request.AddObject(object);

// or just whitelisted properties
request.AddObject(object, "PersonId", "Name", ...);

// easily add HTTP Headers
request.AddHeader("header", "value");

// add files to upload (works with compatible verbs)
request.AddFile("file", path);

// execute the request
IRestResponse response = client.Execute(request);
var content = response.Content; // raw content as string

// or automatically deserialize result
// return content type is sniffed but can be explicitly set via RestClient.AddHandler();
IRestResponse<Person> response2 = client.Execute<Person>(request);
var name = response2.Data.Name;

// or download and save file to disk
client.DownloadData(request).SaveAs(path);

// easy async support
await client.ExecuteAsync(request);

// async with deserialization
var asyncHandle = client.ExecuteAsync<Person>(request, response => {
    Console.WriteLine(response.Data.Name);
});

// abort the request on demand
asyncHandle.Abort();

二、RestSharp應用實例

　　我們使用上篇文章的Restful Service的Demo進行簡單測試一下，新建一個控制台項目，引用生成好的RestSharp版本，我的是.net framework 4.5.2 框架，大家根據自身實際情況編譯不通的版本進行引用。主要代碼如下：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
using RestSharp;

namespace RestFulClient
{
    class Program
    {
        static void Main(string[] args)
        {
            Console.Title = "Restful客戶端第三方RestSharpDemo測試";
            //方法二、使用第三方RestSharp
            var client = new RestSharp.RestClient("http://127.0.0.1:7788");
            var requestGet = new RestRequest("PersonInfoQuery/{name}", Method.GET);
            requestGet.AddUrlSegment("name", "王二麻子");
            IRestResponse response = client.Execute(requestGet);
            var contentGet = response.Content;
            Console.WriteLine("GET方式獲取結果：" + contentGet);

            var requestPost = new RestRequest("PersonInfoQuery/Info", Method.POST);
            Info info = new Info();
            info.ID = 1;
            info.Name = "張三";
            var json = JsonConvert.SerializeObject(info);
            requestPost.AddParameter("application/json", json, ParameterType.RequestBody);
            IRestResponse responsePost = client.Execute(requestPost);
            var contentPost = responsePost.Content;
            Console.WriteLine("POST方式獲取結果：" + contentPost);
            Console.Read();
        }
    }

    [Serializable]
    public class Info
    {
        public int ID { get; set; }
        public string Name { get; set; }
    }
}

　　開啟Restful Service服務端，編譯運行，結果如下：

　　至此、RestSharp的簡單應用就介紹這里了，后期將進一步介紹基於RestSharp的完善和二次擴展

---

PS：如有疑問，請留言，未經允許，不得私自轉載，轉載請注明出處：https://www.cnblogs.com/xuliangxing/p/8746277.html