HttpClient.GetStringAsync 方法

定義

命名空間:

System.Net.Http

組件:

System.Net.Http.dll

向指定的 URI 發送 GET 請求，並以非同步操作的方式回傳回應實體的字串。

多載

名稱	Description
GetStringAsync(String)	向指定的 URI 發送 GET 請求，並以非同步操作的方式回傳回應實體的字串。
GetStringAsync(Uri)	向指定的 URI 發送 GET 請求，並以非同步操作的方式回傳回應實體的字串。

備註

這個操作不會阻擋。

GetStringAsync(String)

向指定的 URI 發送 GET 請求，並以非同步操作的方式回傳回應實體的字串。

public:
 System::Threading::Tasks::Task<System::String ^> ^ GetStringAsync(System::String ^ requestUri);

public System.Threading.Tasks.Task<string> GetStringAsync(string requestUri);

member this.GetStringAsync : string -> System.Threading.Tasks.Task<string>

Public Function GetStringAsync (requestUri As String) As Task(Of String)

參數

requestUri

String

請求被送達的 URI。

傳回

Task<String>

表示異步操作的工作物件。

例外狀況

InvalidOperationException

這 requestUri 不是絕對的 URI，也 BaseAddress 沒有設定好。

HttpRequestException

請求失敗是因為無法取得有效的 HTTP 回應，例如網路連線失敗、DNS 故障、伺服器憑證驗證錯誤或伺服器回應無效。 在 .NET 8 及以後版本中，原因以 HttpRequestError 表示

-或-

回應狀態碼超出200-299（標準中代表成功）範圍。

-或-

僅限 .NET 框架：請求已逾時。

OperationCanceledException

僅 .NET Core 及 .NET 5 及以後版本：因逾時而請求失敗。

UriFormatException

所提供的請求 URI 既非有效的相對 URI，也非絕對 URI。

備註

這個操作不會阻擋。 回傳 Task<TResult> 物件會在讀取整個回應體後完成。 內部操作 HttpResponseMessage.EnsureSuccessStatusCode 用來確保回應狀態碼在成功範圍內（200-299），若未達成功則拋出 a HttpRequestException 。 在某些情況下，您可能需要更多控制哪些狀態碼被視為成功;例如，一個 API 可能被期望總是回傳 200 OK。 在這種情況下，我們建議手動檢查是否 StatusCode 符合預期值。

Note

若有暫停：

• .NET Framework 會拋出 HttpRequestException。
• .NET 核心會拋出 OperationCanceledException，且沒有內部例外。
• .NET 5 及以後版本會丟出一個 OperationCanceledException，該 巢狀為 TimeoutException。

GetStringAsync(Uri)

向指定的 URI 發送 GET 請求，並以非同步操作的方式回傳回應實體的字串。

public:
 System::Threading::Tasks::Task<System::String ^> ^ GetStringAsync(Uri ^ requestUri);

public System.Threading.Tasks.Task<string> GetStringAsync(Uri requestUri);

member this.GetStringAsync : Uri -> System.Threading.Tasks.Task<string>

Public Function GetStringAsync (requestUri As Uri) As Task(Of String)

參數

requestUri

Uri

請求被送達的 URI。

傳回

Task<String>

表示異步操作的工作物件。

例外狀況

InvalidOperationException

這 requestUri 不是絕對的 URI，也 BaseAddress 沒有設定好。

HttpRequestException

請求失敗是因為無法取得有效的 HTTP 回應，例如網路連線失敗、DNS 故障、伺服器憑證驗證錯誤或伺服器回應無效。 在 .NET 8 及以後版本中，原因以 HttpRequestError 表示

-或-

回應狀態碼超出200-299（標準中代表成功）範圍。

-或-

僅限 .NET 框架：請求已逾時。

OperationCanceledException

僅 .NET Core 及 .NET 5 及以後版本：因逾時而請求失敗。

備註

這個操作不會阻擋。 回傳 Task<TResult> 物件會在讀取整個回應體後完成。 內部操作 HttpResponseMessage.EnsureSuccessStatusCode 用來確保回應狀態碼在成功範圍內（200-299），若未達成功則拋出 a HttpRequestException 。 在某些情況下，您可能需要更多控制哪些狀態碼被視為成功;例如，一個 API 可能被期望總是回傳 200 OK。 在這種情況下，我們建議手動檢查是否 StatusCode 符合預期值。

Note

若有暫停：

• .NET Framework 會拋出 HttpRequestException。
• .NET 核心會拋出 OperationCanceledException，且沒有內部例外。
• .NET 5 及以後版本會丟出一個 OperationCanceledException，該 巢狀為 TimeoutException。