Пример руководства по использованию OkHttp в Android

Учебники
Android

OkHttp – это сторонняя библиотека, представленная компанией Square в 2013 году для отправки и приема сетевых запросов на основе HTTP.

OkHttp Android

Изначально в Android было только два HTTP-клиента: HttpURLConnection и Apache HTTP Client; для отправки и получения данных из сети требовалось написание большого объема стандартного кода внутри AsyncTask или методов фонового потока. Кроме того, у этих клиентов есть свои ограничения, когда речь идет о отмене HTTP-запроса или использовании пула соединений. OkHttp Android предоставляет реализацию интерфейсов HttpURLConnection и Apache Client, работая напрямую поверх java Socket без использования дополнительных зависимостей.

Преимущества OkHttp Android

Некоторые преимущества, которые предоставляет OkHttp, включают:

  1. Пул соединений
  2. Сжатие Gzip
  3. Кэширование
  4. Восстановление после проблем с сетью
  5. Перенаправления
  6. Повторные
  7. поддержка для синхронных и асинхронных вызовов

Синхронные vs Асинхронные вызовы

  • Синхронные вызовы требуют обертки AsyncTask вокруг них. Это означает, что они не поддерживают отмену запроса. Кроме того, AsyncTask’ы обычно утечки контекста Activity, что не желательно.
  • Асинхронный вызов – это рекомендуемый способ, поскольку он поддерживает отмену по умолчанию, помечает несколько запросов и отменяет их все одним методом (вызывая cancel у экземпляра Acitivty внутри метода 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, который выводится на экран. Вы можете попробовать другие открытые API, такие как API Github, Stackoverflow и т. д.

Пример параметров запроса 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();

Ссылка выше была получена с 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();
                        }
                    }
                });

            }
        });

Пример POST-запроса в Android с использованием OkHttp

До сих пор мы рассматривали получение ответа, вызывая несколько 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());
            }
        });
    }
}

В приведенном выше коде мы использовали класс MediaType, который является частью OkHttp, чтобы определить тип передаваемых данных. Мы использовали тестовый URL API с https://reqres.in/. Метод post(RequestBody body) вызывается на объекте RequestBuilder с соответствующим значением. В логе отображается следующий ответ. {"name":"morpheus","job":"leader","id":"731","createdAt":"2017-01-03T17:26:05.158Z"}. OkHttp – рекомендуемый HttpClient, используемый внутри библиотеки Retrofit Networking. Мы рассмотрим это в следующем уроке. Мы добавили три кнопки в макет для вызова каждого из методов postRequest(), run() и класса оболочки AsyncTask. Вы можете загрузить финальный проект Android OkHttp по ссылке ниже.

Скачать пример проекта Android с использованием OkHttp

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