HTTP通信のリクエスト送信とレスポンス確認（WinHTTP API使用）（非同期通信）

解説

HTTP通信を実装する方法としては、WindowsソケットAPI を利用する方法、WinINet API を利用する方法、WinHTTP API を利用する方法、MFC を利用する方法、などがあります。

ここでは、WinHTTP API を利用した、HTTP通信のリクエスト送信とレスポンス確認、の方法をまとめます。

WinINet API および WinHTTP API を利用する方法は、WindowsソケットAPI を利用する方法に比べて、SSL通信（https://～に対する通信）の処理を楽に実装できるという利点があります。
WinINet API および WinHTTP API を利用する方法は、MFC を利用する方法に比べて、MFC を利用できない、利用したくない場合でも実装できるという利点があります。

WinHTTP API を利用する方法は、WinINet API を利用する方法に比べて、非同期通信（同期通信ではデータ通信のリクエストを出してからレスポンスが来るまでほかの処理を行わずにレスポンスを待ち続けます。非同期通信ではレスポンスを待っている間にほかの処理を行います。）の処理を楽に実装できるという利点があります。

ここでは、非同期通信の処理の実装方法をまとめます。

準備

・Winhttp.h のインクルード

#include <Winhttp.h>
をファイルヘッダー部等に追加します。
これにより、WinHTTP APIが使えるようになります。

・Winhttp.lib のリンク

#pragma comment( lib, "Winhttp.lib" )
をファイルヘッダー部に記述することにより、Winhttp.lib をリンクするファイルへ追加します。
これにより、WinHTTP APIがリンクされるようになります。
（リンクするファイルの追加の方法には、#pragma comment( lib, libファイル名 ) をソースに記述する方法の他にも、プロジェクトのプロパティ「構成プロパティ > リンカ > 入力 > 追加の依存ファイル」に libファイル名 を追記する方法、などもあります。）

手続き

１．セッションオブジェクトの作成

WinHttpOpen 関数を利用し、セッションオブジェクトを作成します。
ユーザーエージェント名、プロキシ設定、プロキシ名、プロキシバイパス名、を引数として指定します。
WinHttpGetIEProxyConfigForCurrentUser 関数を利用すると、Internet Explorer のプロキシ設定を取得することができます。

２．URLの解析

WinHttpCrackUrl 関数を利用し、URLを解析し、HTTP通信かHTTPS通信か、通信先ホスト名、通信先URLパス、通信先ポート番号を求めます。

３．HTTP接続

WinHttpConnect 関数を利用し、HTTP接続を行います。
通信先ホスト名、通信先ポート番号、を引数として指定します。

４．HTTP接続を開く

WinHttpOpenRequest 関数を利用し、HTTP接続を開きます。
通信先URLパスを指定します。GETメソッドによる通信の場合には、通信先URLパスの末尾にリクエストパラメータを「&」で連結したものを指定します。
Verb引数は、GETメソッドの場合は、"GET"を、POSTメソッドの場合は、"POST"を指定します。
Flags引数は、HTTPの場合には ゼロ を、HTTPSの場合には WINHTTP_FLAG_SECURE を、指定します。

５．コールバック関数の設定

WinHttpSetStatusCallback 関数を利用し、コールバック関数を設定します。
fnInternetCallback 引数に、コールバック関数を指定します。
NotificationFlag 引数に、通知を受け取りたいステータスを指定します。

６．リクエストの送信

WinHttpSendRequest 関数を利用し、HTTPリクエストを送信します。
リクエストヘッダー、リクエストパラメータを指定します。

７．コールバック関数でステータス毎の処理

コールバック関数で、ステータス毎の処理をします。
・WINHTTP_CALLBACK_STATUS_SENDREQUEST_COMPLETE
　WinHttpReceiveResponse 関数を利用し、レスポンスの到着を待機します。
・WINHTTP_CALLBACK_STATUS_HEADERS_AVAILABLE
　WinHttpQueryHeaders 関数を利用し、ステータスコードを取得します。
　WinHttpQueryDataAvailable 関数を利用し、最初のレスポンスデータの問い合わせを行います。
・WINHTTP_CALLBACK_STATUS_DATA_AVAILABLE
　WinHttpReadData 関数を利用し、レスポンスデータを読み込みを開始します。
・WINHTTP_CALLBACK_STATUS_READ_COMPLETE
　読み込んだレスポンスデータをバッファ等にコピーします。
　WinHttpQueryDataAvailable 関数を利用し、次のレスポンスデータの問い合わせを行います。

サンプルコード

