OkHttpのAndroidのサンプルチュートリアル

2年 ago
芽依, 雨夜
4 minutes

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

OkHttp アンドロイド

最初、AndroidにはHTTPクライアントが2つしかなかった：HttpURLConnectionとApache HTTP Client。これらのクライアントは、Webからデータを送信および受信するためにAsyncTaskまたはバックグラウンドスレッドのメソッド内に大量のボイラープレートコードを記述する必要がありました。さらに、これらのクライアントはHTTPリクエストやコネクションプーリングのキャンセルに制限がありました。OkHttp for Androidは、余分な依存関係を使用せずに、ネイティブなJava Socketを直接使用してHttpURLConnectionおよびApache Clientのインタフェースの実装を提供します。

オーケーティプアンドロイドの利点

OkHttpがもたらすいくつかの利点は次のとおりです:

    1. コネクションプーリング

 

    1. GZIP圧縮

 

    1. キャッシュ

 

    1. ネットワーク問題からの回復

 

    1. リダイレクト

 

    1. 再試行

 

    同期および非同期コールのサポート

同期呼び出し vs 非同期呼び出し

  • Synchronous calls require an AsyncTask wrapper around it. That means it doesn’t support cancelling a request. Also, AsyncTasks generally leak the Activity’s context, which is not preferred.
  • Asynchronous Calling is the recommneded way since it supports native cancelling, tagging multiple requests and canceling them all with a single method call (by invoking the cancel on the Acitivty instance inside the onPause or onDestroy method).

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.scdev.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.scdev.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形式で、画面に表示されます。他のオープンソースAPI（例：GitHub API、Stack Overflowなど）も試すことができます。

OkHttpのクエリパラメータの例

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

HttpUrl.Builder urlBuilder = HttpUrl.parse("https://httpbin.org/get).newBuilder();
urlBuilder.addQueryParameter("website", "www.scdev.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アンドロイドのPOSTの例

これまで、いくつかの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サンプルプロジェクトをダウンロードしてください。

コメントを残す 0

Your email address will not be published. Required fields are marked *