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 を、指定します。

５．リクエストの送信

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

６．レスポンスの到着の待機

WinHttpReceiveResponse 関数を利用し、レスポンスの到着を待ちます。

７．ステータスコードの取得

WinHttpQueryHeaders 関数を利用し、ステータスコードを取得します。
ステータスコードの取得においては、InfoLevel引数として、WINHTTP_QUERY_STATUS_CODE | WINHTTP_QUERY_FLAG_NUMBER を指定します。

８．レスポンスデータ問い合わせ

WinHttpQueryDataAvailable 関数を利用し、レスポンスデータ問い合わせを行い、レスポンスデータのサイズを取得します。

９．レスポンスデータ読み込み

WinHttpReadData 関数を利用し、レスポンスデータを読み込みます。

サンプルコード

セッションオブジェクトの作成
（・・・省略・・・） // セッションオブジェクトの作成 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 CHttpSyncRequest::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( !WinHttpSendRequest( m_hRequest, wstrHeaders.c_str(), wstrHeaders.length(), (LPVOID)strOptional.c_str(), strOptional.length() * sizeof(char), strOptional.length() * sizeof(char), (DWORD_PTR)0) ) { RequestFailed( _T("リクエストの送信に失敗") ); return; } // レスポンスの到着の待機 if( !WinHttpReceiveResponse( m_hRequest, NULL ) ) { RequestFailed( _T("WinHttpReceiveResponse()に失敗") ); return; } // ステータスコードの取得 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("ステータスコードの取得に失敗") ); return; } if( HTTP_STATUS_OK != dwStatusCode ) { RequestFailed( _T("ステータスコードとしてOKが返ってこなかった") ); return; } // レスポンスデータ読み込み while( 1 ) { // レスポンスデータ問い合わせ DWORD dwSize = 0; if( !WinHttpQueryDataAvailable( m_hRequest, &dwSize ) ) { RequestFailed( _T("WinHttpQueryDataAvailable()に失敗") ); return; } 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; } pszBuffer[dwSize] = '\0'; m_ssRead << pszBuffer; free( pszBuffer ); } } （・・・省略・・・）

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

ダウンロード

サンプルプロジェクト

関連ページ

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

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