當我們在進行 Web API 呼叫的時候，絕大部分的時候，我們需要把用戶端 (Client) 這裡的一些資料，傳送到後端的 Web API 伺服器上，這樣，所觸發的控制器動作，將會依據我們傳送過的資料，進行處理之後，並且回報給用戶端。

當然，要傳送資料到伺服器上，有著不同的方法，在這裡，我們先來看看，在使用 GET 這類要求的時候，最常用的方式，就是使用查詢字串 Query String 的方法；至於其他傳送資料的使用技術方法，會在其他文章中做說明，在這裡，我們將會說明如何在 GET 要求的時候，使用查詢字串，呼叫遠端 Web API 的指定動作。

了解更多關於 [HttpClient Class] 的使用方式

了解更多關於 [使用 async 和 await 進行非同步程式設計] 的使用方式

使用 GET 要求與 QueryString 呼叫 Web API

在這裡，我們撰寫出底下的非同步方法，GetQueryStringAsync，這個方法的大部分程式碼架構與前面的文章 C# HttpClient WebAPI : 3. GET 要求傳送至指定的 URI 類似，這個方法的原始碼如下所示：

private static async Task<APIResult> GetQueryStringAsync(APIData apiData)
{
    APIResult fooAPIResult;
    using (HttpClientHandler handler = new HttpClientHandler())
    {
        using (HttpClient client = new HttpClient(handler))
        {
            try
            {
                #region 呼叫遠端 Web API
                string FooUrl = $"http://vulcanwebapi.azurewebsites.net/api/values/QueryStringGet";
                HttpResponseMessage response = null;

                #region  設定相關網址內容
                var fooFullUrl = $"{FooUrl}";

                // Accept 用於宣告客戶端要求服務端回應的文件型態 (底下兩種方法皆可任選其一來使用)
                //client.DefaultRequestHeaders.Accept.TryParseAdd("application/json");
                client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));

                // Content-Type 用於宣告遞送給對方的文件型態
                //client.DefaultRequestHeaders.TryAddWithoutValidation("Content-Type", "application/json");

                #region 組合 QueryString
                Dictionary<string, string> dic = new Dictionary<string, string>();
                dic.Add(nameof(apiData.Id), apiData.Id.ToString());
                dic.Add(nameof(apiData.Name), apiData.Name.ToString());
                dic.Add(nameof(apiData.Filename), apiData.Filename.ToString());

                string queryString = "?";

                foreach (string key in dic.Keys)
                {
                    queryString += key + "=" + dic[key] + "&";
                }
                queryString = queryString.Remove(queryString.Length - 1, 1);

                #endregion

                response = await client.GetAsync(fooFullUrl+queryString);
                #endregion
                #endregion

                #region 處理呼叫完成 Web API 之後的回報結果
                if (response != null)
                {
                    if (response.IsSuccessStatusCode == true)
                    {
                        // 取得呼叫完成 API 後的回報內容
                        String strResult = await response.Content.ReadAsStringAsync();
                        fooAPIResult = JsonConvert.DeserializeObject<APIResult>(strResult, new JsonSerializerSettings { MetadataPropertyHandling = MetadataPropertyHandling.Ignore });
                    }
                    else
                    {
                        fooAPIResult = new APIResult
                        {
                            Success = false,
                            Message = string.Format("Error Code:{0}, Error Message:{1}", response.StatusCode, response.RequestMessage),
                            Payload = null,
                        };
                    }
                }
                else
                {
                    fooAPIResult = new APIResult
                    {
                        Success = false,
                        Message = "應用程式呼叫 API 發生異常",
                        Payload = null,
                    };
                }
                #endregion
            }
            catch (Exception ex)
            {
                fooAPIResult = new APIResult
                {
                    Success = false,
                    Message = ex.Message,
                    Payload = ex,
                };
            }
        }
    }

    return fooAPIResult;
}

在這個非同步方法中，我們將會接收到型別 APIData 的參數物件，我們需要將這個物件組合成為查詢字串 (Query String)，並且組合到我們要呼叫的 Web API URL 後；從底下的程式碼中，我們宣告了 Dictionary<string, string> 型別變數，dic，我們使用這樣的程式碼敘述： Dictionary<string, string> dic = new Dictionary<string, string>();，接著我們收到的方法參數物件內的每個屬性，加入到 dic 中。

