2016年7月27日水曜日

URLConnection(HttpURLConnection)と向き合おう~GETメソッドでデータを取得する~

オフィス狛 技術部です。

URLConnection(HttpURLConnection)と向き合うためには、まずGETメソッドから始めましょう。
「HTTPにおけるGETメソッドとは何か?」はGoogleさんにお任せします。

今回の目標

  • HttpURLConnection を使ってGETメソッドを行う。
  • HTTP通信を行う際にクエリ文字列を使ってデータを付加する。
  • GETメソッドのレスポンスデータを取得する。

HttpURLConnection の使い方

HttpURLConnection は GET/POSTに関係なくメソッドの呼び出し順序は大体決まっています。
順序は下記のとおりです。

  • ステップ1 : 接続URLを決める。
  • ステップ2 : URLへのコネクションを取得する。
  • ステップ3 : 接続設定(メソッドの決定,タイムアウト値,ヘッダー値等)を行う。
  • ステップ4 : コネクションを開く
  • ステップ5 : リクエストボディの書き込みを行う。(POSTのみ行う)
  • ステップ6 : レスポンスの読み出しを行う。
  • ステップ7 : コネクションを閉じる。

ステップ1~3の操作は設定を行います、ステップ4の操作で実際にコネクションを開き、ステップ5以降は「接続先にデータを送信する OutputStream 」と「接続先からデータを受信する InputStream 」を使いデータの送受信を行います。
早速、順番に見ていきましょう。

ステップ1:接続URLを決める。

接続先URLを決めるにはjava.net.URLを使います。
また、今回はGETメソッドということでURLにクエリ文字列を付加する必要があります。
サンプルでは HashMap<String,String> のkey:value をそのままクエリ文字列に変換するようにしています。

String urlString = "[接続先のURLに書き換えてください。]";
HashMap<String,string> queryParams = new HashMap<>();
queryParams.put("key", "value");
URL url;
try {
    if (queryParams == null) {
        url = new URL(urlString);
    } else {
        Uri.Builder builder = new Uri.Builder();
        Set keys = queryParams.keySet();
        for (String key : keys) {
            builder.appendQueryParameter(key, queryParams.get(key));
        }
        url = new URL(urlString + builder.toString());
    }
} catch (IOException e) {
    e.printStackTrace();
}

ポイントはクエリ文字列の作成にはUri.Builderを使うことです。
このクラスを使うことでクエリ文字列を作ることが簡単になります。

本来ならURLクラスを使わずUri.Builderだけを使ってスキームやドメイン、パス等を指定すべきなのですが目標に関係なくコードが複雑化してしまうため上記の方法をとりました。

ステップ2:URLへのコネクションを取得する。

接続URLのコネクションを取得することができます。
URL url = [ステップ1:接続URLを決めるを参照してください];
HttpURLConnection urlConnection = null;
try {
    urlConnection = (HttpURLConnection) url.openConnection();
} catch (IOException e) {
    e.printStackTrace();
}
URL#openConnection はコネクションを開き通信可能状態になりそうな名前ですが、実際は開いただけで接続されていないため通信はできません。

ステップ3:接続設定(メソッドの決定,タイムアウト値,ヘッダー値等)を行う。

接続先URLとのコネクションを取得したので、通信内容について設定を行っていきます。
下記の項目を設定することができます。
  • setConnectTimeout を使うことで接続タイムアウトを設定できます。
  • setReadTimeou を使うことでレスポンスデータ読み取りタイムアウトを設定できます。
  • setRequestProperty を使うことでヘッダーに値を設定できます。
  • setRequestMethod を使うことでGETやPOSTなどのHTTPリクエストメソッドを設定できます。
  • setDoOutput を使うことでコネクション上でリクエストボディ送信の許可/不許可を設定できます。
  • setDoInput を使うことでコネクション上でレスポンスデータ受信の許可/不許可を設定できます。

HttpURLConnection urlConnection = [ステップ2:URLへのコネクションを取得するを参照してください];
//ステップ3:接続設定(メソッドの決定,タイムアウト値,ヘッダー値等)を行う。
//接続タイムアウトを設定する。
urlConnection.setConnectTimeout(100000);
//レスポンスデータ読み取りタイムアウトを設定する。
urlConnection.setReadTimeout(100000);
//ヘッダーにUser-Agentを設定する。
urlConnection.addRequestProperty("User-Agent", "Android");
//ヘッダーにAccept-Languageを設定する。
urlConnection.addRequestProperty("Accept-Language", Locale.getDefault().toString());
//HTTPのメソッドをGETに設定する。
urlConnection.setRequestMethod("GET");
//リクエストのボディ送信を許可しない
urlConnection.setDoOutput(false);
//レスポンスのボディ受信を許可をする
urlConnection.setDoInput(true);

setRequestMethod、setDoOutput、setDoInput の設定値の関係性について特に注意が必要です。
・デフォルト値について
   setRequestMethod はGET、setDoOutput はfalse、setDoInput はtureが設定されている状態になっています。
・setRequestMethod と setDoOutput について
   setRequestMethodでGETを指定した状態で、このメソッドにtrueを渡すとGETをPOSTに書き換えてしまいます。
