HttpClient

  • 아티클

중요 API

HttpClient 및 나머지 Windows.Web.Http 네임스페이스 API를 사용하여 HTTP 2.0 및 HTTP 1.1 프로토콜을 통해 정보를 보내고 받습니다.

HttpClient 및 Windows.Web.Http 네임스페이스 개요

Windows.Web.Http 네임스페이스의 클래스와 관련 Windows.Web.Http.Headers 및 Windows.Web.Http.Filters 네임스페이스는 기본 GET 요청을 수행하거나 아래 나열된 고급 HTTP 기능을 구현하기 위해 HTTP 클라이언트 역할을 하는 UWP(유니버설 Windows 플랫폼) 앱용 프로그래밍 인터페이스를 제공합니다.

  • 일반 동사(DELETE, GET, PUT 및 POST)에 대한 메서드입니다. 이러한 각 요청은 비동기 작업으로 전송됩니다.

  • 일반적인 인증 설정 및 패턴을 지원합니다.

  • 전송 시 SSL(Secure Sockets Layer) 세부 정보에 액세스합니다.

  • 고급 앱에 사용자 지정 필터를 포함하는 기능.

  • 쿠키를 가져오고 설정하고 삭제하는 기능.

  • 비동기 메서드에서 사용할 수 있는 HTTP 요청 진행 정보입니다.

Windows.Web.Http.HttpRequestMessage 클래스는 Windows.Web.Http.HttpClient에서 보낸 HTTP 요청 메시지를 나타냅니다. Windows.Web.Http.HttpResponseMessage 클래스는 HTTP 요청에서 받은 HTTP 응답 메시지를 나타냅니다. HTTP 메시지는 IETF의 RFC 2616에 정의되어 있습니다.