セッションオブジェクトの作成部
（・・・省略・・・） // セッションオブジェクトの作成 WINHTTP_CURRENT_USER_IE_PROXY_CONFIG ieProxyConfig; ZeroMemory( &ieProxyConfig, sizeof(WINHTTP_CURRENT_USER_IE_PROXY_CONFIG) ); WinHttpGetIEProxyConfigForCurrentUser( &ieProxyConfig ); if( ieProxyConfig.lpszProxy ) { // InternetExplorerのプロキシ設定でセッションオブジェクト作成 s_hSession = WinHttpOpen( L"WinHttpAsyncTest", // UserAgent名 WINHTTP_ACCESS_TYPE_NAMED_PROXY, // プロキシ設定 ieProxyConfig.lpszProxy, // プロキシ名 ieProxyConfig.lpszProxyBypass ? ieProxyConfig.lpszProxyBypass : WINHTTP_NO_PROXY_BYPASS, // プロキシバイパス WINHTTP_FLAG_ASYNC); // 振る舞いオプション。現状WINHTTP_FLAG_ASYNCのみ指定可能。 } else { s_hSession = WinHttpOpen( L"WinHttpAsyncTest", // UserAgent名 WINHTTP_ACCESS_TYPE_DEFAULT_PROXY, // プロキシ設定 WINHTTP_NO_PROXY_NAME, // プロキシ名 WINHTTP_NO_PROXY_BYPASS, // プロキシバイパス WINHTTP_FLAG_ASYNC); // 振る舞いオプション。現状WINHTTP_FLAG_ASYNCのみ指定可能。 } （・・・省略・・・）