在這個 Dictionary<string, string> 型別變數中，他的鍵值 (Key)，我們需要指定這個參數屬性的名稱，我們採用強型別的方式寫法，以避免撰寫這類程式碼而造成執行時期的錯誤，所以，我們使用 nameof(apiData.Id) 這樣的寫法，其中，nameof 運算子關鍵字的功用將是：用來取得變數、類型或成員的簡單字串名稱；而在鍵值的相對應的數值，我們就需要設定這個屬性的實際物件內容。

最後，我們使用底下的片段程式碼，就可以把剛剛建立好的 dic 物件，產生出查詢字串來；一旦取得查詢字串之後，就可以把這個字串附加到 URL 之後，這樣，當使用 GET 要求呼叫遠端 Web API 動作的時候，遠端伺服器的控制項動作，就會接收到用戶端傳送過去的內容。

string queryString = "?";

foreach (string key in dic.Keys)
{
    queryString += key + "=" + dic[key] + "&";
}
queryString = queryString.Remove(queryString.Length - 1, 1);

觸發的 Web API 動作

這個範例中，將會指向 URL http://vulcanwebapi.azurewebsites.net/api/values/QueryStringGet ，此時，將會觸發 Web API 伺服器上的 Values 控制器(Controller)的 public APIResult QueryStringGet([FromQuery] APIData value) 動作(Action)，其該動作的原始碼如下所示。

這個 Web API 動作，將會回傳一個 APIData 的 JSON 資料。

[HttpGet("QueryStringGet")]
public APIResult QueryStringGet([FromQuery] APIData value)
{
    APIResult foo;
    if (value.Id == 777)
    {
        foo = new APIResult()
        {
            Success = true,
            Message = "透過 Get 方法，接收到 Id=777",
            Payload = new APIData()
            {
                Id = 777,
                Name = "Vulcan by QueryStringGet"
            }
        };
    }
    else
    {
        foo = new APIResult()
        {
            Success = false,
            Message = "無法發現到指定的 ID",
            Payload = null
        };
    }
    return foo;
}

進行測試

在程式進入點函式，我們建立一個 APIData 型別的物件，接著，設定該物件的相關屬性，這些屬性值，是我們要傳送到遠端伺服器端的資料，由上面的程式碼中，我們可以知道，當 Id 這個屬性值為 777 的時候，該 Web API 動作將會回覆通知，這次的呼叫是成功的，否則，會回覆此次 Web API 呼叫失敗。

static async Task Main(string[] args)
{
    var fooAPIData = new APIData()
    {
        Id = 777,
        Name = "Vulcan",
        Filename = "",
    };
    var foo = await GetQueryStringAsync(fooAPIData);
    Console.WriteLine($"使用 Get 與 QueryString 方法呼叫 Web API 的結果");
    Console.WriteLine($"結果狀態 : {foo.Success}");
    Console.WriteLine($"結果訊息 : {foo.Message}");
    Console.WriteLine($"Payload : {foo.Payload}");
    Console.WriteLine($"");

    Console.WriteLine($"Press any key to Exist...{Environment.NewLine}");
    Console.ReadKey();

    fooAPIData = new APIData()
    {
        Id = 123,
        Name = "Vulcan",
        Filename = "",
    };
    foo = await GetQueryStringAsync(fooAPIData);
    Console.WriteLine($"使用 Get 與 QueryString 方法呼叫 Web API 的結果");
    Console.WriteLine($"結果狀態 : {foo.Success}");
    Console.WriteLine($"結果訊息 : {foo.Message}");
    Console.WriteLine($"Payload : {foo.Payload}");
    Console.WriteLine($"");

    Console.WriteLine($"Press any key to Exist...{Environment.NewLine}");
    Console.ReadKey();
}

執行結果

這個測試將會輸出底下內容

使用 Get 與 QueryString 方法呼叫 Web API 的結果
結果狀態 : True
結果訊息 : 透過 Get 方法，接收到 Id=777
Payload : {
  "id": 777,
  "name": "Vulcan by QueryStringGet",
  "filename": null
}

Press any key to Exist...

使用 Get 與 QueryString 方法呼叫 Web API 的結果
結果狀態 : False
結果訊息 : 無法發現到指定的 ID
Payload :

Press any key to Exist...

HTTP 傳送與接收原始封包