確かにGETメソッドでリクエストボディは使わないのでその通りですが、特にメッセージもなく通信が失敗します。
この3つのメソッドは必ず呼ぶようにして、各設定値が矛盾を起こさないようにしましょう。

ステップ4:コネクションを開く

コネクションを設定した内容で接続し、実際にデータの送受信ができる状態にします。
このメソッド以降は「接続先にデータを送信する OutputStream 」と「接続先からデータを受信する InputStream 」を使うことができるようになります。
//ステップ4:コネクションを開く
urlConnection.connect();

ステップ5:リクエストボディの書き込みを行う。

GETメソッドではリクエストボディを送信しません、そのため OutputStream を取得してはいけません。
取得しようとすると例外が発生します。

ステップ6:レスポンスボディの読み出しを行う。

主なレスポンスデータは下記のメソッドを使って取得します。
  • getResponseCode を使うことでHTTPステータスコードを取得できます。
  • getInputStream を使うことレスポンスボディのデータストリームを取得できます。

//ステップ6:レスポンスボディの読み出しを行う。
int statusCode = urlConnection.getResponseCode();

String responseData = "";
InputStream stream = urlConnection.getInputStream();
StringBuffer sb = new StringBuffer();
String line = "";
BufferedReader br = new BufferedReader(new InputStreamReader(stream, "UTF-8"));
while ((line = br.readLine()) != null) {
    sb.append(line);
}
try {
    stream.close();
} catch (Exception e) {
    e.printStackTrace();
}
responseData = sb.toString();

今回はレスポンスボディのデータストリームを文字列に変換しています。

ステップ7:コネクションを閉じる。

使ったコネクションはしっかりと閉じましょう。
//ステップ7:コネクションを閉じる。
urlConnection.disconnect();
上記の7ステップで URLConnection を使ったGETメソッドを実装することができます。

サンプルコード

今回のサンプルコードの仕様は下記のとおりです。

  • URLとクエリ文字列を引数で渡し、クエリ文字列付きのURLでGETメソッドを実行する。
  • レスポンスボディデータは文字列として扱う。
  • 非同期処理から呼び出されることを想定している。
  • 呼び出し側には文字列を返却する。

    /**
     * GETメソッドで文字列を取得する。
     *
     * @param urlString   アクセスするURL
     * @param queryParams クエリパラメーター
     * @return レスポンス
     */
    public String execute(String urlString, HashMap<String,string> queryParams) {
        HttpURLConnection urlConnection = null;
        int responseCode = 0;
        String responseData = "";
        try {
            //ステップ1:接続URLを決める。
            URL url;
            if (queryParams == null) {
                url = new URL(urlString);
            } else {
                //クエリ文字列を付加する。
                Uri.Builder builder = new Uri.Builder();
                Set keys = queryParams.keySet();
                for (String key : keys) {
                    builder.appendQueryParameter(key, queryParams.get(key));
                }
                url = new URL(urlString + builder.toString());
            }
            //ステップ2:URLへのコネクションを取得する。
            urlConnection = (HttpURLConnection) url.openConnection();

            //ステップ3:接続設定(メソッドの決定,タイムアウト値,ヘッダー値等)を行う。
            //接続タイムアウトを設定する。
            urlConnection.setConnectTimeout(100000);
            //レスポンスデータ読み取りタイムアウトを設定する。
            urlConnection.setReadTimeout(100000);
            //ヘッダーにUser-Agentを設定する。
            urlConnection.setRequestProperty("User-Agent", "Android");
            //ヘッダーにAccept-Languageを設定する。
            urlConnection.setRequestProperty("Accept-Language", Locale.getDefault().toString());
            //HTTPのメソッドをGETに設定する。
            urlConnection.setRequestMethod("GET");
            //リクエストのボディ送信を許可しない
            urlConnection.setDoOutput(false);
             //レスポンスのボディ受信を許可する
            urlConnection.setDoInput(true);
            //ステップ4:コネクションを開く
            urlConnection.connect();

            //ステップ6:レスポンスボディの読み出しを行う。
            responseCode = urlConnection.getResponseCode();
            responseData = convertToString(urlConnection.getInputStream());
        } catch (IOException e) {
            e.printStackTrace();
        } finally {
            if (urlConnection != null) {
                //ステップ7:コネクションを閉じる。
                urlConnection.disconnect();
            }
        }
        Log.d("execute", "URL:" + urlString);
        Log.d("execute", "HttpStatusCode:" + responseCode);
        Log.d("execute", "ResponseData:" + responseData);
        return responseData;
    }

    public String convertToString(InputStream stream) throws IOException {
        StringBuffer sb = new StringBuffer();
        String line = "";
        BufferedReader br = new BufferedReader(new InputStreamReader(stream, "UTF-8"));
        while ((line = br.readLine()) != null) {
            sb.append(line);
        }
        try {
            stream.close();
        } catch (Exception e) {
            e.printStackTrace();
        }
        return sb.toString();
    }

今回のまとめ

  • HttpURLConnection を使った場合、HTTPメソッドに関係なく7ステップを実装すること。
  • HTTPメソッドに合わせてsetDoOutputとsetDoInputを設定すること。

0 件のコメント:

コメントを投稿