OkHttp Androidの例チュートリアル

Android

OkHttpは、2013年にSquareによって導入されたサードパーティーライブラリであり、HTTPベースのネットワークリクエストの送信と受信に使用されます。

OkHttp Android

当初、AndroidにはHttpURLConnectionとApache HTTP Clientの2つのHTTPクライアントしかありませんでした。Webからデータを送受信するためには、これらのクライアントのそれぞれにAsyncTaskまたはバックグラウンドスレッドメソッド内に多くのボイラープレートコードを記述する必要がありました。さらに、これらのクライアントはHTTPリクエストのキャンセルや接続プーリングに関してそれぞれ独自の制限を持っていました。 OkHttp androidは、余分な依存関係を使用せずにJavaソケットの上に直接動作することで、HttpURLConnectionおよびApache Clientインターフェースの実装を提供します。

OkHttp Androidの利点

OkHttpがもたらすいくつかの利点には、次のようなものがあります：

コネクションプーリング
Gziping
キャッシュ
ネットワークの問題からの回復
リダイレクト
リトライ
同期および非同期呼び出しのサポート

同期 vs 非同期呼び出し

同期呼び出しには、それを囲むAsyncTaskラッパーが必要です。つまり、リクエストのキャンセルをサポートしていません。また、AsyncTasksは一般的にアクティビティのコンテキストをリークしますが、これは好ましくありません。
非同期呼び出しは、ネイティブのキャンセル、複数のリクエストへのタグ付け、およびそれらをすべて単一のメソッド呼び出しでキャンセルすることをサポートするため、推奨される方法です（onPauseまたはonDestroyメソッド内のアクティビティインスタンスでキャンセルを呼び出す）。

OkHttp androidの実装を見る前に、次の依存関係を追加してください

compile 'com.squareup.okhttp3:okhttps:3.4.1'

AndroidManifest.xmlファイル内でインターネットの許可を追加してください。

<uses-permission android:name="android.permission.INTERNET"/>

OkHttp Androidの例

同期呼び出しのためのMainActivity.javaは以下の通りです。

package com.journaldev.okhttp;

import android.os.AsyncTask;
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.util.Log;
import android.view.View;
import android.widget.Button;
import android.widget.TextView;

import org.json.JSONException;
import org.json.JSONObject;

import java.io.IOException;

import okhttp3.Call;
import okhttp3.Callback;
import okhttp3.MediaType;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.RequestBody;
import okhttp3.Response;

public class MainActivity extends AppCompatActivity {

    OkHttpClient client = new OkHttpClient();

    TextView txtString;

    public String url= "https://reqres.in/api/users/2";


    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        txtString= (TextView)findViewById(R.id.txtString);

        OkHttpHandler okHttpHandler= new OkHttpHandler();
        okHttpHandler.execute(url);
    }

    public class OkHttpHandler extends AsyncTask {

        OkHttpClient client = new OkHttpClient();

        @Override
        protected String doInBackground(String...params) {

            Request.Builder builder = new Request.Builder();
            builder.url(params[0]);
            Request request = builder.build();

            try {
                Response response = client.newCall(request).execute();
                return response.body().string();
            }catch (Exception e){
                e.printStackTrace();
            }
            return null;
        }

        @Override
        protected void onPostExecute(String s) {
            super.onPostExecute(s);
            txtString.setText(s);
        }
    }

}

非同期呼び出しの場合、MainActivity.javaは次のように定義されるべきです：

package com.journaldev.okhttp;

import android.os.AsyncTask;
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.util.Log;
import android.view.View;
import android.widget.Button;
import android.widget.TextView;

import org.json.JSONException;
import org.json.JSONObject;

import java.io.IOException;

import okhttp3.Call;
import okhttp3.Callback;
import okhttp3.MediaType;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.RequestBody;
import okhttp3.Response;

public class MainActivity extends AppCompatActivity {
    
    TextView txtString;
    public String url= "https://reqres.in/api/users/2";

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        txtString= (TextView)findViewById(R.id.txtString);

