Jakarta Commonsによるネットワークプログラミング

6. HTTP
次は，HTTPのクライアントです． HTTPは，ご存知の通りWeb上でHTML等の送受信に広く使われているプロトコルです．現在では，単純なファイルや画像のやり取りだけではなく，Webサービスなどの高度なサービスもHTTP上に実装されています．
HTTPの大きな特徴は，プロトコルの単純さです．その単純さを実現している大きな要素の1つが，ステートレスという点です．HTTPでは，基本的にデータの送受信は1回ごとに独立して実行されます．
しかし，ステートレスなHTTPプロトコルを使用しながら，セッション情報などの状態を維持する仕組みが実際には用意されています．Cookieは，一度設定されるとその設定された範囲内でのアクセスに対し，異なるリクエストであっても同一情報を維持したまま通信が行われます．認証情報なども同様です．この仕組みにより，ステートレスなHTTPプロトコル上でアプリケーションは状態管理を行うことが可能となっています．

6.1 HttpClient概要
ご存知の通り，Javaの標準ライブラリにもHTTPクライアントのライブラリが，java.netパッケージにあります．しかし，java.netパッケージにおけるHTTP の機能（HttpURLConnectionクラス等）は，低レベルなネットワーク処理は隠蔽されており，アプリケーションから細かな制御を行うことができず，また Cookieや認証処理等に必要な高レベルな機能も提供されていません．このためjava.netパッケージでは，高度なHTTPクライアントを実装するのは困難となっています．
HttpClientでは，Cookieや認証に関する処理がクラスライブラリとして提供されており，またタイムアウト設定注1などネットワークレベルの処理も可能で，高機能なHTTPクライアントの実装に欠かせないさまざまな機能が提供されています．HttpClientは，クライアント機能の実装にjava.net.HttpURLConnection等は使用せず，Socketレベルから独自にPureJavaで実装されています．また，本稿では使用しませんが， Java標準ライブラリのHttpURLConnectionクラスを容易にHttpClientに置き換えられるようにするためのラッパークラスも提供されています．
以下にHttpClientの特徴を示します．

6.2 HTTP サンプルプログラムの動作
本サンプルは，特定メンバー向けに用意されたWeb ページ（トップページと，インフォメーションページの2ページ）にアクセスする例です．このサイトのメンバー向けページは，フォーム認証を通過しないと取得できない構造となっています．
ブラウザからこの処理を実行する場合には，次のような流れとなります（図4）．

図4 ページ構成

(1) ユーザは，トップページのURLにアクセスする
(2) ブラウザ上には，認証ページが表示される
(3) 認証ページ上にユーザID とパスワードを入力して送信する
(4) ブラウザ上にトップページが表示される（この段階で，認証のためのセッション情報が，Cookieとしてブラウザに設定されます）
(5) ユーザが同サイト内のインフォメーションページにアクセスする（上記fで設定されたCookieを維持したままリクエストが送信されます）
(6)インフォメーションページがブラウザ上に表示される

一方，Javaによるサンプルプログラムの場合，次の流れになります（リスト3）．

(1) ユーザID，パスワードを設定し，トップページの URLにアクセスする
(2)サーバからトップページを取得する（この段階で，認証のためのCookieを取得します）
(3)クライアントはサーバにインフォメーションページを要求する（上記sで設定されたCookieを維持したままリクエストを送信します）
(4) インフォメーションページを取得する

プログラムでは，認証とトップページの取得が1回のリクエストで処理されるため，ブラウザを使用する場合と比べて，送受信の回数が1回減っている点に注意してください（ログインページは取得しません）．

6.3 プログラムの説明
ここでは，HTTPプロトコルの詳細については説明しません．HTTPプロトコル上の基本認証やCookie の仕組みが理解できている前提で記述しています． HTTPプロトコルの仕組みは，インターネットでも多くの情報を得ることができますので，理解されていない方は調べてみてください．

