如何使用程序調(diào)用webApi接口

在C#中,傳統(tǒng)調(diào)用HTTP接口一般有兩種辦法:

  • WebRequest/WebResponse組合的方法調(diào)用
  • WebClient類進行調(diào)用。

第一種方法抽象程度較低尉咕,使用較為繁瑣坡慌;而WebClient主要面向了WEB網(wǎng)頁場景熬拒,在模擬Web操作時使用較為方便,但用在RestFul場景下卻比較麻煩,在Web API發(fā)布的同時,.NET提供了兩個程序集:System.Net.HttpSystem.Net.Http.Formatting咒钟。這兩個程序集中最核心的類是HttpClient。在.NET4.5中帶有這兩個程序集若未,而.NET4需要到Nuget里下載Microsoft.Net.Http和Microsoft.AspNet.WebApi.Client這兩個包才能使用這個類朱嘴,更低的.NET版本就只能表示遺憾了只能用WebRequest/WebResponse或者WebClient來調(diào)用這些API了。

在使用中粗合,System.Net.Http這個程序集提供了HttpClient類以及相關(guān)的HTTP調(diào)用腕够,而System.Net.Http.Formatting提供了一些針對HttpClient的幫助擴展,更好地支持了內(nèi)容協(xié)商舌劳、Content創(chuàng)建等功能。下面我就和大家一起寫一下這個例子:

public class Person

    {

        public long Id { get; set; }

        public string Name { get; set; }

 

        public int Age { get; set; }

 

        public string Sex { get; set; }

 

        public override string ToString()

        {

            return $"Id={Id} Name={Name} Age={Age} Sex={Sex}";

        }

    }


   class Program

   {

       static void Main(string[] args)

       {

           var client = new HttpClient();
           //基本的API URL
           client.BaseAddress = new Uri("http://localhost:22658/");
           //默認希望響應使用Json序列化(內(nèi)容協(xié)商機制玫荣,我接受json格式的數(shù)據(jù))
           client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json")); 
           //運行client接收程序
           Run(client);
           Console.ReadLine();
       }
       //client接收處理(都是異步的處理)
       static async void Run(HttpClient client)
       {
           //post 請求插入數(shù)據(jù)
           var result = await AddPerson(client);
           Console.WriteLine($"添加結(jié)果:{result}"); //添加結(jié)果:true
           
           //get 獲取數(shù)據(jù)
           var person = await GetPerson(client);
           //查詢結(jié)果:Id=1 Name=test Age=10 Sex=F
           Console.WriteLine($"查詢結(jié)果:{person}"); 

           //put 更新數(shù)據(jù)
           result = await PutPerson(client);
           //更新結(jié)果:true
           Console.WriteLine($"更新結(jié)果:{result}"); 

           //delete 刪除數(shù)據(jù)
           result = await DeletePerson(client);
           //刪除結(jié)果:true
           Console.WriteLine($"刪除結(jié)果:{result}"); 
       }
       
       //post
       static async Task<bool> AddPerson(HttpClient client)
       {
           //向Person發(fā)送POST請求甚淡,Body使用Json進行序列化
           return await client.PostAsJsonAsync("api/Person", new Person() { Age = 10, Id = 1, Name = "test", Sex = "F" }) 
                               //返回請求是否執(zhí)行成功,即HTTP Code是否為2XX
                               .ContinueWith(x => x.Result.IsSuccessStatusCode);  
       }
       
       //get
       static async Task<Person> GetPerson(HttpClient client)
       {
           //向Person發(fā)送GET請求
           return await await client.GetAsync("api/Person/1") 
           //獲取返回Body捅厂,并根據(jù)返回的Content-Type自動匹配格式化器反序列化Body內(nèi)容為對象
                                    .ContinueWith(x => x.Result.Content.ReadAsAsync<Person>(                             
                   new List<MediaTypeFormatter>() {new JsonMediaTypeFormatter()/*這是Json的格式化器*/
                                                   ,new XmlMediaTypeFormatter()/*這是XML的格式化器*/}));
       }
       
       //put
       static async Task<bool> PutPerson(HttpClient client)
       {
           //向Person發(fā)送PUT請求贯卦,Body使用Json進行序列化
           return await client.PutAsJsonAsync("api/Person/1", new Person() { Age = 10, Id = 1, Name = "test1Change", Sex = "F" }) 
                               .ContinueWith(x => x.Result.IsSuccessStatusCode);  //返回請求是否執(zhí)行成功,即HTTP Code是否為2XX
       }
       //delete
       static async Task<bool> DeletePerson(HttpClient client)
       {
           return await client.DeleteAsync("api/Person/1") //向Person發(fā)送DELETE請求
                              .ContinueWith(x => x.Result.IsSuccessStatusCode); //返回請求是否執(zhí)行成功焙贷,即HTTP Code是否為2XX
       }

}