        try {
            run();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    void run() throws IOException {

        OkHttpClient client = new OkHttpClient();

        Request request = new Request.Builder()
                .url(url)
                .build();

        client.newCall(request).enqueue(new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {
                call.cancel();
            }

            @Override
            public void onResponse(Call call, Response response) throws IOException {

                final String myResponse = response.body().string();

                MainActivity.this.runOnUiThread(new Runnable() {
                    @Override
                    public void run() {
                        txtString.setText(myResponse);
                    }
                });

            }
        });
    }

}

使用したテストAPIはこちらからです。返される応答文字列はJSON形式で、画面に表示されます。他にもGithub API、StackoverflowなどのオープンソースAPIを試すことができます。

OkHttp クエリパラメータの例

クエリパラメータがあれば、HttpUrl.Builderクラスを使用して簡単に渡すことができます。

HttpUrl.Builder urlBuilder = HttpUrl.parse("https://httpbin.org/get).newBuilder();
urlBuilder.addQueryParameter("website", "www.journaldev.com");
urlBuilder.addQueryParameter("tutorials", "android");
String url = urlBuilder.build().toString();

Request request = new Request.Builder()
                     .url(url)
                     .build();

上記のURLはhttps://resttesttest.com/から取得しました。

OkHttp Android ヘッダーの例

認証されたクエリパラメータがあれば、以下のようにヘッダーとして追加できます：

Request request = new Request.Builder()
    .header("Authorization", "replace this text with your token")
    .url("your api url")
    .build();

JSONレスポンスの処理

JSONデータを解析して関連するパラメータを取得し、以下のコードのようにTextViewに表示することができます。

client.newCall(request).enqueue(new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {
                call.cancel();
            }

            @Override
            public void onResponse(Call call, Response response) throws IOException {

                final String myResponse = response.body().string();

                MainActivity.this.runOnUiThread(new Runnable() {
                    @Override
                    public void run() {
                        try {

                            JSONObject json = new JSONObject(myResponse);
                            txtString.setText(json.getJSONObject("data").getString("first_name")+ " "+json.getJSONObject("data").getString("last_name"));
                        } catch (JSONException e) {
                            e.printStackTrace();
                        }
                    }
                });

            }
        });

OkHttp Android POST Example

これまでに、いくつかのAPIを呼び出してレスポンスを取得する方法を見てきました。サーバにデータを投稿するには、以下の方法でリクエストを構築する必要があります。

public class MainActivity extends AppCompatActivity {

    public String postUrl= "https://reqres.in/api/users/";
    public String postBody="{\n" +
            "    \"name\": \"morpheus\",\n" +
            "    \"job\": \"leader\"\n" +
            "}";

    public static final MediaType JSON = MediaType.parse("application/json; charset=utf-8");

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        try {
            postRequest(postUrl,postBody);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    void postRequest(String postUrl,String postBody) throws IOException {

        OkHttpClient client = new OkHttpClient();

        RequestBody body = RequestBody.create(JSON, postBody);

        Request request = new Request.Builder()
                .url(postUrl)
                .post(body)
                .build();

        client.newCall(request).enqueue(new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {
                call.cancel();
            }

            @Override
            public void onResponse(Call call, Response response) throws IOException {
                Log.d("TAG",response.body().string());
            }
        });
    }
}

上記のコードでは、OkHttpの一部であるMediaTypeクラスを使用して渡されるデータのタイプを定義しています。https://reqres.in/からテストAPI URLを使用しました。関連する値でRequestBuilderのpost(RequestBody body)メソッドが呼び出されます。ログには次の応答が表示されます。{"name":"morpheus","job":"leader","id":"731","createdAt":"2017-01-03T17:26:05.158Z"}。OkHttpは、Retrofitネットワーキングライブラリ内で使用される推奨されるHttpClientです。次のチュートリアルでこれを詳しく見ていきます。レイアウトには各メソッド、postRequest()、run()、およびAsyncTaskラッパークラスを呼び出すための3つのボタンが追加されています。最終的なAndroid OkHttpプロジェクトは、以下のリンクからダウンロードできます。

OkHttp Androidのサンプルプロジェクトをダウンロード

Source:
https://www.digitalocean.com/community/tutorials/okhttp-android-example-tutorial