リスト3

 1  import org.apache.commons.httpclient.*;
 2  import org.apache.commons.httpclient.cookie.*;
 3  import org.apache.commons.httpclient.methods.*;
 4  
 5  public class HTTPSample {
 6  
 7      public static void main(String[] arg) throws Exception {
 8  
 9          String server = "localhost";
10          int port = 80;
11  
12          // クライアントの生成
13          HttpClient client = new HttpClient();                           ←(1)
14          client.getHostConfiguration().setHost(server, port, "http");    ←(1)
15          client.getState().setCookiePolicy(CookiePolicy.COMPATIBILITY);  ←(1)
16  
17          // 認証ページを通過し、トップページにアクセス
18          PostMethod top = new PostMethod( "/club/member/top.html" );     ←(2)
19          NameValuePair[] parameters = new NameValuePair[2];              ←(2)
20          parameters[0] = new NameValuePair("username", "user");          ←(2)
21          parameters[1] = new NameValuePair("password", "password");      ←(2)
22          top.setRequestBody( parameters );                               ←(2)
23  
24          client.executeMethod(top);                                      ←(3)
25          // 取得したクッキーを表示
26          Cookie[] cookies = client.getState().getCookies(server, port,   ←(3)
27              "/club", false );                                           ←(3)
28          for (int i=0; i<cookies.length; i++) {                          ←(3)
29              System.out.println(cookies[i].toString());                  ←(3)
30          }                                                               ←(3)
31          System.out.println( top.getResponseBodyAsString() );            ←(3)
32          top.releaseConnection();                                        ←(3)
33  
34          // infoページにアクセス
35          GetMethod info = new GetMethod( "/club/member/info.html" );     ←(4)
36          int status = client.executeMethod(info);                        ←(4)
37          String body = info.getResponseBodyAsString();                   ←(4)
38          System.out.println( "status: " + status + "\n");                ←(4)
39          System.out.println( body );                                     ←(4)
40          info.releaseConnection();                                       ←(4)
41      }
42  }

リスト3について以下に解説します（(1)がリスト3-(1) の部分に対応．以下同様）．

(1) HttpClientのオブジェクト生成 HttpClientオブジェクトを生成します．HttpClient は，HTTPメソッドの実行などクライアント実装の中心的な役割を果たすクラスです．
生成したクライアントに対して，サーバの情報（サーバ名，ポート，プロトコル）を設定します．続いてリスト3 - 15行目で，Cookieの処理方式を指示しています．ここで，実行しているclient.getState()で取得できるオブジェクトは，HttpStateクラスのオブジェクトです．HttpStateは，リクエスト間でも維持される Cookieや認証情報を保持するクラスです．サンプルプログラムではこれ以降出てきませんが，本サンプルでも認証のためのCookie情報を維持／送信するために裏で働いています．

(2) 認証情報の設定
サーバに送信するMethodを生成します．ここでは PostMethodを生成しています．引数は，トップページのURL を示す文字列です．HttpClient では， PostMethod以外にもGetMethodやHeadMethodなどが利用できます．次に，NameValuePairクラスを使用して，認証に使用するパラメータ（ユーザIDとパスワード）を作成し，リスト3 - 22行目で，メソッドに設定しています．

(3) リクエストの送受信
リクエストの送信には，HttpClientオブジェクトの executeMethod()を使用します．引数には，上記(2) で作成したPostMethodのオブジェクトを指定しています．この後，サンプルプログラムでは，この処理で設定されたCookieとレスポンスを出力しています．ここで表示されるCookieが，認証を維持するために使われているCookieです．使用し終わったメソッドは， releaseConnection()で後始末します．

(4) 次リクエストの送信
インフォメーションページも，認証領域の中のページであり，認証情報を維持していないと，ページを取得することはできません．上記eで取得したCookie を使用して，次のインフォメーションページを取得します．インフォメーションページは，GetMethodで取得しています．ご覧の通り，特別な処理は行っていませんが，認証を維持するためのCookieがサーバに送信され，インフォメーションページが取得されます．

　<< prev　　↑index　　next >>

このドキュメントに関するご意見、ご要望などはまで。