讓我們來看看，這個 Web API 的呼叫動作中，在請求 (Request) 與反應 (Response) 這兩個階段，會在網路上傳送了那些 HTTP 資料

請求 (Request)

在這裡的第一行中，您將會看到了完整有查詢字串 (Query String) 的 URL，在問號之後的內容，將會傳送到後端 Web API 動作函式的參數內，此時的 Id值為 777。

GET http://vulcanwebapi.azurewebsites.net/api/values/QueryStringGet?Id=777&Name=Vulcan&Filename= HTTP/1.1
Accept: application/json
Host: vulcanwebapi.azurewebsites.net
Connection: Keep-Alive

反應 (Response)

HTTP/1.1 200 OK
Transfer-Encoding: chunked
Content-Type: application/json; charset=utf-8
Server: Kestrel
X-Powered-By: ASP.NET
Set-Cookie: ARRAffinity=9d3635139ab6649f453417d1e9047b7ed7a79b7bef031b04afeb6a2c58b33d4e;Path=/;HttpOnly;Domain=vulcanwebapi.azurewebsites.net
Date: Wed, 18 Oct 2017 16:04:41 GMT

88
{"success":true,"message":"透過 Get 方法，接收到 Id=777","payload":{"id":777,"name":"Vulcan by QueryStringGet","filename":null}}
0

請求 (Request)

在這裡的第一行中，您將會看到了完整有查詢字串 (Query String) 的 URL，在問號之後的內容，將會傳送到後端 Web API 動作函式的參數內，此時的 Id值為 123。

GET http://vulcanwebapi.azurewebsites.net/api/values/QueryStringGet?Id=123&Name=Vulcan&Filename= HTTP/1.1
Accept: application/json
Host: vulcanwebapi.azurewebsites.net

反應 (Response)

HTTP/1.1 200 OK
Transfer-Encoding: chunked
Content-Type: application/json; charset=utf-8
Server: Kestrel
X-Powered-By: ASP.NET
Set-Cookie: ARRAffinity=9d3635139ab6649f453417d1e9047b7ed7a79b7bef031b04afeb6a2c58b33d4e;Path=/;HttpOnly;Domain=vulcanwebapi.azurewebsites.net
Date: Wed, 18 Oct 2017 16:04:42 GMT

48
{"success":false,"message":"無法發現到指定的 ID","payload":null}
0

關於 Xamarin 在台灣的學習技術資源

歡迎加入 Xamarin 實驗室粉絲團，在這裡，將會經常性的貼出各種關於 Xamarin / Visual Studio / .NET 的相關消息、文章、技術開發等文件，讓您可以隨時掌握第一手的 Xamarin 方面消息。

歡迎加入 Xamarin.Forms @ Taiwan，這是台灣的 Xamarin User Group，若您有任何關於 Xamarin / Visual Studio / .NET 上的問題，都可以在這裡來與各方高手來進行討論、交流。

Xamarin 實驗室部落格是作者本身的部落格，這個部落格將會專注於 Xamarin 之跨平台 (Android / iOS / UWP) 方面的各類開技術探討、研究與分享的文章，最重要的是，它是全繁體中文。

Xamarin.Forms 系列課程想要快速進入到 Xamarin.Forms 的開發領域，學會各種 Xamarin.Forms 跨平台開發技術，例如：MVVM、Prism、Data Binding、各種頁面 Page / 版面配置 Layout / 控制項 Control 的用法等等，千萬不要錯過這些 Xamarin.Forms 課程

C# .NET Blazor MAUI Xamarin Research

2017年10月18日星期三

C# HttpClient WebAPI : 4. 使用 GET 要求與 QueryString 呼叫 Web API

使用 GET 要求與 QueryString 呼叫 Web API

觸發的 Web API 動作

進行測試

執行結果

HTTP 傳送與接收原始封包

相關文章索引

關於 Xamarin 在台灣的學習技術資源

沒有留言:

張貼留言

2017年10月18日 星期三

C# HttpClient WebAPI : 4. 使用 GET 要求與 QueryString 呼叫 Web API

使用 GET 要求與 QueryString 呼叫 Web API

觸發的 Web API 動作

進行測試

執行結果

HTTP 傳送與接收原始封包

相關文章索引

關於 Xamarin 在台灣的學習技術資源

沒有留言:

張貼留言

2017年10月18日星期三