狛ログ

HttpURLConnectionを使ったPOSTのやり方

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

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

URL url = new URL("[接続先のURLを設定してください。]");

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

URL url = [ステップ1:接続URLを決めるを参照してください];
HttpURLConnection urlConnection = null;
try {
    urlConnection = (HttpURLConnection) url.openConnection();
} catch (IOException e) {
    e.printStackTrace();
}

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

//接続タイムアウトを設定する。
urlConnection.setConnectTimeout(100000);
//レスポンスデータ読み取りタイムアウトを設定する。
urlConnection.setReadTimeout(100000);
//ヘッダーにUser-Agentを設定する。
urlConnection.setRequestProperty("User-Agent", "Android");
//ヘッダーにAccept-Languageを設定する。
urlConnection.setRequestProperty("Accept-Language", Locale.getDefault().toString());
//ヘッダーにContent-Typeを設定する
urlConnection.addRequestProperty("Content-Type", "application/x-www-form-urlencoded; charset=UTF-8");
//HTTPのメソッドをPOSTに設定する。
urlConnection.setRequestMethod("POST");
//リクエストのボディ送信を許可する
urlConnection.setDoOutput(true);
//レスポンスのボディ受信を許可する
urlConnection.setDoInput(true);

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

//ステップ4.コネクションを開く
urlConnection.connect();

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

//ステップ5:リクエストボディの書き出しを行う。
OutputStream outputStream = urlConnection.getOutputStream();
HashMap keyValues = new HashMap<>();
keyValues.put("key" , "value");
if (keyValues.size() > 0) {
    Uri.Builder builder = new Uri.Builder();
    //HashMapを[key=value]形式の文字列に変換する
    Set keys = keyValues.keySet();
    for (String key : keys) {
        //[key=value]形式の文字列に変換する。
        builder.appendQueryParameter(key , keyValues.get(key);
    }
    //[key=value&key=value…]形式の文字列に変換する。
    String join = builder.build().getEncodedQuery();
    PrintStream ps = new PrintStream(outputStream);
    ps.print(join);
    ps.close();
}
outputStream.close();

ステップ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();

サンプルコード

    public String execute(String argStrApiUrl, HashMap<String,string> formItems) {
        String ret = "";
        HttpURLConnection urlConnection = null;
        try {
            //ステップ1.接続URLを決める。
            URL url = new URL(argStrApiUrl);

            //ステップ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());
            //ヘッダーにContent-Typeを設定する
            urlConnection.addRequestProperty("Content-Type", "application/x-www-form-urlencoded; charset=UTF-8");
            //HTTPのメソッドをPOSTに設定する。
            urlConnection.setRequestMethod("POST");
            //リクエストのボディ送信を許可する
            urlConnection.setDoOutput(true);
            //レスポンスのボディ受信を許可する
            urlConnection.setDoInput(true);

            //ステップ4.コネクションを開く
            urlConnection.connect();
            //ステップ5:リクエストボディの書き出しを行う。
            OutputStream outputStream = urlConnection.getOutputStream();
            if (formItems.size() > 0) {
                Uri.Builder builder = new Uri.Builder();
                Set keys  = formItems.keySet();
                for (String key : keys) {
                    //[key=value&key=value…]形式の文字列に変換する。
                    builder.appendQueryParameter(key , formItems.get(key));
                }
                String join = builder.build().getEncodedQuery();
                PrintStream ps = new PrintStream(outputStream);
                ps.print(join);
                ps.close();
            }
            outputStream.close();

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

    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();
    }

今回のまとめ

• POSTメソッドではリクエストボディを使ったデータ送信を許可するために setDoOutput にtrueを渡すこと。
• application/x-www-form-urlencoded に適合した送信文字列を作成するときは Uri.Builder クラスを使用すること。
• テキストとファイルを同時に送信する Content-Type「multipart/form-data」とは異なるので注意すること。

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

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();
}

URL url = [ステップ1:接続URLを決めるを参照してください];
HttpURLConnection urlConnection = null;
try {
    urlConnection = (HttpURLConnection) url.openConnection();
} catch (IOException e) {
    e.printStackTrace();
}

• 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);

//ステップ4:コネクションを開く
urlConnection.connect();

//ステップ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:コネクションを閉じる。
urlConnection.disconnect();

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

• HTTPリクエストのリクエストデータ（ヘッダー）の設定方法の提供
• HTTPリクエストの実行
• 認証
• コネクションの管理

今回のまとめ

• ApacheHTTPClitent から URLConnectionへの乗り換えは必須です。
• URLConnection ではリクエストデータとレスポンスデータに対する操作は、自前で実装する必要があります。