這就完成了這組API的調(diào)用撵割,是不是非常簡單方便?HTTPClient使用全異步的方法辙芍,并且他有良好的擴展性啡彬,我會在之后的博客中再聊這個問題羹与。

OK,到此為止一組簡單的Restful API和C#的調(diào)用客戶端就完成了庶灿,但這只是開始纵搁,Web API是一個很強大的框架,他的擴展點非常豐富往踢,這些擴展能為我們的開發(fā)提供很多的幫助腾誉,下一篇博文我將為大家?guī)鞼EB API中Filter的使用。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末峻呕,一起剝皮案震驚了整個濱河市利职,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌瘦癌,老刑警劉巖猪贪,帶你破解...
    沈念sama閱讀 218,122評論 6 505
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異佩憾,居然都是意外死亡哮伟,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,070評論 3 395
  • 文/潘曉璐 我一進店門妄帘,熙熙樓的掌柜王于貴愁眉苦臉地迎上來楞黄,“玉大人,你說我怎么就攤上這事抡驼」砝” “怎么了?”我有些...
    開封第一講書人閱讀 164,491評論 0 354
  • 文/不壞的土叔 我叫張陵致盟,是天一觀的道長碎税。 經(jīng)常有香客問我,道長馏锡,這世上最難降的妖魔是什么雷蹂? 我笑而不...
    開封第一講書人閱讀 58,636評論 1 293
  • 正文 為了忘掉前任,我火速辦了婚禮杯道,結(jié)果婚禮上匪煌,老公的妹妹穿的比我還像新娘。我一直安慰自己党巾,他們只是感情好萎庭,可當我...
    茶點故事閱讀 67,676評論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著齿拂,像睡著了一般驳规。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上署海,一...
    開封第一講書人閱讀 51,541評論 1 305
  • 那天吗购,我揣著相機與錄音医男,去河邊找鬼。 笑死巩搏,一個胖子當著我的面吹牛昨登,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播贯底,決...
    沈念sama閱讀 40,292評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼丰辣,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了禽捆?” 一聲冷哼從身側(cè)響起笙什,我...
    開封第一講書人閱讀 39,211評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎胚想,沒想到半個月后琐凭,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,655評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡浊服,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,846評論 3 336
  • 正文 我和宋清朗相戀三年统屈,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片牙躺。...
    茶點故事閱讀 39,965評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡愁憔,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出孽拷,到底是詐尸還是另有隱情吨掌,我是刑警寧澤,帶...
    沈念sama閱讀 35,684評論 5 347
  • 正文 年R本政府宣布脓恕,位于F島的核電站膜宋,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏炼幔。R本人自食惡果不足惜秋茫,卻給世界環(huán)境...
    茶點故事閱讀 41,295評論 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望乃秀。 院中可真熱鬧肛著,春花似錦、人聲如沸环形。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,894評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽抬吟。三九已至,卻和暖如春统抬,著一層夾襖步出監(jiān)牢的瞬間火本,已是汗流浹背危队。 一陣腳步聲響...
    開封第一講書人閱讀 33,012評論 1 269
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留钙畔,地道東北人茫陆。 一個月前我還...
    沈念sama閱讀 48,126評論 3 370
  • 正文 我出身青樓,卻偏偏與公主長得像擎析,于是被迫代替她去往敵國和親簿盅。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 44,914評論 2 355

推薦閱讀更多精彩內(nèi)容

  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理揍魂,服務發(fā)現(xiàn)桨醋,斷路器,智...
    卡卡羅2017閱讀 134,657評論 18 139
  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,133評論 25 707
  • Awesome DotNet现斋,這又是一個 Awesome XXX 系列的資源整理喜最,由 quozd 發(fā)起和維護。內(nèi)容...
    小明yz閱讀 3,695評論 0 47
  • 好懷念以前自己寫文章時的樣子 現(xiàn)在有時想寫卻不知道該寫些什么了 以前總感覺一寫起文章來就渾身是勁 感覺未來一切都...
    筱栗芝閱讀 280評論 0 2
  • 與真心相愛的女人走到結(jié)婚這一步虫蝶,這本身就是一種千年才修得的緣分。一千年一個輪回蔗包,相遇此生還需磨礪百年秉扑! 在這一刻,...
    我愛微播閱讀 530評論 0 0