URLの解析からリクエスト送信まで
（・・・省略・・・） void CHttpAsyncRequest::SendRequest( HINTERNET hSession, const tstring& tstrUrl, const tstring& tstrParameter, BOOL bIsHttpVerbPost ) { // 接続中は処理しない if( IsConnected() ) { return; } // インプットチェック if( NULL == hSession || 0 == tstrUrl.length() ) { RequestFailed( _T("URLが不正") ); return; } // 変数 wstring wstrServer; INTERNET_PORT nPort = 0; wstring wstrVerb; wstring wstrObjectName; tstring wstrHeaders; std::string strOptional; // URL解析 URL_COMPONENTS urlcomponents; ZeroMemory( &urlcomponents, sizeof(URL_COMPONENTS) ); urlcomponents.dwStructSize = sizeof(URL_COMPONENTS); WCHAR wszHostName[URLBUFFER_SIZE]; WCHAR wszUrlPath[URLBUFFER_SIZE]; urlcomponents.lpszHostName = wszHostName; urlcomponents.lpszUrlPath = wszUrlPath; urlcomponents.dwHostNameLength = URLBUFFER_SIZE; urlcomponents.dwUrlPathLength = URLBUFFER_SIZE; if( !WinHttpCrackUrl( tstrUrl.c_str(), 0, 0, &urlcomponents ) ) { // URLの解析に失敗 RequestFailed( _T("URL解析に失敗") ); return; } wstrServer = urlcomponents.lpszHostName; wstrObjectName = urlcomponents.lpszUrlPath; nPort = urlcomponents.nPort; // HTTPかHTTPSかそれ以外か DWORD dwOpenRequestFlag = (INTERNET_SCHEME_HTTPS == urlcomponents.nScheme) ? WINHTTP_FLAG_SECURE : 0; // POSTかGETか if( bIsHttpVerbPost ) { // POST wstrVerb = L"POST"; wstrHeaders = L"Content-Type: application/x-www-form-urlencoded"; if( 0 != tstrParameter.length() ) { // パラメータを、送信するオプションデータに変換する char* pszOptional = NhT2M( tstrParameter.c_str() ); // char文字列に変換 strOptional = pszOptional; free( pszOptional ); } } else { // GET wstrVerb = L"GET"; wstrHeaders = L""; if( 0 != tstrParameter.length() ) { // オブジェクトとパラメータを「?」で連結 WCHAR* pwszBuffer = NhT2W( tstrParameter.c_str() ); wstrObjectName += L"?" + wstring(pwszBuffer); free( pwszBuffer ); } } // HTTP接続 m_hConnect = WinHttpConnect( hSession, wstrServer.c_str(), nPort, 0 ); if( NULL == m_hConnect ) { RequestFailed( _T("HTTP接続に失敗") ); return; } // HTTP接続を開く m_hRequest = WinHttpOpenRequest( m_hConnect, wstrVerb.c_str(), wstrObjectName.c_str(), NULL, WINHTTP_NO_REFERER, WINHTTP_DEFAULT_ACCEPT_TYPES, dwOpenRequestFlag ); if( NULL == m_hRequest ) { RequestFailed( _T("HTTP接続を開くに失敗") ); return; } // コールバック関数の設定 if( WINHTTP_INVALID_STATUS_CALLBACK == WinHttpSetStatusCallback( m_hRequest, (WINHTTP_STATUS_CALLBACK)InternetCallback, WINHTTP_CALLBACK_FLAG_ALL_COMPLETIONS | WINHTTP_CALLBACK_FLAG_REDIRECT, NULL) ) { RequestFailed( _T("コールバックの設定に失敗") ); return; } // リクエストの送信 if( !WinHttpSendRequest( m_hRequest, wstrHeaders.c_str(), wstrHeaders.length(), (LPVOID)strOptional.c_str(), strOptional.length() * sizeof(char), strOptional.length() * sizeof(char), (DWORD_PTR)this) ) { RequestFailed( _T("リクエストの送信に失敗") ); return; } } （・・・省略・・・）

コールバック関数でステータス毎の処理
（・・・省略・・・） void CALLBACK CHttpAsyncRequest::InternetCallback( HINTERNET hInternet, DWORD_PTR dwContext, DWORD dwInternetStatus, LPVOID lpvStatusInformation, DWORD dwStatusInformationLength ) { assert( dwContext ); if( 0 == dwContext ) { return; } CHttpAsyncRequest* pHttpRequest = reinterpret_cast<CHttpAsyncRequest*>( dwContext ); pHttpRequest->OnCallback( dwInternetStatus, lpvStatusInformation, dwStatusInformationLength ); } void CHttpAsyncRequest::OnCallback( DWORD dwInternetStatus, LPVOID lpvStatusInformation, DWORD dwStatusInformationLength ) { switch( dwInternetStatus ) { case WINHTTP_CALLBACK_STATUS_SENDREQUEST_COMPLETE: // リクエストの送信完了 OutputDebugString( _T("InternetStatus = SENDREQUEST_COMPLETE\n") ); { // レスポンスの到着の待機 if( !WinHttpReceiveResponse( m_hRequest, NULL ) ) { RequestFailed( _T("WinHttpReceiveResponse()に失敗") ); return; } } break; case WINHTTP_CALLBACK_STATUS_HEADERS_AVAILABLE: // ヘッダーの取得可能 OutputDebugString( _T( "InternetStatus = HEADERS_AVAILABLE\n") ); { DWORD dwStatusCode = 0; DWORD dwStatusCodeSize = sizeof(DWORD); if( !WinHttpQueryHeaders( m_hRequest, WINHTTP_QUERY_STATUS_CODE | WINHTTP_QUERY_FLAG_NUMBER, // ステータスコードをDWORD型で取得する。 WINHTTP_HEADER_NAME_BY_INDEX, // ヘッダー名のポインタ &dwStatusCode, // バッファー &dwStatusCodeSize, // バッファーサイズ WINHTTP_NO_HEADER_INDEX)) // 最初に発生したヘッダーのみ取り出す { RequestFailed( _T("WinHttpQueryHeaders()に失敗") ); return; } if( HTTP_STATUS_OK != dwStatusCode ) { RequestFailed( _T("ステータスコードとしてOKが返ってこなかった") ); return; } // レスポンスデータデータ問い合わせ if( !WinHttpQueryDataAvailable( m_hRequest, NULL ) ) { RequestFailed( _T("WinHttpQueryDataAvailable()に失敗") ); return; } } break; case WINHTTP_CALLBACK_STATUS_DATA_AVAILABLE: // データの取得可能 OutputDebugString( _T( "InternetStatus = DATA_AVAILABLE\n") ); { DWORD dwSize = *((LPDWORD)lpvStatusInformation); if( 0 == dwSize ) { // 読み込み終了->コールバック終了 RequestSucceeded(); return; } // レスポンスデータ読み込み DWORD dwLength = dwSize + 1; char* pszBuffer = (char*)malloc( dwLength * sizeof(char) ); if( !WinHttpReadData( m_hRequest, pszBuffer, // バッファー dwSize, // 読み込むバイト数 NULL ) ) { free( pszBuffer ); RequestFailed( _T("WinHttpReadData()に失敗") ); return; } // バッファーは解放はせずに終了。 // WinHttpReadData()完了前に、コールバック関数がWINHTTP_CALLBACK_STATUS_READ_COMPLETEで呼ばれる。 // バッファーは、コールバック関数のWINHTTP_CALLBACK_STATUS_READ_COMPLETE時に処理する。 } break; case WINHTTP_CALLBACK_STATUS_READ_COMPLETE: OutputDebugString( _T( "InternetStatus = READ_COMPLETE\n") ); if( lpvStatusInformation && dwStatusInformationLength ) { char* pszBuffer = (char*)lpvStatusInformation; pszBuffer[dwStatusInformationLength] = '\0'; m_ssRead << pszBuffer; free( pszBuffer ); // レスポンスデータデータ問い合わせ if( !WinHttpQueryDataAvailable( m_hRequest, NULL ) ) { RequestFailed( _T("WinHttpQueryDataAvailable()に失敗") ); return; } } break; case WINHTTP_CALLBACK_STATUS_REDIRECT: OutputDebugString( _T( "InternetStatus = REDIRECT\n") ); break; case WINHTTP_CALLBACK_STATUS_REQUEST_ERROR: OutputDebugString( _T( "InternetStatus = REQUEST_ERROR\n") ); RequestFailed( _T("InternetStatus = REQUEST_ERROR") ); return; case WINHTTP_CALLBACK_STATUS_INTERMEDIATE_RESPONSE: OutputDebugString( _T( "InternetStatus = INTERMEDIATE_RESPONSE\n") ); break; default: OutputDebugString( _T( "Unknown InternetStatus \n") ); RequestFailed( _T("Unknown InternetStatus") ); return; } } （・・・省略・・・）

サンプルコードアプリケーション実行結果

ダウンロード

サンプルプロジェクト

関連ページ

HTTP通信のリクエスト送信とレスポンス確認（WinInet API使用）

HTTP通信のリクエスト送信とレスポンス確認（WinHTTP API使用）（同期通信）