Windows.Web.Http 네임스페이스는 HTTP 콘텐츠를 HTTP 엔터티 본문 및 쿠키를 포함한 헤더로 나타냅니다. HTTP 콘텐츠는 HTTP 요청 또는 HTTP 응답과 연결될 수 있습니다. Windows.Web.Http 네임스페이스는 HTTP 콘텐츠를 나타내는 다양한 클래스를 제공합니다.

  • HttpBufferContent. 버퍼로서의 콘텐츠
  • HttpFormUrlEncodedContent. application/x-www-form-urlencoded MIME 형식으로 인코딩된 이름 및 값 튜플로서의 콘텐츠
  • HttpMultipartContent. multipart/* MIME 형식의 콘텐츠.
  • HttpMultipartFormDataContent. multipart/form-data MIME 형식으로 인코딩된 콘텐츠입니다.
  • HttpStreamContent. 스트림으로서의 콘텐츠(내부 형식은 HTTP GET 메서드에서 데이터를 수신하고 HTTP POST 메서드에서 데이터를 업로드하는 데 사용됨)
  • HttpStringContent. 문자열로서의 콘텐츠입니다.
  • IHttpContent - 개발자가 해당 콘텐츠 개체를 만들 수 있는 기본 인터페이스

"HTTP를 통해 간단한 GET 요청 보내기" 섹션의 코드 조각은 HttpStringContent 클래스를 사용하여 HTTP GET 요청의 HTTP 응답을 문자열로 나타냅니다.

Windows.Web.Http.Headers 네임스페이스는 HTTP 헤더 및 쿠키 만들기를 지원하며, 이는 HttpRequestMessage 및 HttpResponseMessage 개체와 속성으로 연결됩니다.

HTTP를 통해 간단한 GET 요청 보내기

이 문서의 앞부분에서 언급했듯이 Windows.Web.Http 네임스페이스를 사용하면 UWP 앱이 GET 요청을 보낼 수 있습니다. 다음 코드 조각은 Windows.Web.Http.HttpClient 클래스 및 Windows.Web.Http.HttpResponseMessage 클래스를 사용하여 GET 요청에서 응답을 읽을 수 있도록 http://www.contoso.com으로 GET 요청을 전송하는 방법을 보여 줍니다.

//Create an HTTP client object
Windows.Web.Http.HttpClient httpClient = new Windows.Web.Http.HttpClient();

//Add a user-agent header to the GET request. 
var headers = httpClient.DefaultRequestHeaders;

//The safe way to add a header value is to use the TryParseAdd method and verify the return value is true,
//especially if the header value is coming from user input.
string header = "ie";
if (!headers.UserAgent.TryParseAdd(header))
{
    throw new Exception("Invalid header value: " + header);
}

header = "Mozilla/5.0 (compatible; MSIE 10.0; Windows NT 6.2; WOW64; Trident/6.0)";
if (!headers.UserAgent.TryParseAdd(header))
{
    throw new Exception("Invalid header value: " + header);
}

Uri requestUri = new Uri("http://www.contoso.com");

//Send the GET request asynchronously and retrieve the response as a string.
Windows.Web.Http.HttpResponseMessage httpResponse = new Windows.Web.Http.HttpResponseMessage();
string httpResponseBody = "";

try
{
    //Send the GET request
    httpResponse = await httpClient.GetAsync(requestUri);
    httpResponse.EnsureSuccessStatusCode();
    httpResponseBody = await httpResponse.Content.ReadAsStringAsync();
}
catch (Exception ex)
{
    httpResponseBody = "Error: " + ex.HResult.ToString("X") + " Message: " + ex.Message;
}

// pch.h
#pragma once
#include <winrt/Windows.Foundation.h>
#include <winrt/Windows.Web.Http.Headers.h>

// main.cpp : Defines the entry point for the console application.
#include "pch.h"
#include <iostream>
using namespace winrt;
using namespace Windows::Foundation;

int main()
{
    init_apartment();

    // Create an HttpClient object.
    Windows::Web::Http::HttpClient httpClient;

    // Add a user-agent header to the GET request.
    auto headers{ httpClient.DefaultRequestHeaders() };

    // The safe way to add a header value is to use the TryParseAdd method, and verify the return value is true.
    // This is especially important if the header value is coming from user input.
    std::wstring header{ L"ie" };
    if (!headers.UserAgent().TryParseAdd(header))
    {
        throw L"Invalid header value: " + header;
    }

    header = L"Mozilla/5.0 (compatible; MSIE 10.0; Windows NT 6.2; WOW64; Trident/6.0)";
    if (!headers.UserAgent().TryParseAdd(header))
    {
        throw L"Invalid header value: " + header;
    }

    Uri requestUri{ L"http://www.contoso.com" };

    // Send the GET request asynchronously, and retrieve the response as a string.
    Windows::Web::Http::HttpResponseMessage httpResponseMessage;
    std::wstring httpResponseBody;

    try
    {
        // Send the GET request.
        httpResponseMessage = httpClient.GetAsync(requestUri).get();
        httpResponseMessage.EnsureSuccessStatusCode();
        httpResponseBody = httpResponseMessage.Content().ReadAsStringAsync().get();
    }
    catch (winrt::hresult_error const& ex)
    {
        httpResponseBody = ex.message();
    }
    std::wcout << httpResponseBody;
}

HTTP를 통해 이진 데이터 게시

아래의 C++/WinRT 코드 예제에서는 양식 데이터 및 POST 요청을 사용하여 웹 서버에 적은 양의 이진 데이터 파일을 업로드하는 방법을 보여 줍니다. 이 코드는 HttpBufferContent 클래스를 사용하여 이진 데이터를 나타내고 HttpMultipartFormDataContent 클래스를 사용하여 다중 파트 양식 데이터를 나타냅니다.

참고 항목

get 호출(아래 코드 예제에 표시)은 UI 스레드에는 적절하지 없습니다. 이 경우에 사용할 수 있는 올바른 방법에 대해서는 C++/WinRT로 동시성 및 비동기 작업을 참조하세요.

// pch.h
#pragma once
#include <winrt/Windows.Foundation.h>
#include <winrt/Windows.Security.Cryptography.h>
#include <winrt/Windows.Storage.Streams.h>
#include <winrt/Windows.Web.Http.Headers.h>

// main.cpp : Defines the entry point for the console application.
#include "pch.h"
#include <iostream>
#include <sstream>
using namespace winrt;
using namespace Windows::Foundation;
using namespace Windows::Storage::Streams;

int main()
{
    init_apartment();

    auto buffer{
        Windows::Security::Cryptography::CryptographicBuffer::ConvertStringToBinary(
            L"A sentence of text to encode into binary to serve as sample data.",
            Windows::Security::Cryptography::BinaryStringEncoding::Utf8
        )
    };
    Windows::Web::Http::HttpBufferContent binaryContent{ buffer };
    // You can use the 'image/jpeg' content type to represent any binary data;
    // it's not necessarily an image file.
    binaryContent.Headers().Append(L"Content-Type", L"image/jpeg");

    Windows::Web::Http::Headers::HttpContentDispositionHeaderValue disposition{ L"form-data" };
    binaryContent.Headers().ContentDisposition(disposition);
    // The 'name' directive contains the name of the form field representing the data.
    disposition.Name(L"fileForUpload");
    // Here, the 'filename' directive is used to indicate to the server a file name
    // to use to save the uploaded data.
    disposition.FileName(L"file.dat");

    Windows::Web::Http::HttpMultipartFormDataContent postContent;
    postContent.Add(binaryContent); // Add the binary data content as a part of the form data content.

    // Send the POST request asynchronously, and retrieve the response as a string.
    Windows::Web::Http::HttpResponseMessage httpResponseMessage;
    std::wstring httpResponseBody;

    try
    {
        // Send the POST request.
        Uri requestUri{ L"https://www.contoso.com/post" };
        Windows::Web::Http::HttpClient httpClient;
        httpResponseMessage = httpClient.PostAsync(requestUri, postContent).get();
        httpResponseMessage.EnsureSuccessStatusCode();
        httpResponseBody = httpResponseMessage.Content().ReadAsStringAsync().get();
    }
    catch (winrt::hresult_error const& ex)
    {
        httpResponseBody = ex.message();
    }
    std::wcout << httpResponseBody;
}

실제 이진 파일의 내용(위에서 사용된 명시적 이진 데이터 대신)을 게시하려면의 HttpStreamContent 개체를 사용하는 것이 더 쉬울 것입니다. 하나를 생성하고, StorageFile.OpenReadAsync 호출에서 반환된 값을 해당 생성자의 인수로 전달합니다. 해당 메서드는 이진 파일 내에 있는 데이터의 스트림을 반환합니다.

또한 대형(약 10MB보다 큰) 파일을 업로드하는 경우 Windows 런타임 백그라운드 전송 API를 사용하는 것이 좋습니다.

HTTP를 통해 JSON 데이터 게시

다음 예제에서는 엔드포인트에 JSON을 게시한 다음, 응답 본문을 작성합니다.

using System;
using System.Diagnostics;
using System.Threading.Tasks;
using Windows.Storage.Streams;
using Windows.Web.Http;

private async Task TryPostJsonAsync()
{
    try
    {
        // Construct the HttpClient and Uri. This endpoint is for test purposes only.
        HttpClient httpClient = new HttpClient();
        Uri uri = new Uri("https://www.contoso.com/post");

        // Construct the JSON to post.
        HttpStringContent content = new HttpStringContent(
            "{ \"firstName\": \"Eliot\" }",
            UnicodeEncoding.Utf8,
            "application/json");

        // Post the JSON and wait for a response.
        HttpResponseMessage httpResponseMessage = await httpClient.PostAsync(
            uri,
            content);

        // Make sure the post succeeded, and write out the response.
        httpResponseMessage.EnsureSuccessStatusCode();
        var httpResponseBody = await httpResponseMessage.Content.ReadAsStringAsync();
        Debug.WriteLine(httpResponseBody);
    }
    catch (Exception ex)
    {
        // Write out any exceptions.
        Debug.WriteLine(ex);
    }
}

// pch.h
#pragma once
#include <winrt/Windows.Foundation.h>
#include <winrt/Windows.Security.Cryptography.h>
#include <winrt/Windows.Storage.Streams.h>
#include <winrt/Windows.Web.Http.Headers.h>

// main.cpp : Defines the entry point for the console application.
#include "pch.h"
#include <iostream>
#include <sstream>
using namespace winrt;
using namespace Windows::Foundation;
using namespace Windows::Storage::Streams;

int main()
{
    init_apartment();

    Windows::Web::Http::HttpResponseMessage httpResponseMessage;
    std::wstring httpResponseBody;

    try
    {
        // Construct the HttpClient and Uri. This endpoint is for test purposes only.
        Windows::Web::Http::HttpClient httpClient;
        Uri requestUri{ L"https://www.contoso.com/post" };

        // Construct the JSON to post.
        Windows::Web::Http::HttpStringContent jsonContent(
            L"{ \"firstName\": \"Eliot\" }",
            UnicodeEncoding::Utf8,
            L"application/json");

        // Post the JSON, and wait for a response.
        httpResponseMessage = httpClient.PostAsync(
            requestUri,
            jsonContent).get();

        // Make sure the post succeeded, and write out the response.
        httpResponseMessage.EnsureSuccessStatusCode();
        httpResponseBody = httpResponseMessage.Content().ReadAsStringAsync().get();
        std::wcout << httpResponseBody.c_str();
    }
    catch (winrt::hresult_error const& ex)
    {
        std::wcout << ex.message().c_str();
    }
}

Windows.Web.Http의 예외

URI(Uniform Resource Identifier)에 대한 잘못된 문자열이 Windows.Foundation.Uri 객체 생성자로 전달되면 예외가 발생합니다.

.NET: Windows.Foundation.Uri 형식은 C# 및 VB에서 System.Uri로 표시됩니다.

C# 및 Visual Basic에서는 .NET 4.5의 System.Uri 클래스와 System.Uri.TryCreate 메서드 중 하나를 통해 URI가 생성되기 전에 사용자로부터 받은 문자열을 테스트하여 이 오류를 방지할 수 있습니다.

C++에는 문자열을 URI로 구문 분석하는 방법이 없습니다. 앱이 Windows.Foundation.Uri에 대해 사용자 입력을 가져오면 생성자는 try/catch 블록에 있게 됩니다. 예외가 발생하면 앱은 사용자에게 알리고 새 호스트 이름을 요청할 수 있습니다.

Windows.Web.Http에는 편의 기능이 부족합니다. 따라서 이 네임스페이스에서 HttpClient 및 다른 클래스를 사용하는 앱은 HRESULT 값을 사용해야 합니다.

C++/WinRT를 사용하는 앱에서 winrt::hresult_error 구조체는 앱을 실행하는 동안 발생한 예외를 나타냅니다. winrt::hresult_error::code 함수는 특정 예외에 할당된 HRESULT를 반환합니다. winrt::hresult_error::message 함수는 HRESULT 값과 연결된 시스템 제공 문자열을 반환합니다. 자세한 내용은 C++/WinRT를 통한 오류 처리를 참조하세요.

가능한 HRESULT 값은 Winerror.h 헤더 파일에 나열되어 있습니다. 앱은 특정 HRESULT 값을 필터링하여 예외의 원인에 따라 앱 동작을 수정할 수 있습니다.

C#, VB.NET에서 .NET Framework 4.5를 사용하는 앱에서 System.Exception은 앱 실행 중 예외가 발생하는 경우의 오류를 나타냅니다. System.Exception.HResult 속성은 특정 예외에 할당된 HRESULT를 반환합니다. System.Exception.Message 속성은 예외를 설명하는 메시지를 반환합니다.

C++/CX는 C++/WinRT로 대체되었습니다. 하지만 C++/CX를 사용하는 앱에서 Platform::Exception은 앱 실행 중 예외가 발생하는 경우의 오류를 나타냅니다. Platform::Exception::HResult 속성은 특정 예외에 할당된 HRESULT를 반환합니다. Platform::Exception::Message 속성은 HRESULT 값과 연결된 시스템 제공 문자열을 반환합니다.

대부분의 매개 변수 유효성 검사 오류에서 반환되는 HRESULT는 E_INVALIDARG입니다. 일부 잘못된 메서드 호출의 경우 반환되는 HRESULT는 E_ILLEGAL_METHOD_CALL입니다.